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

Developer

API Reference

IBTEIR_RETRIEVENAME()

Brew Release
Brew MP 1.0.2
See Also
IBTEIR_RetrieveDataTypes
Description
Retrieve the name or short name of the device in UTF-8 format. The EIR sequence will have at max, one instance of the name. The type of name, either short or full name, can be determined by invoking IBTEIR_RetrieveDataTypes().
Params
_me
[in]:
The IBTEIR object
name
[out]:
Buffer to hold the name
nameLen
[in]:
Length of the input buffer
nameLenReq
[out]:
Place holder for length of buffer required to read the entire name, including the NUL terminator.
Return
AEE_SUCCESS
[]:
Name has been copied to the buffer. If the size of input buffer is smaller than the length of the name, partial name will be copied to the buffer. The partial name will be NUL terminated. To read the entire name, the caller should allocate the required buffer size and invoke this API again.
AEE_ENOSUCH
[]:
no such data element available. Another appropriate error code if operation was not successful
Interface
Prototype
  •    AEEResult IBTEIR_RetrieveName(IBTEIR*        _me,
                                     char*          name, 
                                     int            nameLen,
                                     int*           nameLenReq)
Side Effect
  • None.
Comments
None.