API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IOBSERVER_GETPROPERTY()

Brew Release
Brew MP 1.0.2
See Also
- IObserver - IObserver_SetProperty()
Description
This function retrieves a specific property value for the Observer. Observer may possess any number of properties. The property value is returned in a pointer passed into the function, with the function returning AEE_SUCCESS or AEE_EFAILED depending on whether or not the requested property was able to be retrieved.
Params
propId
[]:
[in] Identifies the property to be retrieved.
pVal
[]:
[out] A pointer to a 32-bit unsigned integer into which the observer will copy the value of the requested property.
Interface
Prototype
  •    int IObserver_GetProperty(IObserver* pi, uint16 propId, uint32* pVal); 
    
Return
  •    AEE_SUCCESS - If the observer is able to retrieve the requested property.
       AEE_EFAILED - If the property could not be retrieved.
    
Side Effect
  • None
Comments
Calling IObserver_GetProperty() has the same effect as processing an EVT_OBS_GETPROPERTY event.