SftpClient BeginDownloadFile Method SSH .NET Client Library Documentation
Begins an asynchronous file downloading into the stream.

Namespace: Renci.SshNet
Assembly: Renci.SshNet (in Renci.SshNet.dll) Version: 0.1.0.0 (1.0.0.0)
Syntax

public IAsyncResult BeginDownloadFile(
	string path,
	Stream output,
	AsyncCallback asyncCallback,
	Object state,
	Action<ulong> downloadCallback = null
)

Parameters

path
Type: OnlineSystem String
The path.
output
Type: OnlineSystem.IO Stream
The output.
asyncCallback
Type: OnlineSystem AsyncCallback
The method to be called when the asynchronous write operation is completed.
state
Type: OnlineSystem Object
A user-provided object that distinguishes this particular asynchronous write request from other requests.
downloadCallback (Optional)
Type: OnlineSystem Action OnlineUInt64 
The download callback.

Return Value

An OnlineIAsyncResult that references the asynchronous operation.
Exceptions

Remarks

Method calls made by this method to output, may under certain conditions result in exceptions thrown by the stream.
See Also