Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElWebDAVClient.Lock

TElWebDAVClient     See also     

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

Locks a resource on the server.

Declaration

[C#]
    TElWebDAVLock Lock(string URL, string Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int Timeout);
    TElWebDAVLock Lock(TElWebDAVStorageObject Obj, string Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int Timeout);

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

[Pascal]
    function Lock(const URL : string; const Owner : string = ''; Scope : TSBWebDAVLockScope = wlsExclusive; Depth : TSBWebDAVDepth = wddInfinity; Timeout : integer = SB_WEBDAV_LOCK_INFINITE_TIMEOUT) : TElWebDAVLock;
    function Lock(Obj : TElWebDAVStorageObject; const Owner : string = ''; Scope : TSBWebDAVLockScope = wlsExclusive; Depth : TSBWebDAVDepth = wddInfinity; Timeout : integer = SB_WEBDAV_LOCK_INFINITE_TIMEOUT) : 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)

[Java]
    TElWebDAVLock lock(TElWebDAVStorageObject Obj, String Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int Timeout);
    TElWebDAVLock lock(String URL, String Owner, TSBWebDAVLockScope Scope, TSBWebDAVDepth Depth, int 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:

[.NET] [C++] [Pascal] Description
wlsExclusive = 0 wlsExclusive Exclusive lock
wlsShared = 1 wlsShared Shared lock, that allows access to the resource to multiple principals

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

Copyright (c) 2018, /n software, inc.