The Scp type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
Scp()()()() |
Creates a new client instance.
|
![]() |
Scp(SshParameters) |
Creates a new client instance.
|
![]() |
Scp(SshParameters, SshConfiguration) |
Creates a new client instance.
|
Methods
Name | Description | |
---|---|---|
![]() |
Connect |
Connects to the server.
|
![]() |
Disconnect |
Disconnects from the server.
|
![]() |
Download(String, String) |
Downloads the file from SSH server.
|
![]() |
Download(Stream, String, String) |
Downloads file from SSH server and writes to specified output stream.
|
![]() |
DownloadDir |
Downloads remote directory and contents recursively from SSH server. Downloads are stored relative to current
local directory.
|
![]() |
Equals |
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.) |
![]() |
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.) |
![]() |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
![]() |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
![]() |
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.
|
![]() |
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*".
|
![]() |
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.
|
![]() |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
![]() |
Mupload(String, IEnumerator) |
Uploads multiple files to SSH server. Uploads are performed relative to current local directory.
|
![]() |
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
|
![]() |
Mupload(String, array<String>[]()[][]) |
Uploads multiple files to SSH server. Uploads are performed relative to current local directory.
|
![]() |
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
|
![]() |
ToString |
Returns a String that represents the current Object.
(Inherited from Object.) |
![]() |
Upload(FileInfo, String) |
Uploads file to SSH server.
|
![]() |
Upload(String, String) |
Uploads file to SSH server.
|
![]() |
Upload(array<Byte>[]()[][], String, String) |
Uploads file to SSH server where contents of file is not on disk but in memory.
|
![]() |
Upload(FileInfo, String, String) |
Uploads file to SSH server.
|
![]() |
Upload(Stream, String, String) |
Uploads file to SSH server.
|
![]() |
Upload(String, String, String) |
Uploads file to SSH server.
|
![]() |
UploadDir(DirectoryInfo, String) |
Uploads the specified directory.
|
![]() |
UploadDir(DirectoryInfo, String, String) |
Uploads the specified directory.
|
Properties
Name | Description | |
---|---|---|
![]() |
Configuration |
The SSH confguration.
|
![]() |
Connected |
Connected flag.
|
![]() |
Debug |
Debug property.
|
![]() |
DebugStream |
The debug stream.
|
![]() |
DownloadingBufferSize |
Download block size in bytes. Set 0 to adaptive buffer size.
|
![]() |
HostKeys |
Gets SSH host keys for further use.
|
![]() |
Hostname |
Server host/IP.
|
![]() |
LicenseKey |
License key.
|
![]() |
LocalDir |
Local directory.
|
![]() |
Parameters |
The connection parameters.
|
![]() |
Password |
The current user password.
|
![]() |
Port |
Server port.
|
![]() |
PreserveTime |
Preserve file time flag.
|
![]() |
PrivateKey |
The current user key file.
|
![]() |
SurroudFilenameWithQuotes |
Set this variable to surround filenames with double quotes. This is needed for some SCP servers.
|
![]() |
Timeout |
The connection timeout defined in milliseconds.
|
![]() |
UploadingBufferSize |
Upload block size in bytes. Set 0 to adaptive buffer size.
|
![]() |
Username |
The current username.
|
Events
Name | Description | |
---|---|---|
![]() |
ScpConnectedEvent |
Occurs after a successful connection to the SSH server.
|
![]() |
ScpDisconnectedEvent |
Occurs after disconnecting from the SSH server.
|
![]() |
ScpDownloadEvent |
Occurs after a file is downloaded.
|
![]() |
ScpProgressEvent |
Occurs periodically during a file transfer to mark it's progress.
|
![]() |
ScpUploadEvent |
Occurs after a file is uploaded.
|