Click or drag to resize

ScpClient Class

Provides SCP client functionality.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharp.SshBaseClient
    Crestron.SimplSharp.SshScpClient

Namespace: Crestron.SimplSharp.Ssh
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class ScpClient : BaseClient

The ScpClient type exposes the following members.

Constructors
 NameDescription
Public methodScpClient(ConnectionInfo) Initializes a new instance of the SftpClient class.
Public methodScpClient(String, String, PrivateKeyFile) Initializes a new instance of the SftpClient class.
Public methodScpClient(String, String, String) Initializes a new instance of the SftpClient class.
Public methodScpClient(String, Int32, String, PrivateKeyFile) Initializes a new instance of the SftpClient class.
Public methodScpClient(String, Int32, String, String) Initializes a new instance of the SftpClient class.
Top
Properties
 NameDescription
Public propertyBufferSize Gets or sets the size of the buffer.
Public propertyIsConnected Gets a value indicating whether this client is connected to the server.
(Inherited from BaseClient)
Public propertyKeepAliveInterval Gets or sets the keep alive interval in seconds.
(Inherited from BaseClient)
Public propertyOperationTimeout Gets or sets the operation timeout.
Top
Methods
 NameDescription
Public methodConnect Connects client to the server.
(Inherited from BaseClient)
Public methodDisconnect Disconnects client from the server.
(Inherited from BaseClient)
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages.
(Inherited from BaseClient)
Protected methodDispose(Boolean) Releases unmanaged and - optionally - managed resources
(Overrides BaseClientDispose(Boolean))
Public methodDownload(String, DirectoryInfo) Downloads the specified directory from the remote host to local directory.
Public methodDownload(String, FileInfo) Downloads the specified file from the remote host to local file.
Public methodDownload(String, Stream) Downloads the specified file from the remote host to the stream.
Public methodDownload(String, Stream, Boolean) Downloads the specified file from the remote host to the stream.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the BaseClient is reclaimed by garbage collection.
(Inherited from BaseClient)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConnected Called when client is connected to the server.
(Inherited from BaseClient)
Protected methodOnConnecting Called when client is connecting to the server.
(Inherited from BaseClient)
Protected methodOnDisconnected Called when client is disconnected from the server.
(Inherited from BaseClient)
Protected methodOnDisconnecting Called when client is disconnecting from the server.
(Inherited from BaseClient)
Public methodSendKeepAlive Sends keep-alive message to the server.
(Inherited from BaseClient)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUpload(DirectoryInfo, String) Uploads the specified directory to the remote host.
Public methodUpload(FileInfo, String) Uploads the specified file to the remote host.
Public methodUpload(Stream, String) Uploads the specified stream to the remote host.
Public methodUpload(Stream, String, Boolean) Uploads the specified stream to the remote host.
Top
Events
 NameDescription
Public eventDownloading Occurs when downloading file.
Public eventErrorOccurred Occurs when an error occurred.
(Inherited from BaseClient)
Public eventHostKeyReceived Occurs when host key received.
(Inherited from BaseClient)
Public eventUploading Occurs when uploading file.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also