Discuss this help topic in SecureBlackbox Forum

TElHTTPSWebDAVClient.Lock

TElHTTPSWebDAVClient     See also     


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


Locks a resource on the server.

Declaration

[C#/Java]
    int Lock(string URL, string IfHeader, string Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int Timeout);

[VB.NET]
    Function Lock(ByVal URL As String, ByVal IfHeader As String, ByVal Owner As String, ByVal Scope As TSBWebDAVLockScope, ByVal Depth As TSBWebDAVDepth, ByVal Timeout As Integer) As Integer

[Pascal]
    function Lock(const URL : string; const IfHeader : string = ""; const Owner : string = ""; const Scope : TSBWebDAVLockScope = 0; const Depth : TSBWebDAVDepth = 2; const Timeout : integer = 0) : integer;

[C++]
    int32_t Lock(const std::string &URL, const std::string &IfHeader, const std::string &Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int32_t Timeout);

[PHP]
    integer Lock(string $URL, string $IfHeader, string $Owner, integer $Scope, integer $Depth, integer $Timeout)

Parameters

  • URL - URL of the resource to be locked.
  • IfHeader - specifies the If header of the request.
  • Owner - the owner of the resource.
  • Scope - specifies lock scope.
  • Depth - specifies lock depth.
  • Timeout - specifies lock timeout. Value 0 (zero) means infinite timeout.

Depth values:


Scope values:


Return value

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

Description

    Use this method to send a LOCK request to the server.

See also:     Unlock    

Discuss this help topic in SecureBlackbox Forum