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

Developer

API Reference

IBTDEVDBCUSTOMDATA_GETDATAIDLIST()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
Retrieves a list of data element IDs contained in this object. The first element is at index zero.
Params
_me
[in]:
The object.
dataIDSeq
[out]:
Buffer to hold data IDs.
dataIDSeqLen
[in]:
Number of unsigned int elements the input buffer can hold.
dataIDSeqLenReq
[out]:
Place holder for length of buffer required to read the entire data.
Return
AEE_SUCCESS
[]:
Data IDs have been copied to the buffer. If the size of input buffer is smaller than the available data IDs, partial list will be returned to the caller. To read all the IDs, the caller should allocate the required buffer size and invoke this API again.
AEE_ENOSUCH
[]:
No such data available. Another appropriate error code if operation was not successful
Interface
Prototype
  •    AEEResult IBTDevDBCustomData_GetDataIDList(IBTDevDBCustomData* _me,
                                                  unsigned int* dataIDSeq,
                                                  int dataIDSeqLen,
                                                  int* dataIDSeqLenReq)
Side Effect
  • None.
Comments
None.