Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.RequestFileHash

TElSimpleSFTPClient     See also     


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


Requests the hash value of a file or its part.

Declaration

[C#]
    void RequestFileHash(string FileName, long StartOffset, long Length, uint BlockSize, TElSftpCheckFileReply FileHash);

[VB.NET]
    Sub RequestFileHash(ByVal FileName As String, ByVal StartOffset As Long, ByVal Length As Long, ByVal BlockSize As UInt32, ByVal FileHash As TElSftpCheckFileReply)

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

[C++]
    void RequestFileHash(const std::string &FileName, int64_t StartOffset, int64_t Length, uint32_t BlockSize, TElSftpCheckFileReply &FileHash);
    void RequestFileHash(const std::string &FileName, int64_t StartOffset, int64_t Length, uint32_t BlockSize, TElSftpCheckFileReply *FileHash);
    void RequestFileHash(const std::string &FileName, TElSftpCheckFileReply &FileHash);
    void RequestFileHash(const std::string &FileName, TElSftpCheckFileReply *FileHash);
    void RequestFileHash(const std::string &FileName, int64_t StartOffset, int64_t Length, uint32_t BlockSize, const std::string &HashAlgorithms, TElSftpCheckFileReply &FileHash);
    void RequestFileHash(const std::string &FileName, int64_t StartOffset, int64_t Length, uint32_t BlockSize, const std::string &HashAlgorithms, TElSftpCheckFileReply *FileHash);
    void RequestFileHash(const std::string &FileName, int32_t HashAlgorithm, TElSftpCheckFileReply &FileHash);
    void RequestFileHash(const std::string &FileName, int32_t HashAlgorithm, TElSftpCheckFileReply *FileHash);

[PHP]
    void RequestFileHash(string $FileName, integer $StartOffset, integer $Length, integer $BlockSize, TElSftpCheckFileReply $FileHash)
    void RequestFileHash(string $FileName, TElSftpCheckFileReply $FileHash)
    void RequestFileHash(string $FileName, integer $StartOffset, integer $Length, integer $BlockSize, string $HashAlgorithms, TElSftpCheckFileReply $FileHash)
    void RequestFileHash(string $FileName, integer $HashAlgorithm, TElSftpCheckFileReply $FileHash)

[Java]
    void requestFileHash(String FileName, long StartOffset, long Length, int BlockSize, TElSftpCheckFileReply FileHash);

Parameters

  • Filename - name of the desired file
  • 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 of 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.

See also:     RequestFileHashByHandle    

Discuss this help topic in SecureBlackbox Forum