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

Developer

API Reference

IBTPBAPCLIENT_PULLVCARDLISTING()

Brew Release
Brew MP 1.0.2
See Also
IBTPBAPClient_RetrieveVCardListing IBTPBAPClient_PullPhoneBook IBTPBAPClient_PullVCardEntry
Description
This function should be called to pull the vCard listing from the PSE
Params
_me
[in]:
pointer to the IBTPBAPClient object
cObject
[in]:
Phonebook object type
cOrder
[in]:
what sorting order to use (Alphabetical, Indexed or Phonetical).
SearchAttrib
[in]:
search attribute (Name, Number or Sound).
pszSearchValue
[in]:
search string value. Can be empty, if no filtering is required.Note that NULL is not a valid input parameter
nMaxListCount
[in]:
denotes the max number of entries that PSE should return in the listing object. if 65535, Number of entries is not restricted
nListStartOffset
[in]:
indicates the offset of the first entry of from which vCard listing 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_PullVCardListing (IBTPBAPClient* _me,
                                       AEEBTPBAPObjectType cObject,
                                       AEEBTPBAPOrder cOrder,
                                       AEEBTPBAPSearchAttrib SearchAttrib,
                                       const char* pszSearchValue
                                       int nMaxListCount,
                                       int nListStartOffset,
                                       const char* szUserFldr);
     
    
Return
  • AEE_SUCCESS - the request to pull the phone book object has been queued and that AEEBTPBAPCLI_EV_VCARD_LISTING_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
Comments
None