Developer

API Reference

IBTPBAPClient_RetrievePhoneBook()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPClient_PullPhoneBook
IBTPBAPClient_RetrieveVCardListing
IBTPBAPClient_RetrieveVCardEntry
Description
This function should be called to retrieve the Phone Book object when AEEBTPBAPCLI_EV_PHONEBOOK_PULL_DONE or AEEBTPBAPCLI_EV_BUFFER_FULL event is received. Application can also call this API to retrieve partial data. When the function returns, pbObject shall be filled with the phonebook object and pbObjectLenReq parameter will have the actual length of data copied to pbObject.
When pbObjectLen parameter is passed as zero, pbObjectLenReq will have total size of the unread data.
Parameters
  • _me
    [in]:
    pointer to the IBTPBAPClient object
  • pbObject
    [out]:
    placeholder to fill the Phonebook object
  • pbObjectLen
    [in]:
    size of the buffer
  • pbObjectLenReq
    [out]:
    place holder to fill the size of unread data when pbObjectLen 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 phone book object is not AEEBTPBAP_OBJECT_LOCAL_MCH or AEEBTPBAP_OBJECT_SIM_MCH
Interface
Prototype
   IBTPBAPClient_RetrievePhoneBook (IBTPBAPClient* _me,
                                   uint8* pbObject, 
                                   int  pbObjectLen,
                                   int* pbObjectLenReq,
                                   int* nNewMissedCalls);
                                   
Return
AEE_SUCCESS - The phonebook 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