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

Developer

API Reference

IROOTCONTAINER_REMOVE()

Brew Release
Brew MP 1.0.2
See Also
- IRootContainer Interface - IWidget Interface - IRootContainer_Insert()
Description
This function allows an application to remove a widget from the root container's widget stack. The widget to be removed may be specified explicitly by its widget pointer, or implicitly by a constant that identifies the widget's relative position within the container's widget stack.
Params
pif
[]:
A pointer to an IRootContainer object.
pw
[]:
Identifies the widget that should be removed from the root container's widget stack. This widget may be expressed explicitly as a widget pointer, or implicitly as a constant that identifies a relative position within the widget stack, as
Interface
Prototype
  •    int IRootContainer_Remove(IRootContainer *pif, IWidget *pw);
    
Return
  •    
       AEE_SUCCESS   --  The widget was successfully removed from the root container's widget stack.
       AEE_EBADPARM  --  The widget pointer passed in 'pw' either does not exist, or refers to a
                     widget that is not in the root container's widget stack.
    

Side Effect
  • None
Comments
None