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

Developer

API Reference

IFORM_SETPTR()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function will set the value of a pointer-based form property -- i.e. those properties that contain a pointer as its value, such as the background image or title text.
Params
pif
[]:
[in] Pointer to the IForm interface object.
fid
[]:
[in] Identifies the form property to be set.
ptr
[]:
[in] Pointer to the data that will be referenced by the 'fid' property.
Interface
Prototype
  •    int IForm_SetPtr(IForm *pif, uint16 fid, void *ptr); 
    
Return
  • AEE_SUCCESS : If the form is able to set the specified form property. AEE_EFAILED : If the specified form property could not be set.
Side Effect
  • Calling IForm_SetPtr() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the 'fid' property be set.
Comments
Only the following form properties may be set using IForm_SetPtr(): FID_BACKGROUND FID_TITLE FID_TITLEIMAGE FID_SOFTKEY1 FID_SOFTKEY2 Attempting to set properties not listed above will yield unexpected results.