edtFTPnet/PRO - Secure FTP component for .NET | Free Trial | Pricing

The SSHFTPClient type exposes the following members.

Constructors

  NameDescription
Public methodSSHFTPClient
Default constructor.

Methods

  NameDescription
Public methodCancelResume
Cancel the resume. Use this method if something goes wrong and the server is left in an inconsistent state. Not used in SCP as resume is not supported
(Inherited from SSHSCPClient.)
Public methodCancelTransfer
Cancels the current transfer.
(Inherited from SSHSCPClient.)
Public methodCdUp
Change the remote working directory to parent
(Overrides SSHSCPClient..::..CdUp()()()().)
Public methodChangeGroup
Public methodChangeOwner
Public methodChDir
Change the remote working directory
(Overrides SSHSCPClient..::..ChDir(String).)
Protected methodCheckConnection
Checks if the client has connected to the server and throws an exception if it hasn't. This is only intended to be used by subclasses
(Inherited from SSHSCPClient.)
Protected methodCheckTimeout
Check to see if the timeout has expired
(Inherited from SSHSCPClient.)
Public methodChMod
Changes the access permissions or modes of the specified file or directory.
Protected methodCloseSocket (Inherited from SSHSCPClient.)
Public methodConnect
Establish a connection to the SFTP server
(Overrides SSHSCPClient..::..Connect()()()().)
Public methodCreateSymbolicLink
Create a symbolic link on the server
Public methodDelete
Delete the specified remote file.
(Overrides SSHSCPClient..::..Delete(String).)
Public methodDir()()()()
List current directory's contents as an array of strings of filenames.
(Overrides SSHSCPClient..::..Dir()()()().)
Public methodDir(String)
List a directory's contents as an array of strings of filenames.
(Overrides SSHSCPClient..::..Dir(String).)
Public methodDir(String, Boolean)
List a directory's contents as an array of strings.
(Overrides SSHSCPClient..::..Dir(String, Boolean).)
Public methodDirDetails()()()()
List the current directory's contents as an array of FTPFile objects.
(Overrides SSHSCPClient..::..DirDetails()()()().)
Public methodDirDetails(String)
List a directory's contents as an array of FTPFile objects.
(Overrides SSHSCPClient..::..DirDetails(String).)
Public methodDirDetails(String, FTPFileCallback) (Overrides SSHSCPClient..::..DirDetails(String, FTPFileCallback).)
Public methodDirDetails(String, Boolean)
Returns the given directory's contents and optionally that of its subdirectories as an array of FTPFile objects.
(Overrides SSHSCPClient..::..DirDetails(String, Boolean).)
Public methodEquals (Inherited from Object.)
Public methodExecuteCommand (Inherited from SSHSCPClient.)
Public methodExists
Checks for the existence of a file on the server.
(Overrides SSHSCPClient..::..Exists(String).)
Protected methodFinalize (Inherited from Object.)
Public methodGet(String)
Get data from the SFTP server.
(Inherited from SSHSCPClient.)
Public methodGet(String, String)
Get data from the SFTP server using the currently set transfer mode.
(Overrides SSHSCPClient..::..Get(String, String).)
Public methodGet(Stream, String)
Get data from the server
(Inherited from SSHSCPClient.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLocalCRC
Get the CRC-32 checksum for the named local file
(Inherited from SSHSCPClient.)
Public methodGetRemoteCRC
Get the CRC-32 checksum for the named remote file. Not supported in SFTP.
(Inherited from SSHSCPClient.)
Public methodGetSymbolicLinkTarget
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMkDir
Create the specified remote working directory.
(Overrides SSHSCPClient..::..MkDir(String).)
Public methodModTime
Get modification time for a remote file.
(Overrides SSHSCPClient..::..ModTime(String).)
Public methodMultipleDelete(String)
Delete multiple files in the current remote directory
(Overrides SSHSCPClient..::..MultipleDelete(String).)
Public methodMultipleDelete(FileFilter)
Delete multiple files in the current remote directory
(Overrides SSHSCPClient..::..MultipleDelete(FileFilter).)
Public methodMultipleDelete(String, FileFilter, Boolean)
Delete multiple files in the current remote directory and its subdirectories.
(Overrides SSHSCPClient..::..MultipleDelete(String, FileFilter, Boolean).)
Public methodMultipleDelete(String, String, Boolean)
Delete multiple files in the current remote directory and its subdirectories.
(Overrides SSHSCPClient..::..MultipleDelete(String, String, Boolean).)
Public methodMultipleDeleteDirectories
Remove a remote directory, and all its files and its subdirectories
(Overrides SSHSCPClient..::..MultipleDeleteDirectories(String).)
Public methodMultipleGet(String, FileFilter)
Get multiple files into the specified local directory from the current remote directory
(Overrides SSHSCPClient..::..MultipleGet(String, FileFilter).)
Public methodMultipleGet(String, String)
Get multiple files into the specified local directory from the current remote directory
(Overrides SSHSCPClient..::..MultipleGet(String, String).)
Public methodMultipleGet(String, String, FileFilter, Boolean)
Get multiple files from the specified remote directory into the specified local directory
(Overrides SSHSCPClient..::..MultipleGet(String, String, FileFilter, Boolean).)
Public methodMultipleGet(String, String, String, Boolean)
Get multiple files from the specified remote directory into the specified local directory
(Overrides SSHSCPClient..::..MultipleGet(String, String, String, Boolean).)
Public methodMultiplePut(String, FileFilter)
Put multiple files from the specified local directory into the current remote directory
(Overrides SSHSCPClient..::..MultiplePut(String, FileFilter).)
Public methodMultiplePut(String, String)
Put multiple files from the specified local directory into the current remote directory
(Overrides SSHSCPClient..::..MultiplePut(String, String).)
Public methodMultiplePut(String, String, FileFilter, Boolean)
Put multiple files from the specified local directory into the specified remote directory
(Overrides SSHSCPClient..::..MultiplePut(String, String, FileFilter, Boolean).)
Public methodMultiplePut(String, String, String, Boolean)
Put multiple files from the specified local directory into the specified remote directory
(Overrides SSHSCPClient..::..MultiplePut(String, String, String, Boolean).)
Protected methodOnBytesTransferred (Inherited from SSHSCPClient.)
Protected methodOnCommandSent (Inherited from SSHSCPClient.)
Protected methodOnReplyReceived (Inherited from SSHSCPClient.)
Protected methodOnTransferCancelled (Inherited from SSHSCPClient.)
Protected methodOnTransferCompleteEx (Inherited from SSHSCPClient.)
Protected methodOnTransferStartedEx (Inherited from SSHSCPClient.)
Public methodPut(array<Byte>[]()[][], String)
Put data onto the SFTP server in the current directory.
(Overrides SSHSCPClient..::..Put(array<Byte>[]()[][], String).)
Public methodPut(Stream, String)
Put a stream of data onto the FTP server in the current directory.
(Overrides SSHSCPClient..::..Put(Stream, String).)
Public methodPut(String, String)
Put a local file onto the SFTP server in the current directory.
(Overrides SSHSCPClient..::..Put(String, String).)
Public methodPut(array<Byte>[]()[][], String, Boolean)
Put data onto the SFTP server in the current directory. Allows appending if current file exists.
(Overrides SSHSCPClient..::..Put(array<Byte>[]()[][], String, Boolean).)
Public methodPut(Stream, String, Boolean)
Put a stream of data onto the FTP server in the current directory. Allows appending if current file exists
(Overrides SSHSCPClient..::..Put(Stream, String, Boolean).)
Public methodPut(String, String, Boolean)
Upload a local file to the server
(Overrides SSHSCPClient..::..Put(String, String, Boolean).)
Public methodPwd
Get the current remote working directory
(Overrides SSHSCPClient..::..Pwd()()()().)
Public methodQuit
Quit the session
(Overrides SSHSCPClient..::..Quit()()()().)
Public methodQuitImmediately
Quit the session immediately. Just close the socket. Don't send any messages to the server.
(Overrides SSHSCPClient..::..QuitImmediately()()()().)
Public methodRename
Rename a remote file
(Overrides SSHSCPClient..::..Rename(String, String).)
Public methodResume
Make the next file transfer (put or get) resume.
(Overrides SSHSCPClient..::..Resume()()()().)
Public methodResumeDownload
Make the next download resume at a specific point.
(Overrides SSHSCPClient..::..ResumeDownload(Int64).)
Public methodRmDir
Remove a directory
(Overrides SSHSCPClient..::..RmDir(String).)
Public methodSetModTime
Set modification time for a remote file.
(Overrides SSHSCPClient..::..SetModTime(String, DateTime).)
Public methodSize
Get the size of a remote file.
(Overrides SSHSCPClient..::..Size(String).)
Public methodTestConnection
Tests the connection
(Overrides SSHSCPClient..::..TestConnection()()()().)
Public methodToString (Inherited from Object.)
Public methodUnlock
Unlock the software for use. This method should be used when a configuration file isn't available
(Inherited from SSHSCPClient.)

Fields

  NameDescription
Protected field_proxySettings
Proxy settings
(Inherited from SSHSCPClient.)
Protected fieldcancelTransfer
Can be used to cancel a transfer
(Inherited from SSHSCPClient.)
Protected fieldcloseStreamsAfterTransfer
If true then streams are closed after a transfer has completed.
(Inherited from SSHSCPClient.)
Protected fieldcompatFlags
Configuration flags for non-compliant servers
(Inherited from SSHSCPClient.)
Protected fieldcompressionAlg
Compression algorithms
(Inherited from SSHSCPClient.)
Protected fieldcontrolPort (Inherited from SSHSCPClient.)
Protected fieldcwd
Current remote working directory
(Inherited from SSHSCPClient.)
Public fieldStatic memberDEFAULT_PERMISSIONS
Default value of umask.
Public fieldStatic memberDEFAULT_UMASK
Default value of umask.
Protected fielddeleteOnFailure
If a download to a file fails, delete the partial file
(Inherited from SSHSCPClient.)
Protected fielddetectTransferMode
Do we detect transfer mode when transferring files?
(Inherited from SSHSCPClient.)
Protected fieldkey
License key
(Inherited from SSHSCPClient.)
Protected fieldknownHostsManager
Manages the list of known hosts
(Inherited from SSHSCPClient.)
Protected fieldlastBytesTransferred
Holds the number of bytes transferred in that most recent transfer.
(Inherited from SSHSCPClient.)
Protected fieldlastFileTransferred
Name of the last file transferred.
(Inherited from SSHSCPClient.)
Protected fieldlogTag
Logging tag
(Inherited from SSHSCPClient.)
Protected fieldmonitorInterval
Bytes transferred in between monitor callbacks
(Inherited from SSHSCPClient.)
Protected fieldowner
License owner
(Inherited from SSHSCPClient.)
Protected fieldprompts
List of authorization prompts
(Inherited from SSHSCPClient.)
Protected fieldremoteHost
Remote host we are connecting to
(Inherited from SSHSCPClient.)
Protected fieldremoteIPAddress
IP address of remote host in string form
(Inherited from SSHSCPClient.)
Protected fieldresume
If true, a file transfer is being resumed
(Inherited from SSHSCPClient.)
Protected fieldserverValidation
Determines how the remote host is validated
(Inherited from SSHSCPClient.)
Protected fieldsocket (Inherited from SSHSCPClient.)
Protected fieldsocks
SOCKS settings
(Inherited from SSHSCPClient.)
Protected fieldthrottler
Threshold for throttling
(Inherited from SSHSCPClient.)
Protected fieldtimeout
Timeout in milliseconds
(Inherited from SSHSCPClient.)
Protected fieldtransferBufferSize
Size of transfer buffers
(Inherited from SSHSCPClient.)
Protected fieldtransferNotifyListings
Should BytesTransferred event be triggered in directory listings?
(Inherited from SSHSCPClient.)
Protected fieldtransferType
Record of the transfer type - make the default BINARY
(Inherited from SSHSCPClient.)

Properties

  NameDescription
Public propertyAuthenticationMethod
Get or set the current authentication method being used.
(Inherited from SSHSCPClient.)
Public propertyClientPrivateKeyBytes (Inherited from SSHSCPClient.)
Public propertyClientPrivateKeyFile
Path of the private key file used to authenticate the client
(Inherited from SSHSCPClient.)
Public propertyClientPrivateKeyPassphrase
Passphrase of the private key file.
(Inherited from SSHSCPClient.)
Public propertyCloseStreamsAfterTransfer
If true then streams are closed after a transfer has completed.
(Inherited from SSHSCPClient.)
Public propertyControlPort
The port on the server to which to connect the control-channel.
(Inherited from SSHSCPClient.)
Public propertyCountBeforeSleep
Number of transfers before going to sleep
Public propertyDefaultPermissions
Set and get the default file creation mode permissions (in octal).
Public propertyDeleteOnFailure
Controls whether or not a file is deleted when a failure occurs.
(Inherited from SSHSCPClient.)
Public propertyDetectTransferMode
If set to true, the transfer mode in operations involving multiple files is automatically changed between ASCII and binary as appropriate.
(Overrides SSHSCPClient..::..DetectTransferMode.)
Public propertyFilenameEncoding
The character-encoding to use for file and directory names.
Public propertyIsConnected
Indicates whether the client is currently connected with the server.
(Overrides SSHSCPClient..::..IsConnected.)
Public propertyIsResuming
Returns true if the next transfer is to be resumed (i.e. Resume()()()() has been called).
(Inherited from SSHSCPClient.)
Public propertyKBIPrompts
Array of prompts used for keyboard interactive (KBI) authentication.
(Overrides SSHSCPClient..::..KBIPrompts.)
Public propertyKnownHosts
Manager of the list of known hosts used to authenticate the server.
(Inherited from SSHSCPClient.)
Public propertyLastBytesTransferred
The number of bytes transferred in the last transfer operation.
(Inherited from SSHSCPClient.)
Public propertyLastFileTransferred
The remote name/path of the last file transferred.
(Inherited from SSHSCPClient.)
Public propertyLicenseKey
The license key string.
(Inherited from SSHSCPClient.)
Public propertyLicenseOwner
The license owner string.
(Inherited from SSHSCPClient.)
Public propertyLogTag
Log tag
(Inherited from SSHSCPClient.)
Public propertyMaxPacketSize
The SSH maximum packet size.
(Inherited from SSHSCPClient.)
Public propertyMaxTransferRate
The maximum transfer rate in bytes per sec
(Inherited from SSHSCPClient.)
Public propertyParallelTransferMode
Uploads are by default in parallel mode, which is faster than serial mode. This mode can be switched off if servers are unable to deal with parallel mode.
Public propertyPassword
Password of account on the server or the passphrase of the private key file.
(Inherited from SSHSCPClient.)
Public propertyPreferredCipherAlgorithms
Preferred algorithm(s) to use for encryption.
(Inherited from SSHSCPClient.)
Public propertyPreferredCompressionAlgorithms
Preferred algorithm(s) to use for data compression
(Inherited from SSHSCPClient.)
Public propertyPreferredHostKeyAlgorithms
Preferred algorithm(s) to use for server authentication via public key
(Inherited from SSHSCPClient.)
Public propertyPreferredKeyExchangeMethods
Preferred methods to use for key exchange.
(Inherited from SSHSCPClient.)
Public propertyPreferredMACAlgorithms
Preferred MAC algorithm(s)
(Inherited from SSHSCPClient.)
Public propertyProxySettings
Settings for using proxies.
(Inherited from SSHSCPClient.)
Public propertyRemoteHost
The domain-name or IP address of the SFTP server.
(Inherited from SSHSCPClient.)
Public propertyRetryAuth
By default, authentication is retried automatically using a different method if it fails.
(Inherited from SSHSCPClient.)
Public propertySendInitialWindowAdjust
Determines whether a SSH_MSG_CHANNEL_WINDOW_ADJUST message should be sent initially (true by default).
(Inherited from SSHSCPClient.)
Public propertyServerCompatibility
Controls various server compatibility features.
(Inherited from SSHSCPClient.)
Public propertyServerValidation
Controls the way in which remote servers are validated.
(Inherited from SSHSCPClient.)
Public propertyShowHiddenFiles
Include hidden files in operations that involve listing of directories, and if supported by the server. Not supported in SFTP.
(Inherited from SSHSCPClient.)
Public propertySleepEnabled
Enabling or not of sleeping after a certain number of transfers
Public propertySleepTime
Number of seconds spent asleep
Public propertySocksContext Obsolete.
Controls SOCKS integration.
(Inherited from SSHSCPClient.)
Public propertyTimeout
Overall timeout in milliseconds for waiting for messages and underlying timeouts on sockets.
(Overrides SSHSCPClient..::..Timeout.)
Public propertyTransferBufferSize
The size of the buffers (in bytes) used in writing to and reading from the data-sockets.
(Inherited from SSHSCPClient.)
Public propertyTransferNotifyInterval
The number of bytes transferred between each notification of the BytesTransferred event.
(Inherited from SSHSCPClient.)
Public propertyTransferNotifyListings
By default the BytesTransferred event is not triggered during directory listings - this property can be used to enable this behaviour.
(Inherited from SSHSCPClient.)
Public propertyTransferType
The current file transfer type (BINARY or ASCII).
(Overrides SSHSCPClient..::..TransferType.)
Public propertyUMask
Set and get the umask, the file creation mode mask that is applied to the default permissions to create the final permission set.
Public propertyUserName
User-name of account on the server.
(Inherited from SSHSCPClient.)
Public propertyWelcomeMessage
Server's banner.
(Inherited from SSHSCPClient.)
Public propertyWindowSize
The SSH window size.
(Inherited from SSHSCPClient.)

Events

  NameDescription
Public eventBytesTransferred
Event triggered every time TransferNotifyInterval bytes transferred.
(Inherited from SSHSCPClient.)
Public eventCommandSent
Triggered every time a command is sent to the server.
(Inherited from SSHSCPClient.)
Public eventReplyReceived
Triggered every time a logical reply is received from the server. In SFTP this will NOT be triggered for every packet that arrives.
(Inherited from SSHSCPClient.)
Public eventTransferCancelled
Notifies of the cancellation of a transfer
(Inherited from SSHSCPClient.)
Public eventTransferCompleteEx
Notifies of the completion of a transfer
(Inherited from SSHSCPClient.)
Public eventTransferStartedEx
Notifies of the start of a transfer
(Inherited from SSHSCPClient.)
Public eventValidatingServer
Notifies that the server must be validated
(Inherited from SSHSCPClient.)

See Also