Begins asynchronous Download operation. Downloads the content of the remote directory (files and all subfolders) to the specified local directory.

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

Syntax

Visual Basic
Public Function BeginDownload ( _
	remotePath As String, _
	localPath As String, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginDownload(
	string remotePath,
	string localPath,
	AsyncCallback callback,
	Object state
)

Parameters

remotePath
Type: System..::..String
The path of the remote directory.
localPath
Type: System..::..String
The path of the local directory. Doesn't have to exist (will be created).
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

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