Developer

API Reference

IForm_GetBGImage()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve a pointer to the image displayed in the background area of a form. This is, essentially, the image displayed by the form's background widget. For example, a form that uses a semi-opaque photo of Shaquille O'Neal as the background image for all of its forms could retrieve Shaq's smiling mug by calling IForm_GetBGImage().
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • ppi
    []:
    [out] Pointer to an IImage pointer, into which the function will return a pointer to the background image.
Interface
Prototype
   int IForm_GetBGImage(IForm *pif, IImage **ppi);
Return
AEE_SUCCESS : If the form is able to successfully retrieve the background image. AEE_EFAILED : If the background image could not be retrieved.
Side Effect
Calling IForm_GetBGImage() effectively queries the form to retrieve the FID_BACKGROUND property.
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