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

Developer

API Reference

IBTDATAELEMENT_RETRIEVEDATAID()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
Retrieves the data ID of a data element at the given index.
Params
_me
[in]:
The object.
index
[in]:
Index of the element in the sequence.
dataID
[out]:
Buffer to hold data ID.
dataIDLen
[in]:
Length of the input buffer.
dataIDLenReq
[out]:
Place holder for length of buffer required to read the entire data ID.
Return
AEE_SUCCESS
[]:
Data ID has been copied to the buffer. If the size of input buffer is smaller than the available data types, partial data will be returned to the caller. To read the complete data ID, the caller should allocate the required buffer size and invoke this API again.
AEE_ENOSUCH
[]:
No such data available.
Interface
Prototype
  •    AEEResult IBTDataElement_RetrieveDataID(IBTDataElement* _me,
                                               unsigned int   index,
                                               unsigned char* dataID,
                                               int            dataIDLen,
                                               int*          dataIDLenReq)
Side Effect
  • None.
Comments
None.