Begins asynchronous GetChecksum operation. Returns the checksum of the specified file on the server. Only works on servers that support the
 Copy imageCopy Code
check-file
extension.

Namespace:  Rebex.Net
Assembly:  Rebex.Sftp (in Rebex.Sftp.dll)

Syntax

Visual Basic
Public Function BeginGetChecksum ( _
	remotePath As String, _
	algorithm As ChecksumAlgorithm, _
	offset As Long, _
	count As Long, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetChecksum(
	string remotePath,
	ChecksumAlgorithm algorithm,
	long offset,
	long count,
	AsyncCallback callback,
	Object state
)

Parameters

remotePath
Type: System..::..String
Path of the remote file.
algorithm
Type: Rebex.IO..::..ChecksumAlgorithm
Desired checksum algorithm (server must support it).
offset
Type: System..::..Int64
The offset in remote file where reading will start.
count
Type: System..::..Int64
The maximum number of bytes to read.
callback
Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
state
Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.

Return Value

An IAsyncResult that references the asynchronous operation.

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.

In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also