Developer

API Reference

IForm_GetProperty()

Brew Release
Brew MP 1.0.2
See Also
IForm IForm_SetProperty() Widget Events
Description
This function retrieves a specific property value for the given form. Forms may possess any number of form properties, as defined in AEEIForm.h, and may additionally support widget properties defined in AEEWidgetProperties.h. Form properties include visual characteristics of the form such as the current activation state, theme, and background image. The property value is returned by IForm_GetProperty() in a pointer passed into the function in the 'pVal' parameter, with the function returning AEE_SUCCESS or AEE_EFAILED depending on whether or not the requested property was able to be retrieved from the form.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • propId
    []:
    [in] Identifies the property to be retrieved.
  • pVal
    []:
    [out] A pointer to a 32-bit unsigned integer into which the form will copy the value of the requested property.
Interface
Prototype
   int IForm_GetProperty(IForm *pif, uint16 propId, uint32 pVal)
Return
AEE_SUCCESS : If the form is able to retrieve the requested property. AEE_EFAILED : If the property could not be retrieved.
The value of the requested property is returned in 'pVal'.
Side Effect
None
Comment
None
  • Follow