Discuss this help topic in SecureBlackbox Forum

TElSftpClient.RequestFileHash

TElSftpClient     See also     


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


Requests hash value of the file or its part.

Declaration

[C#/Java]
    bool RequestFileHash(string Filename, long StartOffset, long Length, uint BlockSize);
    void RequestFileHashSync(string Filename, long StartOffset, long Length, uint BlockSize);

[VB.NET]
    Function RequestFileHash(ByVal Filename As String, ByVal StartOffset As long, ByVal Length As long, ByVal BlockSize As UInt32) As Boolean
    Sub RequestFileHashSync(ByVal Filename As String, ByVal StartOffset As long, ByVal Length As long, ByVal BlockSize As UInt32)

[Pascal]
    function RequestFileHash(Filename : string; StartOffset : Int64; Length : Int64; BlockSize : cardinal) : boolean;
    procedure RequestFileHashSync(Filename : string; StartOffset : Int64; Length : Int64; BlockSize : cardinal);

[C++]
    bool RequestFileHash(const std::string &FileName, int64_t StartOffset, int64_t Length, uint32_t BlockSize);

[PHP]
    bool RequestFileHash(string $FileName, integer $StartOffset, integer $Length, integer $BlockSize)

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

Return value

    True if the operation was completed successfully;
    False otherwise.

Description

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

See also:     RequestFileHashByHandle    

Discuss this help topic in SecureBlackbox Forum