Discuss this help topic in SecureBlackbox Forum

TElWebDAVClient.Lock

TElWebDAVClient     See also     


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


Locks a resource on the server.

Declaration

[C#/Java]
    TElWebDAVLock Lock(string URL, string Owner /* = "" */, TSBWebDAVLockScope Scope /* = 0 */, TSBWebDAVDepth Depth /* = 2 */, int Timeout /* = 0 */);
    TElWebDAVLock Lock(TElWebDAVStorageObject Obj, string Owner /* = "" */, TSBWebDAVLockScope Scope /* = 0 */, TSBWebDAVDepth Depth /* = 2 */, int Timeout /* = 0 */);

[VB.NET]
    Function Lock(ByVal URL As String, ByVal Owner As String = "", ByVal Scope As TSBWebDAVLockScope = 0, ByVal Depth As TSBWebDAVDepth = 2, ByVal Timeout As Integer = 0) As TElWebDAVLock
    Function Lock(ByVal Obj As TElWebDAVStorageObject, ByVal Owner As String = "", ByVal Scope As TSBWebDAVLockScope = 0, ByVal Depth As TSBWebDAVDepth = 2, ByVal Timeout As Integer = 0) As TElWebDAVLock

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

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

[PHP]
    TElWebDAVLock Lock(string $URL, string $Owner, integer $Scope, integer $Depth, integer $Timeout)
    TElWebDAVLock Lock(TElWebDAVStorageObject $Obj, string $Owner, integer $Scope, integer $Depth, integer $Timeout)

Parameters

  • URL - URL of the resource to be locked.
  • Obj - the object to be locked.
  • Owner - the owner of the resource.
  • Scope - Lock scope.
  • Depth - Lock depth.
  • Timeout - Lock timeout. Value 0 (zero) means infinite timeout.

Scope values:


Depth values:


Return value

    Returns a TElWebDAVLock object containing information about the lock.

Description

    Use this method to lock a resource on the server.

See also:     RefreshLock     Unlock    

Discuss this help topic in SecureBlackbox Forum