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

Developer

API Reference

IBTPROPERTIES_RETRIEVESHORTNAME()

Brew Release
Brew MP 1.0.2
Description
Retrieve the short name of the local device in UTF-8 format.
Params
_me
[in]:
The object.
name
[out]:
pointer to buffer which will be filled with the name when API returns.
nameLen
[in]:
Length of input buffer.
nameLenReq
[out]:
Length of the buffer required to return the name. This includes the NUL terminator.
Return
AEE_SUCCESS
[]:
Name returned. If the size of the buffer is smaller than the the size required to return the entire name, partial name will be returned. nameLenReq will contain the size of the buffer required to retrieve the entire name. The app should allocate the required buffer size and call this API again.
AEE_EBADSTATE
[]:
Information not available to be read due to driver error.
Interface
Prototype
  •    AEEResult IBTProperties_RetrieveShortName(IBTProperties* _me,
                                                 char*          name,
                                                 int            nameLen,
                                                 int*           nameLenReq); 
Side Effect
  • None.
Comments
None.