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

Developer

API Reference

IFORM_GETTEXTPTR()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the text stored in a form property. For example, an application could retrieve the text of the form title by calling IForm_GetTextPtr() and specifying FID_TITLE as the property to be retrieved.
Params
pif
[]:
[in] Pointer to the IForm interface object.
fid
[]:
[in] Identifies the form property that contains the text to be retrieved.
ppif
[]:
[out] Pointer to an AECHAR pointer, into which the function will return a pointer to the property text.
Interface
Prototype
  •    int IForm_GetTextPtr(IForm *pif, uint16 fid, AECHAR **ppif); 
    
Return
  • AEE_SUCCESS : If the form is able to successfully retrieve the specified form property. AEE_EFAILED : If the specified form property could not be retrieved.
Side Effect
  • Calling IForm_GetTextPtr() effectively queries the form to retrieve the 'fid' 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.