Developer

API Reference

IForm_PopSelf()

Brew Release
Brew MP 1.0.2
See Also
IForm IRootForm_PopForm() IRootForm_RemoveForm() IRootForm_RemoveFormIfTop()
Description
This function allows a form to remove itself from the top of the root form's form stack -- a task that normally is the responsibility of the root form itself. The form will be removed from the form stack only if it is currently the topmost form on the stack, otherwise, the function returns without affecting the form stack at all.
Parameters
  • piForm
    []:
    [in] Pointer to the form to be popped off of the form stack -- but only if that form is also the form at the top of the stack.
Interface
Prototype
   void IForm_PopSelf(IForm *piForm);
Return
None
Side Effect
None
Comment
An application may call IForm_PopSelf(), rather than IRootForm_RemoveForm() IRootForm_PopForm(), or IRootForm_RemoveFormIfTop() -- all of which require a pointer to the root form that manages the form stack that includes the form to be removed.
  • Follow