Developer

API Reference

IWidget_GetProperty()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_SetProperty Widget Events
Description
This function retrieves a specific property value for the given widget. Widgets may possess any number of properties, as defined in AEEWidgetProperties.h, and include attributes such as color, border width, shadowing, etc. The property value is returned in a pointer passed into the function, with the function returning AEE_SUCCESS or AEE_EFAILED depending on whether or not the requested property was able to be retrieved from the widget.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • propId
    []:
    [in] Identifies the property to be retrieved.
  • pVal
    []:
    [out] A pointer to a 32-bit unsigned integer into which the widget will copy the value of the requested property.
Interface
Prototype
   int IWidget_GetProperty(IWidget *pif, uint16 propId, uint32 *pVal); 
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 property is returned in 'pVal'.
Side Effect
None
Comment
Calling IWidget_GetProperty() has the same effect as processing an EVT_WDG_GETPROPERTY event.
  • Follow