Click or drag to resize

SftpClientDownloadFile Method

Downloads remote file specified by the path into the stream.

Namespace: Crestron.SimplSharp.Ssh
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public void DownloadFile(
	string path,
	Stream output,
	Action<ulong> downloadCallback
)

Parameters

path  String
File to download.
output  Stream
Stream to write the file into.
downloadCallback  ActionUInt64
The download callback.
Exceptions
ExceptionCondition
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