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

Developer

API Reference

IBTDATAELEMENT_RETRIEVEBOOLEAN()

Brew Release
Brew MP 1.0.2
See Also
IBTDataElement_RetrieveNumberOfElements IBTDataElement_RetrieveDataID.
Description
This API retrieves a boolean value from the data element sequence, given its index.
Params
_me
[in]:
The Object.
index
[in]:
Index of the element in the list.
dataID
[in]:
Buffer to hold the data ID.
dataIDLen
[in]:
Length of the buffer that holds the data ID.
bData
[out]:
Place holder for the boolean data.
Return
AEE_SUCCESS
[]:
Data successfully returned to the caller.
AEE_ENOSUCH
[]:
No such data element available.
Interface
Prototype
  •    AEEResult IBTDataElement_RetrieveBoolean(IBTDataElement*      _me,
                                                unsigned int         index,
                                                const unsigned char* dataID,
                                                int                  dataIDLen,
                                                boolean*             bData)
    
Side Effect
  • None.
Comments
None.