TElWebDAVClient.AddressBookMultigetFirst method

TElWebDAVClient.AddressBookMultigetFirst

Initiates a "CARDDAV:addressbook-multiget" request.

Declaration

[C#]
bool AddressBookMultigetFirst(ref Object Ctx, string URL, TElWebDAVPropertyInfoList Properties, TElStringList AddressDataProps, TElStringList Hrefs, bool All, TSBWebDAVDepth Depth);

[VB.NET]
Function AddressBookMultigetFirst(ByRef Ctx As Object, ByVal URL As String, ByVal Properties As TElWebDAVPropertyInfoList, ByVal AddressDataProps As TElStringList, ByVal Hrefs As TElStringList, ByVal All As Boolean, ByVal Depth As TSBWebDAVDepth) As Boolean

[Pascal]
function AddressBookMultigetFirst(var Ctx : Pointer; const URL : string; Properties : TElWebDAVPropertyInfoList; AddressDataProps : TElStringList; Hrefs : TElStringList; All : boolean = false; Depth : TSBWebDAVDepth = wddInfinity) : boolean;

[C++]
bool AddressBookMultigetFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList &Properties, TElStringList &AddressDataProps, TElStringList &Hrefs, bool All, TSBWebDAVDepth Depth);
bool AddressBookMultigetFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList *Properties, TElStringList *AddressDataProps, TElStringList *Hrefs, bool All, TSBWebDAVDepth Depth);

[PHP]
bool AddressBookMultigetFirst(TSBPointer|array of byte|string $Ctx, string $URL, TElWebDAVPropertyInfoList $Properties, TElStringList $AddressDataProps, TElStringList $Hrefs, bool $All, integer $Depth)

[Java]
not available

Parameters

Ctx - the request handle is returned via this parameter. This handle should be passed to AddressBookMultigetNext.
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.
Hrefs - the list of vCard URLs to download.
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-multiget" request defined in RFC 6352, which allows to retrieve multiple vCards or the whole address book. After the request has been initiated, call AddressBookMultigetNext until it returns false, to get the property values for all retrieved items. When all items have been processed, call AddressBookMultigetClose to free allocated resources.

Discuss this help topic in SecureBlackbox Forum