Click or drag to resize

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

Begins an asynchronous uploading the steam into remote file.

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

Parameters

input  Stream
Data input stream.
path  String
Remote file path.
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.
uploadCallback  ActionUInt64
The upload callback.

Return Value

IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
ExceptionCondition
ArgumentNullExceptioninput is null.
ArgumentExceptionpath is null or contains whitespace characters.
SshConnectionExceptionClient is not connected.
SftpPermissionDeniedExceptionPermission to list the contents of the directory 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 input, 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