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

Developer

API Reference

IBTDATAELEMENT_RETRIEVEWIDESTRING()

Brew Release
Brew MP 1.0.2
See Also
IBTDataElement_RetrieveNumberOfElements IBTDataElement_RetrieveDataID.
Description
This API retrieves a NUL terminated wide string from the data element sequence, given its index.
Interface
Prototype
  •    AEEResult IBTDataElement_RetrieveWideString(IBTDataElement* _me,
                                                   unsigned int         index,
                                                   const unsigned char* dataID,
                                                   int                  dataIDLen,
                                                   _wchar_t*       wszData,
                                                   int             wszDataLen,
                                                   int*         wszDataLenReq)
    
       _me [i]                : The Object.
       index [i]              : Index of the element in the list.
       dataID [i]             : Buffer to hold the data ID.
       dataIDLen [i]          : Length of the buffer that holds the data ID.
       wszData [o]            : Buffer to hold the string.
       wszDataLen [i]         : Number of wide characters the buffer can hold
       wszDataLenReq [o]      : Place holder for length of buffer, in terms of 
                                number of wide characters, required to return 
                                the entire string. This includes the NUL 
                                terminator.
    Return Values:
       AEE_SUCCESS        : Data has been copied to the buffer. If the size 
                            of input buffer is smaller than the available data,
                            partial string will be returned to the caller.
                            The partial string will be NUL terminated.
                            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.
    
Side Effect
  • None.
Comments
None.