Developer

API Reference

IRootForm_RemoveFormIfTop()

Brew Release
Brew MP 1.0.2
See Also
IRootForm IForm IRootForm_RemoveForm()
Description
This function will remove a specified form from the form stack, if that form is currently at the top of the stack.
Parameters
  • pif
    []:
    [in] Pointer to an IRootForm interface object.
  • piForm
    []:
    [in] Pointer to the form to be removed from the form stack -- but only if that form is also the form at the top of the stack.
Interface
Prototype
   boolean IRootForm_RemoveFormIfTop(IRootForm *pif, IForm *piForm)
Return
   
   TRUE  --  The specified form was at the top of the form stack and was successfully removed
             from the stack.
   FALSE --  The specified form was not removed from the form stack.

Side Effect
None
Comment
None
  • Follow