Begins asynchronous Download operation. Downloads the specified files and/or directories from the SFTP server to the local directory.

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

Syntax

Visual Basic
Public Function BeginDownload ( _
	set As FileSet, _
	localDirectoryPath As String, _
	transferMethod As TransferMethod, _
	existingFileMode As ActionOnExistingFiles, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginDownload(
	FileSet set,
	string localDirectoryPath,
	TransferMethod transferMethod,
	ActionOnExistingFiles existingFileMode,
	AsyncCallback callback,
	Object state
)

Parameters

set
Type: Rebex.IO..::..FileSet
A filtering set which specifies remote files and directories to be downloaded.
localDirectoryPath
Type: System..::..String
The path of the local directory. This must be a directory.
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

See Also