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

Developer

API Reference

IWIDGET_CURSORDISMISS()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_CursorShow()
Description
This function removes a cursor widget from its parent container, and removes and releases the container from the object list.
Params
pif
[]:
[in] Pointer to the IWidget interface object.
Interface
Prototype
  •    int IWidget_CursorDismiss(IWidget *pif); 
    
Return
  •    SUCCESS  - If BREW was able to successfully remove the cursor.
       EFAILED  - If the cursor could not be removed.
    
Side Effect
  • None
Comments
A failure generally indicates that the cursor widget had never been inserted into a valid container, or the attempt to remove the container failed. Note, however, that while the attempt to "remove" the container might fail, BREW will still proceed to release the container.