The Sftp type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
Sftp()()()() |
Creates a new SFTP client instance.
|
![]() |
Sftp(DirectoryInfo) |
Creates a new SFTP client instance
|
![]() |
Sftp(SshParameters) |
Creates a new SFTP client instance with current application
directory.
|
![]() |
Sftp(SshParameters, DirectoryInfo) |
Creates a new SFTP client instance
|
![]() |
Sftp(String, String, String) |
Creates a new SFTP client instance with defaut SSH port(22) and current application
directory.
|
![]() |
Sftp(String, String, String, DirectoryInfo) |
Creates a new SFTP client instance with defaut SSH port(22).
|
Methods
Name | Description | |
---|---|---|
![]() |
AddProtocol |
Adds the protocol instance to the client.
|
![]() |
Connect |
Establishes the connection with SFTP server.
|
![]() |
DeleteDir(String) |
Deletes directory from SFTP server.
|
![]() |
DeleteDir(String, Boolean) |
Deletes directory from SFTP server.
|
![]() |
DeleteFile |
Deletes file from SFTP server.
|
![]() |
Disconnect |
Disconnects from the remote host.
|
![]() |
Download(String) |
Downloads the specified file and stores in the current local directory.
|
![]() |
Download(Stream, String) |
Downloads the specified file to the output stream.
|
![]() |
Download(String, String) |
Downloads the specified remote file and stores as specified local file in current local directory.
|
![]() |
DownloadDir |
Downloads the remote 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.) |
![]() |
GetDirListing()()()() |
Returns the remote directory entries enumerator.
|
![]() |
GetDirListing(String) |
Returns the remote directory entries enumerator.
|
![]() |
GetDirListing(String, RegexOptions) |
Returns the remote directory entries enumerator.
|
![]() |
GetDirListingAsString()()()() |
Returns the remote directory content packed in one string.
|
![]() |
GetDirListingAsString(String) |
Returns the remote directory content packed in one string.
|
![]() |
GetDirListingAsString(String, RegexOptions) |
Returns the remote directory content packed in one string.
|
![]() |
GetFilePermissions |
Gets remote file permissions in UNIX chmod format (644, 777).
|
![]() |
GetFileSize |
Returns the file size in bytes.
|
![]() |
GetFileTimestamp |
Returns the file modification time as DateTime object.
|
![]() |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
![]() |
GetInputStream |
Gets an
![]() InputStream |
![]() |
GetLocalDirListing()()()() |
Gets local directory listing.
|
![]() |
GetLocalDirListing(String) |
Gets local directory listing.
|
![]() |
GetNameListing()()()() |
Returns the remote directory content names enumerator.
|
![]() |
GetNameListing(String) |
Returns the remote directory content names enumerator.
|
![]() |
GetOutputStream |
Gets an
![]() Stream |
![]() |
GetRealPath |
Returns real server path.
|
![]() |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
![]() |
IsValidPath |
Checks if path is valid, i.e. denotes existing file or directory.
|
![]() |
MakeDir |
Creates remote directory.
|
![]() |
MakeLocalDir |
Creates a local directory.
Directory is relative to current local directory.
|
![]() |
Mdownload(IEnumerator) |
Downloads multiple files.
|
![]() |
Mdownload(String) |
Downloads multiple files.
|
![]() |
Mdownload(String, RegexOptions) |
Downloads multiple files.
|
![]() |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
![]() |
Mupload(IEnumerator) |
Uploads multiple files.
|
![]() |
Mupload(String) |
Uploads multiple files.
|
![]() |
RemoveProtocol |
Removes the protocol from the client.
|
![]() |
RenameFile |
Renames remote file on SFTP server.
|
![]() |
ResumeDownload(String, Int64) |
Resumes the file download.
|
![]() |
ResumeDownload(String, String, Int64) |
Resumes the file download.
|
![]() |
ResumeUpload(FileInfo, Int64) |
Resumes the file upload.
|
![]() |
ResumeUpload(String, Int64) |
Resumes the file upload.
|
![]() |
SetAutoMode |
Sets the transfer mode to auto. Transfer mode will be automatically detected based on file extension and MIME type.
|
![]() |
SetBinaryMode |
Sets the transfer mode to binary.
|
![]() |
SetFilePermissions |
Sets file permissions.
|
![]() |
SetTextMode |
Sets the transfer mode to ASCII. This method works with servers supporting sftp protocol version 4 and above.
|
![]() |
Sftp_Closed | |
![]() |
ToString |
Returns a String that represents the current Object.
(Inherited from Object.) |
![]() |
Upload(FileInfo) |
Uploads the specified file.
|
![]() |
Upload(String) |
Uploads the specified file.
|
![]() |
Upload(array<Byte>[]()[][], String) |
Uploads the specified data to the remote file.
|
![]() |
Upload(FileInfo, String) |
Uploads the specified file.
|
![]() |
Upload(String, Boolean) |
Uploads the specified file.
|
![]() |
Upload(String, String) |
Uploads the specified file.
|
![]() |
Upload(array<Byte>[]()[][], String, Boolean) |
Uploads the specified data to the remote file.
|
![]() |
Upload(FileInfo, String, Boolean) |
Uploads the specified file.
|
![]() |
Upload(String, String, Boolean) |
Uploads the specified file.
|
![]() |
UploadDir |
Uploads the specified directory.
|
Properties
Name | Description | |
---|---|---|
![]() |
Configuration |
SSH connection configuration.
|
![]() |
CurrentVersion |
The current protocol version.
|
![]() |
Debug |
The client debug flag.
|
![]() |
DebugStream |
The debug stream.
|
![]() |
DownloadingBufferSize |
The downloading buffer size in bytes. Set to 0 for adaptive buffer size.
|
![]() |
HostKeys |
Gets SSH host keys for further use.
|
![]() |
Hostname |
The target server hostname.
|
![]() |
Interrupted |
The current transfer state.
|
![]() |
IsConnected |
Checks if the client is currently connected to the server.
|
![]() |
LicenseKey |
License key.
|
![]() |
LineTerminator |
Line terminator for text mode transfer.
|
![]() |
LocalDir |
The local directory.
|
![]() |
Parameters |
SSH parameters.
|
![]() |
Password |
The current user password.
|
![]() |
Port |
The target server port.
|
![]() |
PrivateKey |
The current user key file.
|
![]() |
ReaderEncoding |
Gets or sets the reader character encoding.
|
![]() |
RemoteDir |
The remote directory.
|
![]() |
TargetVersion |
The preffered protocol version.
|
![]() |
Timeout |
The connection timeout defined in milliseconds.
|
![]() |
UploadingBufferSize |
The uploading buffer size in bytes. Set to 0 for adaptive buffer size.
|
![]() |
UseAdaptiveConnect |
Adaptive connection flag. If true adaptive connection
will be taken in use.
|
![]() |
Username |
The current username.
|
![]() |
WriterEncoding |
Gets or sets the writer character encoding.
|
Events
Name | Description | |
---|---|---|
![]() |
SftpConnectedEvent |
Occurs after a successful connection to the SSH server.
|
![]() |
SftpDisconnectedEvent |
Occurs after disconnecting from the SSH server.
|
![]() |
SftpDownloadEvent |
Occurs after a file is downloaded.
|
![]() |
SftpListingEvent |
Occurs after a remote directory listing is performed.
|
![]() |
SftpProgressEvent |
Occurs periodically during a file transfer to mark it's progress.
|
![]() |
SftpUploadEvent |
Occurs after a file is uploaded.
|