Developer

API Reference

IBTPBAPClient_PullPhoneBook()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPClient_RetrievePhoneBook
IBTPBAPClient_PullVCardListing
IBTPBAPClient_PullVCardEntry
Description
This function should be called to pull the phonebook object from the PSE
Parameters
  • _me
    [in]:
    pointer to the IBTPBAPClient object
  • cObject
    [in]:
    Phonebook object type
  • lAttribMask
    [in]:
    attribute Mask. One of the AEEBTPBAPAttribMask.
  • cFormat
    [in]:
    requested format (vCard 2.1 or 3.0)
  • nMaxListCount
    [in]:
    denotes the max number of entries that PSE should return in the phone book object. If 65535, Number of entries is not restricted indexes in the phone book of interest.
  • nListStartOffset
    [in]:
    indicates the offset of the first entry of phonebook from which phonebook object should be returned.
  • szUserFldr
    [in]:
    user defined folder. Valid only when cObject is AEEBTPBAP_OBJTYPE_USER_DEFINED. Pass empty string in other cases.
Interface
Prototype
   IBTPBAPClient_PullPhoneBook (IBTPBAPClient* _me,
                                AEEBTPBAPObjectType cObject,
                                uint64 lAttribMask,
                                BTOBEXFormat cFormat,
                                int nMaxListCount,
                                int nListStartOffset,
                                const char* szUserFldr);
Return
AEE_SUCCESS - the request to pull the phone book object has been queued and AEEBTPBAPCLI_EV_PHONEBOOK_PULL_DONE event will be generated at a later time. AEE_ENOMEMORY - could not queue command due to lack of memory AEE_EBADPARM - invalid input parameters AEE_BADSTATE - bad state(No connection exists).
Side Effect
None
Comment
None
  • Follow