Sftp.GetChecksumAsync Method
Namespace: Rebex.Net
Assembly: Rebex.Sftp.dll (version 7.0.9083)
GetChecksumAsync(String, ChecksumAlgorithm, Object)
Begins asynchronous GetChecksum operation. Returns the checksum of the specified file on the server. Only works on servers that support the
check-fileDeclaration
public Task<Checksum> GetChecksumAsync(string remotePath, ChecksumAlgorithm algorithm, object state = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | remotePath | Path of the remote file. |
| ChecksumAlgorithm | algorithm | Desired checksum algorithm (server must support it). |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Checksum> | Checksum of the specified remote file. |
Remarks
Please note that not all SFTP servers support checksum calculation, and not all SFTP servers support all checksum algorithms.
To calculate checksums of local files, use one of GetChecksum(String, ChecksumAlgorithm) methods.
GetChecksumAsync(String, ChecksumAlgorithm, Int64, Int64, Object)
Begins asynchronous GetChecksum operation. Returns the checksum of the specified file on the server. Only works on servers that support the
check-fileDeclaration
public Task<Checksum> GetChecksumAsync(string remotePath, ChecksumAlgorithm algorithm, long offset, long count, object state = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | remotePath | Path of the remote file. |
| ChecksumAlgorithm | algorithm | Desired checksum algorithm (server must support it). |
| Int64 | offset | The offset in remote file where reading will start. |
| Int64 | count | The maximum number of bytes to read. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Checksum> | Checksum of the specified remote file. |
Remarks
Please note that not all SFTP servers support checksum calculation, and not all SFTP servers support all checksum algorithms.
To calculate checksums of local files, use one of GetChecksum(String, ChecksumAlgorithm, Int64, Int64) methods.