TElSftpClient.RequestFileHashByHandle method

TElSftpClient.RequestFileHashByHandle

Asks the server to check hash value for the file or file part.

Declaration

[C#]
bool RequestFileHashByHandle(byte[] Handle, long StartOffset, long Length, uint BlockSize);

[VB.NET]
Function RequestFileHashByHandle(ByVal Handle As Byte(), ByVal StartOffset As Long, ByVal Length As Long, ByVal BlockSize As UInt32) As Boolean

[Pascal]
function RequestFileHashByHandle(Handle : ByteArray; StartOffset : Int64; Length : Int64; BlockSize : cardinal) : boolean;
procedure RequestFileHashByHandleSync(Handle : ByteArray; StartOffset : Int64; Length : Int64; BlockSize : cardinal);

[C++]
bool RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int64_t StartOffset, int64_t Length, uint32_t BlockSize);

[PHP]
bool RequestFileHashByHandle(array of byte|string|NULL $Handle, integer $StartOffset, integer $Length, integer $BlockSize)

[Java]
boolean requestFileHashByHandle(byte[] Handle, long StartOffset, long Length, int BlockSize);

Parameters

Handle - file handle
StartOffset - starting offset of the data piece in the desired file
Length - length of the data piece
BlockSize - size of the data block

Return value

True if the operation was completed successfully;
False otherwise.

Description

Use this method to request the hash value for a file or file part. If the operation succeeds, OnFileHash event is fired, otherwise, OnError event is fired.