TElHTTPSWebDAVClient.PropFind method

TElHTTPSWebDAVClient.PropFind

Retrieves properties defined on a resource.

Declaration

[C#]
int PropFind(string URL, TSBWebDAVDepth Depth);
int PropFind(string URL, TElWebDAVPropertyInfoList Properties, bool All, TSBWebDAVDepth Depth);

[VB.NET]
Function PropFind(ByVal URL As String, ByVal Depth As TSBWebDAVDepth) As Integer
Function PropFind(ByVal URL As String, ByVal Properties As TElWebDAVPropertyInfoList, ByVal All As Boolean, ByVal Depth As TSBWebDAVDepth) As Integer

[Pascal]
function PropFind(const URL : string; Depth : TSBWebDAVDepth = wddInfinity) : integer; overload;
function PropFind(const URL : string; Properties : TElWebDAVPropertyInfoList; All : boolean = false; Depth : TSBWebDAVDepth = wddInfinity) : integer; overload;

[C++]
    int32_t PropFind(const std::string &URL, TSBWebDAVDepth Depth);
    int32_t PropFind(const std::string &URL, TElWebDAVPropertyInfoList &Properties, bool All, TSBWebDAVDepth Depth);
    int32_t PropFind(const std::string &URL, TElWebDAVPropertyInfoList *Properties, bool All, TSBWebDAVDepth Depth);

[PHP]
integer PropFind(string $URL, integer $Depth)
integer PropFind(string $URL, TElWebDAVPropertyInfoList $Properties, bool $All, integer $Depth)

[Java]
int propFind(String URL, TElWebDAVPropertyInfoList Properties, boolean All, TSBWebDAVDepth Depth);
int propFind(String URL, TSBWebDAVDepth Depth);

Parameters

URL - URL of the resource.
Properties - the list of of the desired properties, defines the 'prop' element.
All - if set to True, property values using the 'allprop' element are requested (see RFC 4918 for details). If set to False, only the values of the desired properties, defined by the 'prop' element, are requested.
Depth - specifies the depth of the request.

Depth 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

Return value

Returns a server status code on success, and -1 otherwise.

Description

This method requests either a list of names of all properties defined on the resource, or the values of the desired properties. Server's response is written to the OutputStream of the underlying HTTPClient. In order to process the output, the application should initialize a stream object and assign it to OutputStream. When PropFind() returns, the response may be loaded into a TElWebDAVMultistatusResponse object.

To request the list of all property names, call PropFind and provide only the URL and Depth parameters. To only request the specific properties, create a new TElWebDAVPropertyInfoList object, populate it with these properties, and pass the list to PropFind().