TElSimpleSftpClient.RequestFileHashByHandle method

TElSimpleSFTPClient.RequestFileHashByHandle

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

Declaration

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

[VB.NET]
Sub RequestFileHashByHandle(ByVal Handle As Byte(), ByVal StartOffset As Long, ByVal Length As Long, ByVal BlockSize As UInt32, ByVal FileHash As TElSftpCheckFileReply)

[Pascal]
    procedure RequestFileHashByHandle(const Handle : TSBSftpFileHandle; StartOffset : Int64; Length : Int64; BlockSize : UInt32; FileHash : TElSftpCheckFileReply); overload;
    procedure RequestFileHashByHandle(const Handle : TSBSftpFileHandle; FileHash : TElSftpCheckFileReply); overload;
    procedure RequestFileHashByHandle(const Handle : TSBSftpFileHandle; StartOffset : Int64; Length : Int64; BlockSize : UInt32; const HashAlgorithms : string; FileHash : TElSftpCheckFileReply); overload;
    procedure RequestFileHashByHandle(const Handle : TSBSftpFileHandle; HashAlgorithm : integer; FileHash : TElSftpCheckFileReply); overload;

[C++]
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int64_t StartOffset, int64_t Length, uint32_t BlockSize, TElSftpCheckFileReply &FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int64_t StartOffset, int64_t Length, uint32_t BlockSize, TElSftpCheckFileReply *FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, TElSftpCheckFileReply &FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, TElSftpCheckFileReply *FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int64_t StartOffset, int64_t Length, uint32_t BlockSize, const std::string &HashAlgorithms, TElSftpCheckFileReply &FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int64_t StartOffset, int64_t Length, uint32_t BlockSize, const std::string &HashAlgorithms, TElSftpCheckFileReply *FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int32_t HashAlgorithm, TElSftpCheckFileReply &FileHash);
    void RequestFileHashByHandle(const std::vector<uint8_t> &Handle, int32_t HashAlgorithm, TElSftpCheckFileReply *FileHash);

[PHP]
    void RequestFileHashByHandle(array of byte|string|NULL $Handle, integer $StartOffset, integer $Length, integer $BlockSize, TElSftpCheckFileReply $FileHash)
    void RequestFileHashByHandle(array of byte|string|NULL $Handle, TElSftpCheckFileReply $FileHash)
    void RequestFileHashByHandle(array of byte|string|NULL $Handle, integer $StartOffset, integer $Length, integer $BlockSize, string $HashAlgorithms, TElSftpCheckFileReply $FileHash)
    void RequestFileHashByHandle(array of byte|string|NULL $Handle, integer $HashAlgorithm, TElSftpCheckFileReply $FileHash)

[Java]
void requestFileHashByHandle(byte[] Handle, long StartOffset, long Length, int BlockSize, TElSftpCheckFileReply FileHash);

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
FileHash - should be an initialized object into which file hash will be put
HashAlgorithms -
HashAlgorithm -

Description

Use this method to request the hash value for a file or a file part.
In case of error, EElSFTPError exception containing the SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.