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

Developer

API Reference

IWIDGET_SETUSERDATA()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_GetUserData Widget Events
Description
This function is used to set widget user data that are stored as integer value.
Params
pif
[]:
[in] Pointer to the IWidget interface object.
nUserData
[]:
[in] User data associated with a widget. For example, from application, an element ID can be associated against each widget using this user data. This Element ID is stored as int.
Interface
Prototype
  •    int IWidget_SetUserData(IWidget* pif, int nUserData);
    
Return
  • AEE_SUCCESS : The function was able to successfully set user data of Widget. AEE_EFAILED : If the user data could not be set.
Side Effect
  • None
Comments
If application wants to store struct as user data, address of struct will be stored as integer in user data of widget and IWidget_GetUserData() would pass back the address. Application has to cast/dereference the pointer to use it as struct.