API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IFORM_GETROOTFORM()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the root form that manages a form. The root form controls the stacking order for a collection of forms.
Params
pif
[]:
[in] Pointer to the IForm interface object.
ppif
[]:
[out] Pointer to an IRootForm pointer, into which the function will return a pointer to the root form.
Interface
Prototype
  •    int IForm_GetRootForm(IForm *pif, IRootForm **ppif);
    
Return
  • AEE_SUCCESS : If the form is able to successfully retrieve the root form. AEE_EFAILED : If the root form could not be retrieved.
    A pointer to the root form is returned in 'ppif'.
Side Effect
  • Calling IForm_GetRootForm() effectively queries the form to retrieve the FID_ROOT property.
Comments
Calling IForm_GetRootForm() on the root form will yield undefined results and return AEE_EFAILED to the requesting client. 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.