Developer

API Reference

IRootForm_GetTopForm()

Brew Release
Brew MP 1.0.2
Description
This function retrieves a pointer to the form at the top of the root form's form stack. Generally, this is a pointer to the form that is currently frontmost on the display. Retrieving a pointer to the topmost form on the form stack does not alter the current structure of the stack.
Parameters
  • pif
    []:
    [in] Pointer to an IRootForm interface object.
Interface
Prototype
   IForm *IRootForm_GetTopForm(IRootForm *pif)
Return
A pointer to the form that is at the top of the form stack, or NULL when there is no form to be returned.
Side Effect
None
Comment
Though IRootForm_GetTopForm() function returns a pointer to a form, the function does not add a reference to the returned IForm for the caller.
  • Follow