Developer

API Reference

IRootForm_PushForm()

Brew Release
Brew MP 1.0.2
See Also
IRootForm IRootForm_PopForm()
Description
This function pushes a form onto the top of the form stack, making that form the topmost form and -- therefore -- the form that will appear on the display. Pushing a form onto the stack will deactivate the form that is currently frontmost on the display (e.g. the form that was previously at the top of the stack) and will make the new form the active form.
Parameters
  • pif
    []:
    [in] A pointer to an IRootForm object.
  • f
    []:
    [in] Pointer to the form to be pushed onto the form stack.

Interface
Prototype
   int IRootForm_PushForm(IRootForm *pif, IForm *f);
Return
   
   AEE_SUCCESS    --  The form was successfully pushed onto the form stack.
   AEE_ENOMEMORY  --  The form stack could not grow to accommodate a new form.

Side Effect
The theme used by the root form will automatically be applied to the form being pushed onto the stack.
Comment
A form should not be pushed if it already exists in the form stack.
  • Follow