Developer

API Reference

IForm_GetFormModel()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the model interface used by the form.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • ppif
    []:
    [out] Pointer to an IModel pointer, into which the function will return a pointer to the model interface attached to the form.
Interface
Prototype
   int IForm_GetFormModel(IForm *pif, IModel **ppif);
Return
AEE_SUCCESS : If the form is able to successfully retrieve a reference to the model interface. AEE_EFAILED : If the form's model interface could not be retrieved.
Side Effect
None
Comment
The pointer passed in the 'ppif' parameter is a double-indirection -- i.e. it is a pointer to a pointer. Applications should use care in ensuring that the proper level of indirection is used in calling the function.
  • Follow