Developer

API Reference

IForm_SetBGImage()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function will set the background image to be displayed on a form, storing the background as a pointer to an IImage in the form's FID_BACKGROUND property.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • piImage
    []:
    [in] Pointer to the image to be displayed as the form's background.
Interface
Prototype
   int IForm_SetBGImage(IForm *pif, IImage *piImage); 
Return
AEE_SUCCESS : If the form is able to successfully set the background image. AEE_EFAILED : If the background image could not be set.
Side Effect
Calling IForm_SetBGImage() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the FID_BACKGROUND property be set.
Comment
Applications are encouraged to use IForm_SetBGImage() as a shorthand method of setting the form's background.
  • Follow