TElSimpleSFTPClient.Unblock method

TElSimpleSFTPClient.Unblock

TElSimpleSFTPClient See also

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

Removes a previously acquired byte-range lock on the specified handle.

Declaration

[C#]
void Unblock(byte[] Handle, long Offset, long Length);

[VB.NET]
Sub Unblock(ByVal Handle As Byte(), ByVal Offset As Long, ByVal Length As Long)

[Pascal]
procedure Unblock(const Handle : TSBSftpFileHandle; Offset, Length : Int64);

[C++]
void Unblock(const std::vector<uint8_t> &Handle, int64_t Offset, int64_t Length);

[PHP]
void Unblock(array of byte|string|NULL $Handle, integer $Offset, integer $Length)

[Java]
void unblock(byte[] Handle, long Offset, long Length);

Parameters

Handle - handle on which a Block method has previously been called.
Offset - beginning of the byte-range to unlock.
Length - number of bytes in the range to unlock. The special value 0 means lock from Offset to the end of the file.

LockMask values:

[.NET]	[Pascal]	[C++]	Description
faReadLock = 1	faReadLock	f_faReadLock = 1	No other handle has been opened for reading andno other handle will be opened for reading until the client closes the handle.However other handle can be opened for any other access but reading
faWriteLock = 2	faWriteLock	f_faWriteLock = 2	No other handle has been opened for writing or appending andno other handle will be opened for writing or appending until the client closes the handle.However other handle can be opened for any other access but writing or appending
faDeleteLock = 4	faDeleteLock	f_faDeleteLock = 4	No other handle has been opened for deleting or with delete on close flag andno other handle will be opened deleting or with delete on close flag until the client closes the handle
faBlockAdvisory = 8	faBlockAdvisory	f_faBlockAdvisory = 8	If this bit is set, the above block modes are advisory.In advisory mode, only other accesses that specify a block mode need to be consideredwhen determining whether the block access can be granted

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to remove a previously acquired byte-range lock on the specified handle.
In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.