Developer

API Reference

IBTPBAPClient_RetrieveVCardListing()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPClient_PullVCardListing
IBTPBAPClient_RetrievePhoneBook
IBTPBAPClient_RetrieveVCardEntry
Description
This function should be called to retrieve the vCard listing when AEEBTPBAPCLI_EV_VCARD_LISTING_DONE or AEEBTPBAPCLI_EV_BUFFER_FULL event is received. When the function returns, vCardListObject shall be filled with the vCard listing object, vCardListObjectLenReq parameter will have the actual length of data copied to pbObject.
When vCardListObjectLen parameter is passed as zero, pbObjectLenReq will have total size of the unread data.
Parameters
  • _me
    [in]:
    pointer to the IBTPBAPClient object
  • vCardListObject
    [out]:
    placeholder to fill the vCard listing object.
  • vCardListObjectLen
    [in]:
    size of the buffer
  • vCardListObjectLenReq
    [out]:
    place holder to fill the size of unread data when vCardListObjectLen is zero else place holder to fill the actual length of data copied.
  • nNewMissedCalls
    [out]:
    number of missed calls that has not been checked yet by the user when PBAP session started. NULL if requested vCard listing is not AEEBTPBAP_OBJECT_LOCAL_MCH or AEEBTPBAP_OBJECT_SIM_MCH
Interface
Prototype
   IBTPBAPClient_RetrieveVCardListing (IBTPBAPClient* _me,
                                      uint8* vCardListObject, 
                                      int  vCardListObjectLen,
                                      int* vCardListObjectLenReq,
                                      int* nNewMissedCalls);
                                      
Return
AEE_SUCCESS - The vCard listing 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