Click or drag to resize

SftpClientBeginDownloadFile(String, Stream, AsyncCallback, Object, ActionUInt64) Method

Begins an asynchronous file downloading into the stream.

Namespace: Crestron.SimplSharp.Ssh
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public IAsyncResult BeginDownloadFile(
	string path,
	Stream output,
	AsyncCallback asyncCallback,
	Object state,
	Action<ulong> downloadCallback
)

Parameters

path  String
The path.
output  Stream
The output.
asyncCallback  AsyncCallback
The method to be called when the asynchronous write operation is completed.
state  Object
A user-provided object that distinguishes this particular asynchronous write request from other requests.
downloadCallback  ActionUInt64
The download callback.

Return Value

IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
ExceptionCondition
ArgumentExceptionpath
ArgumentNullExceptionoutput
ArgumentNullExceptionoutput is null.
ArgumentExceptionpath is null or contains whitespace characters.
SshConnectionExceptionClient is not connected.
SftpPermissionDeniedExceptionPermission to perform the operation was denied by the remote host.

-or-

A SSH command was denied by the server.
SshExceptionA SSH error where Message is the message from the remote host.
Remarks
Method calls made by this method to output, may under certain conditions result in exceptions thrown by the stream.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also