TElHTTPSWebDAVClient.Lock method

TElHTTPSWebDAVClient.Lock

Locks a resource on the server.

Declaration

[C#]
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 = ''; Scope : TSBWebDAVLockScope = wlsExclusive; Depth : TSBWebDAVDepth = wddInfinity; Timeout : integer = SB_WEBDAV_LOCK_INFINITE_TIMEOUT) : 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

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

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

Return value

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

Description

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