Developer

API Reference

IForm_GetTitleImage()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the image displayed in the title area of a form. This is, essentially, the image displayed by the form's title widget. For example, a form that uses a fancy corporate logo in the title area of a form could retrieve a pointer to this logo by calling IForm_GetTitleImage().
Parameters
  • po
    []:
    [in] Pointer to the IForm interface object.
  • ppi
    []:
    [out] Pointer to an IImage pointer, into which the function will return a pointer to the title image.
Interface
Prototype
   int IForm_GetTitleImage(IForm *po, IImage **ppi); 
Return
AEE_SUCCESS : If the form is able to successfully retrieve the title image. AEE_EFAILED : If the title image could not be retrieved.
Side Effect
None
Comment
The pointer passed in the 'ppi' 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