Developer

API Reference

IWidget_GetPropertyEx()

Brew Release
Brew MP 1.0.2
See Also
Widget Events IWidget_GetProperty IWidget_SetProperty IWidget_SetPropertyEx
Description
This routine retrieves a specific extended property value for the given widget. 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 retrieved from the widget.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object
  • nPropId
    []:
    [in] The property to retrieve
  • nSize
    []:
    [in] The size of the property in bytes
  • pUser
    []:
    [out] Pointer supplied by the user to pass back the data in
Interface
Prototype
   int IWidget_GetPropertyEx(IWidget *pif, AEECLSID nPropId, int nSize, void *pUser);
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 'pUser'.
Side Effect
None
Comment
Calling IWidget_GetProperty has the same effect as processing an EVT_WDG_GETPROPERTY event.
  • Follow