Discuss this help topic in SecureBlackbox Forum

TElHTTPSWebDAVClient.PropFind

TElHTTPSWebDAVClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Retrieves properties defined on a resource.

Declaration

[C#/Java]
    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; const Depth : TSBWebDAVDepth = 2 ) : integer;
    function PropFind(const URL : string; const Properties : TElWebDAVPropertyInfoList; const All : boolean = false; const Depth : TSBWebDAVDepth = 2 ) : integer;

[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)

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:


Return value

    On success, returns server status code, otherwise returns -1.

Description

    Use this method to request a list of names of all the properties defined on the resource, or to request the values of the desired properties.

See also:     PropPatch    

Discuss this help topic in SecureBlackbox Forum