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

Developer

API Reference

IBTDEVDBCUSTOMDATA_GETBYTESEQ()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
This API retrieves a byte sequence from the data element sequence, given its index. The index can be obtained by calling IBTDevDBCustomData_GetDataIDList().
Params
_me
[in]:
The Object.
index
[in]:
Index of the element in the list.
dataID
[in]:
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. Another appropriate error code if operation was not successful
Interface
Prototype
  •    AEEResult IBTDevDBCustomData_GetByteSeq(IBTDevDBCustomData* _me,
                                               int             index,
                                               unsigned int    dataID,
                                               unsigned char*  byteSequence,
                                               int             byteSequenceLen,
                                               int*            byteSequenceLenReq)
Side Effect
  • None.
Comments
None.