The Scp type exposes the following members.

Constructors

  Name Description
Public method Scp()()()()
Creates a new client instance.
Public method Scp(SshParameters)
Creates a new client instance.
Public method Scp(SshParameters, SshConfiguration)
Creates a new client instance.

Methods

  Name Description
Public method Connect
Connects to the server.
Public method Disconnect
Disconnects from the server.
Public method Download(String, String)
Downloads the file from SSH server.
Public method Download(Stream, String, String)
Downloads file from SSH server and writes to specified output stream.
Public method DownloadDir
Downloads remote directory and contents recursively from SSH server. Downloads are stored relative to current local directory.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method Mdownload(String, IEnumerator)
Downloads specified files in current working remote directory from SSH server to local directory. Do not use this method to download a directory, see downloadDir(String) method. Downloads are stored relative to current local directory.
Public method Mdownload(String, String)
Downloads multiple files matching filter from SSH server's directory. Downloads are stored relative to current local directory. Valid filters may indicate that a file name ends with a or starts with a given string.

For example to download all files ending with the extension * .txt use the filter "*.txt". To download all files in the remote directory use the filter "*". To download all files that start with the string "file" use the filter "file*".

Public method Mdownload(String, array<String>[]()[][])
Downloads specified files in current working remote directory from SSH server to local directory. Do not use this method to download a directory, see downloadDir(String) method. Downloads are stored relative to current local directory.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Mupload(String, IEnumerator)
Uploads multiple files to SSH server. Uploads are performed relative to current local directory.
Public method Mupload(String, String)
Uploads multiple files matching filter to SSH server's current directory. Uploads are performed relative to current local directory. Wildcards may be used to specify multiple files e.g. *.txt
Public method Mupload(String, array<String>[]()[][])
Uploads multiple files to SSH server. Uploads are performed relative to current local directory.
Public method Mupload(String, String, RegexOptions)
Uploads multiple files matching filter to SSH server's current directory. Uploads are performed relative to current local directory. Wildcards may be used to specify multiple files e.g. *.txt
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public method Upload(FileInfo, String)
Uploads file to SSH server.
Public method Upload(String, String)
Uploads file to SSH server.
Public method Upload(array<Byte>[]()[][], String, String)
Uploads file to SSH server where contents of file is not on disk but in memory.
Public method Upload(FileInfo, String, String)
Uploads file to SSH server.
Public method Upload(Stream, String, String)
Uploads file to SSH server.
Public method Upload(String, String, String)
Uploads file to SSH server.
Public method UploadDir(DirectoryInfo, String)
Uploads the specified directory.
Public method UploadDir(DirectoryInfo, String, String)
Uploads the specified directory.

Properties

  Name Description
Public property Configuration
The SSH confguration.
Public property Connected
Connected flag.
Public property Debug
Debug property.
Public property DebugStream
The debug stream.
Public property DownloadingBufferSize
Download block size in bytes. Set 0 to adaptive buffer size.
Public property HostKeys
Gets SSH host keys for further use.
Public property Hostname
Server host/IP.
Public property LicenseKey
License key.
Public property LocalDir
Local directory.
Public property Parameters
The connection parameters.
Public property Password
The current user password.
Public property Port
Server port.
Public property PreserveTime
Preserve file time flag.
Public property PrivateKey
The current user key file.
Public property SurroudFilenameWithQuotes
Set this variable to surround filenames with double quotes. This is needed for some SCP servers.
Public property Timeout
The connection timeout defined in milliseconds.
Public property UploadingBufferSize
Upload block size in bytes. Set 0 to adaptive buffer size.
Public property Username
The current username.

Events

  Name Description
Public event ScpConnectedEvent
Occurs after a successful connection to the SSH server.
Public event ScpDisconnectedEvent
Occurs after disconnecting from the SSH server.
Public event ScpDownloadEvent
Occurs after a file is downloaded.
Public event ScpProgressEvent
Occurs periodically during a file transfer to mark it's progress.
Public event ScpUploadEvent
Occurs after a file is uploaded.

See Also