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

Developer

API Reference

IOBEXSRV_GETPARAMS()

Brew Release
Brew MP 1.0.2
See Also
Description
This function can be used to read information from the interface. paramType defines the type of the data being read. Accordingly, the output buffer is either pU32 or pParam. pU32 returns a parameter which is a 4 byte value. pParam can be used to return a byte array or a null terminated string containing a name value pair.If the return value is a null terminated string, with name value pairs, nParamLen, includes the null terminator. The format of the string is "=;="
The parameters that can be read from this interface are
AEEOBEXPARAM_BT_BDA six byte array
AEEOBEXPARAM_BT_RFCOMM_SCN uint32
Params
po
[in]:
pointer to the IOBEXSrv object
paramType
[in]:
parameter type
pU32
[out]:
place holder for a 4 byte value
pParam
[out]:
buffer to hold the parameter
nParamLen
[in]:
length of the buffer
pnParamLenReq
[out]:
if return value is AEE_EBUFFERTOOSMALL, this location contains length of the buffer required to hold the parameter
Interface
Prototype
  •    int IOBEXSrv_GetParams( IOBEXSrv          *po,
                               AEEOBEXParamType  paramType,
                               uint32            *pU32,
                               uint8             *pParam,
                               int               nParamLen,
                               int               *pnParamLenReq);
    
Return
  • AEE_SUCCESS : parameters returned successfully AEE_EBADPARM : invalid parameters AEE_EBUFFERTOOSMALL : buffer size that was passed to this function is insufficient. AEE_ENOSUCH : no such parameter available
Side Effect
  • None.
Comments
None.