Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.RequestFileHash

TElSimpleSFTPClient     See also     


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


Requests hash value of the file or its part.

Declaration

[C#/Java]
    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(Filename : string; StartOffset : Int64; Length : Int64; BlockSize : cardinal; FileHash : TElSftpCheckFileReply);

[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);

[PHP]
    void RequestFileHash(string $FileName, integer $StartOffset, integer $Length, integer $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

Description

    Use this method to request hash value of the file or file part.
    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.

See also:     RequestFileHashByHandle    

Discuss this help topic in SecureBlackbox Forum