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

Developer

API Reference

IBTDEVDBRECORD_GETNICKNAME()

Brew Release
Brew MP 1.0.2
See Also
IBTDevDBRecord_SetNickName IBTDevDBRecord_GetDeviceName IBTDevDBRecord_Read
Description
Reads the nick name of the device associated with this record
Params
_me
[in]:
The object
pszNickName
[out]:
Destination to store the device nick name
pszNickNameLen
[out]:
Length of the 'pszNickName' buffer
pszNickNameLenReq
[out]:
Actual length required to copy complete device name onto 'pszNickName' buffer
Return
AEE_SUCCESS
[]:
Device nick name is successfully retrieved
AEE_EBUFFERTOOSMALL
[]:
size of 'pszNickName' buffer is too small to copy entire name
AEE_EBADSTATE
[]:
Driver error. Another appropriate error code if operation was not successful
Interface
Prototype
  •    AEEResult IBTDevDBRecord_GetNickName(IBTDevDBRecord* _me,
                                            char* pszNickName,
                                            int pszNickNameLen,
                                            int* pszNickNameLenReq);
    
Side Effect
  • None
Comments
None