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

Developer

API Reference

IWIDGET_GETPROPBOOL()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_GetProperty Widget Events
Description
This function is used to retrieve widget properties that are stored as boolean values, copying the value into the 'pbVal' pointer passed to the function as a parameter. The function will return AEE_SUCCESS or AEE_EFAILED depending on whether or not the widget was able to retrieve the requested property.
Params
pif
[]:
[in] Pointer to the IWidget interface object.
wProp
[]:
[in] Identifies the property to be retrieved.
pbVal
[]:
[out] A pointer to a boolean into which the widget will copy the value of the requested property.
Interface
Prototype
  •    int IWidget_GetPropBool(IWidget *pif, uint16 wProp, boolean *pbVal); 
    
Return
  • AEE_SUCCESS : If the widget is able to retrieve the requested property. AEE_EFAILED : If the property could not be retrieved.
    The value of the requested boolean property is returned in 'pbVal'.
Side Effect
  • None
Comments
Widgets may possess any number of properties, as defined in AEEWidgetProperties.h, and include attributes such as color, border width, shadowing, etc. PROP_SELECTED is an example of a widget property expressed as a boolean value.