Developer

API Reference

IRootForm_RemoveForm()

Brew Release
Brew MP 1.0.2
See Also
IRootForm IForm IRootForm_PopForm() IRootForm_PushForm() IRootForm_InsertForm()
Description
This function allows an application to remove a form at a specific position within the root form's form stack. Most applications can sufficiently manage the layering of forms by using the more convenient IRootForm_PopForm() and IRootForm_PushForm() functions, to place and remove forms from the form stack. Applications that wish to exercise greater control over the ordering of forms on the form stack can used IRootForm_RemoveForm() to remove a form from any position within the form stack. For example, an application that queues up several transient forms may choose to remove them based on the passage of time, regardless of whether or not that form is at the top of the form stack.
When removing a form, the root form will be updated if the removed form had previously been visible -- i.e. the form was at the top of the stack or was the topmost visible form.
Parameters
  • pif
    []:
    [in] A pointer to an IRootForm object.
  • f
    []:
    [in] Pointer to the form to be removed from the form stack. The form to be removed may be passed as a constant that identifies a relative position within the form stack, as follows. FORM_DEFAULT - Remove the default form, which BREW interprets to be the form at the top of the form stack. FORM_LAST - Remove the last form on the form stack -- i.e. the form at the top of the form stack. FORM_FIRST - Remove the first form on the form stack -- i.e. the form at the bottom of the form stack. FORM_ALL - Remove all of the forms on the form stack.

Interface
Prototype
   int IRootForm_RemoveForm(IRootForm *pif, IForm *f);
Return
   
   AEE_SUCCESS   --  The form was successfully removed from the form stack.
   AEE_EBADPARM  --  The form pointer passed in 'f' either does not exist, or refers to a form
                     that is not in the root form's form stack.

Side Effect
None
Comment
None
  • Follow