Developer

API Reference

IBTPBAPClient_RetrieveVCardEntry()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPClient_PullVCardEntry
IBTPBAPClient_RetrievePhoneBook
IBTPBAPClient_RetrieveVCardListing
Description
This function should be called to retrieve a vCard when AEEBTPBAPCLI_EV_VCARD_PULL_DONE or AEEBTPBAPCLI_EV_BUFFER_FULL event is received. When the function returns, vCardListObject shall be filled with the vCardObject, vCardObjectLenReq parameter will have the actual length of data copied to pbObject.
When vCardObjectLen parameter is passed as zero, vCardObjectLenReq will have total size of the unread data.
Parameters
  • _me
    [in]:
    pointer to the IBTPBAPClient object
  • vCardObject
    [out]:
    placeholder to fill the vCard object.
  • vCardObjectLen
    [in]:
    size of the buffer
  • vCardObjectLenReq
    [out]:
    place holder to fill the size of unread data when vCardObjectLen is zero else place holder to fill the actual length of data copied.
Interface
Prototype
   IBTPBAPClient_RetrieveVCardEntry (IBTPBAPClient* _me,
                                   uint8* vCardObject, 
                                   int  vCardObjectLen,
                                   int* vCardObjectLenReq);                                   
                   
Return
AEE_SUCCESS - The vCard object retrieval is success AEE_EBADPARM - invalid input parameters AEE_BADSTATE - bad state(No connection exists). AEE_ENOSUCH - no phonebook object present
Side Effect
None
Comment
None
  • Follow