Discuss this help topic in SecureBlackbox Forum

TElSftpClient.Unblock

TElSftpClient     See also     


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


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

Declaration

[C#/Java]
    bool Unblock(byte[] Handle, long Offset, long Length);

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

[Pascal]
    function Unblock(const Handle: TSBSftpFileHandle; Offset, Length : Int64) : boolean;
    procedure UnblockSync(const Handle: TSBSftpFileHandle; Offset, Length : Int64);
    
    type TSBSftpFileHandle = ByteArray;

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

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

Parameters

  • Handle - handle on which a Block method has previously been called.
  • 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 values:


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.

See also:     Block    

Discuss this help topic in SecureBlackbox Forum