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

Developer

API Reference

IBTPBAPSERVER_GETCLIENTREQINFO()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPServer_AcceptPBAccessReq
Description
Application should issue this command to retrieve the information of client requested operation in case application wants to service the client request. All the information about client request shall be returned as part of out parameters passed to this function
Params
_me
[in]:
pointer to the IBTPBAPServer object
opType
[in]:
type of the operation requested by client
cliReqInfo
[out]:
details of client requested operation
srchValue
[]:
buffer to store vCard name or search value text. Valid only for vCardListing operation or Pull VCard entry operation In case of vCardListing this buffer contains search value. In case of vCard pull operation, this buffer contains name of vCard.
srchValueLen
[]:
length of the srchValue buffer.Valid only for vCardListing operation
srchValueLenReq
[]:
actual length of search value text.Valid only for vCardListing operation
szUserFolder
[]:
user defined folder string.Valid only when event is PB_ACCESS_REQ and Object type is AEEBTPBAP_OBJTYPE_USER_DEFINED
szUserFolderLen
[]:
user defined folder string length.Valid only when event is PB_ACCESS_REQ and Object type is AEEBTPBAP_OBJTYPE_USER_DEFINED
szUserFolderLenReq
[]:
Actual length of user defined folder string

Interface
Prototype
  •    IBTPBAPServer_GetClientReqInfo(IBTPBAPServer* _me, 
                                      AEEBTPBAPOpType opType
                                      AEEBTPBAPCliReqInfo* cliReqInfo,
                                      uint8*   srchValue,
                                      int      srchValueLen,
                                      int*     srchValueLenReq,
                                      uint8*   szUserDefFolder,
                                      int      szUserDefFolderLen,
                                      int*     szUserDefFolderLenReq );
    
Return

  • AEE_SUCCESS : cliReqInfo is filled with the info about client requested operation. AEE_ENOMEMORY : no memory AEE_EBUFFERTOOSMALL : Buffer is not enough to fill the data. This is relevant only when client request is vCard listing or there is a valid user defined folder present In case of vCard listing if the value passed in srchValueLen parameter is less than actual length of search value string, AEE_EBUFFERTOOSMALL shall be returned with parameter srchValueLenReq having actual length required. In case when a folder present if the value passed in szUserDefFolderLen parameter is less than actual length of user folder string, AEE_EBUFFERTOOSMALL shall be returned with parameter szUserDefFolderLenReq having actual length required.
    AEE_EBADSTATE : bad state ( No outstanding request to service )
Side Effect
  • None
Comments
None