Begins asynchronous Download operation. Downloads the specified file or directory hierarchy from the SFTP server to the local directory. Accepts wildcards.

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

Syntax

Visual Basic
Public Function BeginDownload ( _ remotePath As String, _ localDirectoryPath As String, _ traversalMode As TraversalMode, _ transferMethod As TransferMethod, _ existingFileMode As ActionOnExistingFiles, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult

Visual Basic

Public Function BeginDownload ( _
	remotePath As String, _
	localDirectoryPath As String, _
	traversalMode As TraversalMode, _
	transferMethod As TransferMethod, _
	existingFileMode As ActionOnExistingFiles, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult

C#
public IAsyncResult BeginDownload( string remotePath, string localDirectoryPath, TraversalMode traversalMode, TransferMethod transferMethod, ActionOnExistingFiles existingFileMode, AsyncCallback callback, Object state )

public IAsyncResult BeginDownload(
	string remotePath,
	string localDirectoryPath,
	TraversalMode traversalMode,
	TransferMethod transferMethod,
	ActionOnExistingFiles existingFileMode,
	AsyncCallback callback,
	Object state
)

Parameters

remotePath: Type: System..::..String
The path (with or without wildcards) of the remote file or directory.

localDirectoryPath: Type: System..::..String
The path of the local directory. This must be a directory.

traversalMode: Type: Rebex.IO..::..TraversalMode
Traversal mode. Specifies whether the whole hierarchy or files only are transferred.

transferMethod: Type: Rebex.IO..::..TransferMethod
Specifies whether to copy or move source items.

existingFileMode: Type: Rebex.IO..::..ActionOnExistingFiles
Specifies the default behavior for files that already exists at the local directory.

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