TElSimpleSFTPClient.Block method

TElSimpleSFTPClient.Block

Creates a byte-range lock on the file

Declaration

[C#]
void Block(byte[] Handle, long Offset, long Length, TSBSftpFileOpenAccess LockMask);

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

[Pascal]
procedure Block(const Handle : TSBSftpFileHandle; Offset, Length : Int64; LockMask : TSBSftpFileOpenAccess);

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

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

[Java]
void block(byte[] Handle, long Offset, long Length, TSBSftpFileOpenAccess LockMask);

Parameters

Handle - handle of the open file
Offset - beginning of the byte-range to lock.
Length - number of bytes in the range to lock. The special value 0 means lock from Offset to the end of the file.
LockMask - flags managing blocking process

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

TSBSftpFileOpenAccess values

[.NET][C++]	[Pascal]	[PHP]	Description
f_faReadLock = 1	faReadLock	faReadLock = 1	...
f_faWriteLock = 2	faWriteLock	faWriteLock = 2	...
f_faDeleteLock = 4	faDeleteLock	faDeleteLock = 4	...
f_faBlockAdvisory = 8	faBlockAdvisory	faBlockAdvisory = 8	...

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to create a byte-range lock on the file specified by the 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.