Developer

API Reference

IForm_GetTitleWidget()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the form's title widget.
Parameters
  • p
    []:
    [in] Pointer to the IForm interface object.
  • w
    []:
    [out] Pointer to an IWidget pointer, into which the function will return a pointer to the form's title widget.
Interface
Prototype
   int IForm_GetTitleWidget(IForm *p, IWidget **w); 
Return
AEE_SUCCESS : If the form was able to successfully retrieve the title widget. AEE_ECLASSNOTSUPPORT : If the form does not support the use of a title widget.
A pointer to the form's title widget is returned in 'w'.
Side Effect
Calling IForm_GetTitleWidget() effectively queries the form to retrieve the WID_TITLE property.
Comment
The pointer passed in the 'w' parameter is a double-indirection -- i.e. it is a pointer to a pointer. Applications should use care in ensuring that the proper level of indirection is used in calling the function.
  • Follow