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

Developer

API Reference

IBTSECURITYHANDLER_RETRIEVELOCALOOBDATA()

Brew Release
Brew MP 1.0.2
See Also
IBTSecurityHandler_SetRemoteOOBData IBTSecurityHandler_GetLocalOOBData
Description
This API returns the local OOB data. API should be called when AEEBTSEC_HNDLR_EV_GET_LOCAL_OOB_DONE event is received. OOB data shall be copied to 'pLocalOOB' buffer if the actual length of local OOB data is less than or equal to length of buffer passed('pLocalOOBLen' parameter). If the 'pLocalOOBLen' is less than size of OOB data, AEE_EBUFFERTOOSMALL shall be returned with 'pLocalOOBLenReq' parameter updated with size of the OOB data

Params
_me
[in]:
the object
pLocalOOB
[out]:
buffer to copy the local OOB (format as defined by the Bluetooth specification)
pLocalOOBLen
[in]:
length of 'pLocalOOB' buffer
pLocalOOBLenReq
[out]:
placeholder to store the actual size of OOB data
Return
AEE_SUCCESS
[]:
OOB data is successfully copied to the buffer
AEE_EBADPARAM
[]:
Bad parameter
AEE_EBADSTATE
[]:
Driver error.
AEE_EBUFFERTOOSMALL
[]:
OOB data size is more than the size of the buffer provided. Another appropriate error code if operation was not successful
Interface
Prototype
  •    AEEResult IBTSecurityHandler_RetrieveLocalOOBData (IBTSecurityHndlr* _me, 
                                                   uint8* pLocalOOB, 
                                                   int pLocalOOBLen,
                                                   int* pLocalOOBLenReq); 
                                   
    
Side Effect
  • None
Comments
None