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

Developer

API Reference

IBTDATAELEMENT_RETRIEVEBYTESEQ()

Brew Release
Brew MP 1.0.2
See Also
IBTDataElement_RetrieveNumberOfElements IBTDataElement_RetrieveDataID.
Description
This API retrieves a byte sequence 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.
byteSequence
[out]:
Buffer to hold data.
byteSequenceLen
[in]:
Length of the input buffer.
byteSequenceLenReq
[out]:
Place holder for length of buffer required to read the entire data. Return
AEE_SUCCESS
[]:
Data has been copied to the buffer. If the size of input buffer is smaller than the available data, partial data will be returned to the caller. To read all the data, the caller should allocate the required buffer size and invoke this API again.
AEE_ENOSUCH
[]:
No such data element available at the given index.
Interface
Prototype
  •    AEEResult IBTDataElement_RetrieveByteSeq(IBTDataElement*      _me,
                                                unsigned int         index,
                                                const unsigned char* dataID,
                                                int                  dataIDLen,
                                                unsigned char*  byteSequence,
                                                int             byteSequenceLen,
                                                int*            byteSequenceLenReq)
Side Effect
  • None.
Comments
None.