TElWebDAVClient.AddressBookQueryFirst method

TElWebDAVClient.AddressBookQueryFirst

Initiates a "CARDDAV:addressbook-query" request.

Declaration

[C#]
bool AddressBookQueryFirst(ref Object Ctx, string URL, TElWebDAVPropertyInfoList Properties, TElStringList AddressDataProps, TElCardDavFilter Filter, int Limit, bool All, TSBWebDAVDepth Depth);

[VB.NET]
Function AddressBookQueryFirst(ByRef Ctx As Object, ByVal URL As String, ByVal Properties As TElWebDAVPropertyInfoList, ByVal AddressDataProps As TElStringList, ByVal Filter As TElCardDavFilter, ByVal Limit As Integer, ByVal All As Boolean, ByVal Depth As TSBWebDAVDepth) As Boolean

[Pascal]
function AddressBookQueryFirst(var Ctx : Pointer; const URL : string; Properties : TElWebDAVPropertyInfoList; AddressDataProps : TElStringList; Filter : TElCardDavFilter; Limit : integer; All : boolean = false; Depth : TSBWebDAVDepth = wddInfinity) : boolean;

[C++]
bool AddressBookQueryFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList &Properties, TElStringList &AddressDataProps, TElCardDavFilter &Filter, int32_t Limit, bool All, TSBWebDAVDepth Depth);
bool AddressBookQueryFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList *Properties, TElStringList *AddressDataProps, TElCardDavFilter *Filter, int32_t Limit, bool All, TSBWebDAVDepth Depth);

[PHP]
bool AddressBookQueryFirst(TSBPointer|array of byte|string $Ctx, string $URL, TElWebDAVPropertyInfoList $Properties, TElStringList $AddressDataProps, TElCardDavFilter $Filter, integer $Limit, bool $All, integer $Depth)

[Java]
not available

Parameters

Ctx - the request handle is returned via this parameter. This handle should be passed to AddressBookQueryNext.
URL - specifies address book URL.
Properties - a set of DAV properties for which the values shoud be returned.
AddressDataProps - a set of vCard properties for which the values should be returned.
Filter - filter object that defines search criteria.
Limit - maximum number of vCards returned. Set to zero for unlimited number of search results.
All - set this parameter to true to create an "allprop" request.
Depth - specifies the request depth.

TSBWebDAVDepth values

[.NET] [C++]	[Pascal]	Description
wddZero = 0	wddZero	The request applies only to the resource specified in the request URI
wddOne = 1	wddOne	The request applies to the resource and its children
wddInfinity = 2	wddInfinity	The request applies to the resource specified in the request URI along with all its members, all the way down the hierarchy

Description

This method initiates a "CARDDAV:addressbook-query" request defined in RFC 6352, which allows to search an addressbook for vCards that match certain filter criteria. After the request has been initiated, call AddressBookQueryNext until it returns false, to get the property values for all retrieved items. When all items have been processed, call AddressBookQueryClose to free allocated resources.

Discuss this help topic in SecureBlackbox Forum