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

Developer

API Reference

IFORM_GETSHELL()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a reference to the to the IShell object used by a form.
Params
pif
[]:
Pointer to the IForm interface object.
ppif
[]:
Pointer to an IShell pointer, into which the function will return a pointer to the shell.
Interface
  • IFORM
Prototype
  •    int IFORM_GetShell(IForm *pif, IShell **ppif)
    
Return
  • AEE_SUCCESS : If the form is able to successfully retrieve a reference to the shell. AEE_EFAILED : If the shell reference could not be retrieved.
    A pointer to the shell used by the form is returned in 'ppif'.
Side Effect
  • Calling IFORM_GetShell() effectively queries the form to retrieve the FID_SHELL property.
Comments
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.