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

Developer

API Reference

IBTDEVDBCUSTOMDATA_GETSTRING()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
This API retrieves a NUL terminated string from the data element sequence, given its index. The index can be obtained by calling IBTDevDBCustomData_GetDataIDList().
Interface
Prototype
  •    AEEResult IBTDevDBCustomData_GetString(IBTDevDBCustomData* _me,
                                              int             index,
                                              unsigned int    dataID,
                                              char*           szData,
                                              int             szDataLen,
                                              int*            szDataLenReq)
       _me [i]                : The Object.
       index [i]              : Index of the element in the list.
       dataID [i]             : The data ID.
       szData [o]             : Buffer to hold the string.
       szDataLen [i]          : Length of the input buffer.
       szDataLenReq [o]       : Place holder for length of buffer required to 
                                read the entire string.
    Return Values:
       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 retrieve the entire string, 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
    
Side Effect
  • None.
Comments
None.