PowerTCP SSH and SFTP for .NET
Sftp Class Members
Properties  Methods  Events


The following tables list the members exposed by Sftp.

Public Constructors
 NameDescription
Public ConstructorSftp ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyAcceptAllHostKeysWhen true, all host keys are accepted if not overridden with HostKeyEventArgs.Verified. When false, the SshConnection.HostKey event must be used to verify host keys. (Inherited from Dart.Ssh.SshConnection)
Public PropertyAutoSetTime Gets or sets whether the modified time should be updated on a file after a Put or Get.  
Public PropertyConnection Gets the underlying Connection instance being used for server communications. (Inherited from Dart.Ssh.SshConnection)
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyDisableInnerExceptions Set to true to disable the use of Exception.InnerException. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyEncoding Character encoding used by the component. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyOptimizations Exposes properties used for optimizing file transfer speed.  
Public PropertyProtocolVersion Gets the negotiated SFTP protocol version.  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertyState Gets a value that reflects the current TCP connection state and SSH authentication state. (Inherited from Dart.Ssh.SshConnection)
Public PropertySynchronizingObject Gets or sets the object used to marshal data to the UI thread (for raising events). (Inherited from Dart.Ssh.ComponentBase)
Public PropertySyncRoot Gets an object that is used to synchronize access to the upper layer protocol in use. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyTag Gets or sets an object that stores any user data. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyThreadingModel Controls the threading model used by the component. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyTimeout Gets or sets the amount of time (in milliseconds) that the control will wait for a server response before throwing a timeout exception.  
Public PropertyWorkingDirectory Gets the fully specified working directory.  
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAbort Requests cancellation of any on-going copy operations.  
Public MethodAuthenticateOverloaded.  Performs 'keyboard-interactive' authentication. (Inherited from Dart.Ssh.SshConnection)
Public MethodChangeWorkingDirectory Changes the working directory.  
Public MethodCloseOverridden.  Closes this SFTP session.  
Public MethodConnectOverloaded. Connects to the SSH-2 server specified by Connection.RemoteEndPoint. (Inherited from Dart.Ssh.SshConnection)
Public MethodCreateDirectory Creates a new directory.  
Public MethodCreateLink Creates a symbolic link on the server. Creates a link "linkPath" that points to a target file or directory "targetPath".  
Public MethodCreateLocalPortForwarderOverloaded. Creates a new LocalPortForwarder. (Inherited from Dart.Ssh.SshConnection)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden.  Releases all resources associated with the object.  
Public MethodGetOverloaded.  Initiates a file copy from the remote server to the local client.  
Public MethodGetAttributes Gets the file attributes of a file. This method follows symbolic links on the server.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetTarget Gets the target of a symbolic link.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodList Lists the contents of a directory.  
Public MethodListEx Lists the contents of a directory for COM environments.  
Public MethodMarshalOverloaded.  Marshals a string and/or object to the UI thread and raises the UserState event. (Inherited from Dart.Ssh.ComponentBase)
Public MethodOnBannerRaises the SshConnection.Banner event. (Inherited from Dart.Ssh.SshConnection)
Public MethodOnChallengeRaises the SshConnection.Challenge event. (Inherited from Dart.Ssh.SshConnection)
Public MethodOnHostKeyRaises the SshConnection.HostKey event. (Inherited from Dart.Ssh.SshConnection)
Public MethodOnProgressRaises the Progress event.  
Public MethodPutOverloaded.  Initiates a file copy from the local client to the remote server.  
Public MethodRemove Removes a file.  
Public MethodRemoveDirectory Removes a directory and its subfolders and files.  
Public MethodRename Renames or moves a file or directory.  
Public MethodSetAttributes Modifies the attributes of a file. Used for operations such as changing the ownership, permissions or access times, as well as for truncating a file.  
Public MethodStart Starts a worker thread on which the specified delegate function executes.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Top
Protected Methods
 NameDescription
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnErrorRaises the Error event. (Inherited from Dart.Ssh.ComponentBase)
Protected MethodOnLog Raises the Log event. (Inherited from Dart.Ssh.SshConnection)
Protected MethodOnStateChangedOverridden. Overrides SshConnection.OnStateChanged.  
Protected MethodOnUserStateRaises the UserState event. (Inherited from Dart.Ssh.ComponentBase)
Top
Public Events
 NameDescription
Public EventBanner Raised when the server presents a banner during authentication. (Inherited from Dart.Ssh.SshConnection)
Public EventChallenge Raised when the server presents its challenges during 'keyboard-interactive' authentication. (Inherited from Dart.Ssh.SshConnection)
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventErrorRaised when Marshal(Exception) is used or an unhandled Exception is thrown in a worker thread created using Start. (Inherited from Dart.Ssh.ComponentBase)
Public EventHostKey Raised when the server presents its hostkey while establishing a connection. (Inherited from Dart.Ssh.SshConnection)
Public EventLog Used to log packet-level communications. (Inherited from Dart.Ssh.SshConnection)
Public EventProgress Occurs as each buffer of file data is sent or received.  
Public EventStateChanged Raised when the value of the State property changes, or a call to any Authenticate method returns. (Inherited from Dart.Ssh.SshConnection)
Public EventUserStateRaised when Marshal(String,Object) is used. (Inherited from Dart.Ssh.ComponentBase)
Top
See Also

Reference

Sftp Class
Dart.Ssh Namespace


PowerTCP SSH and SFTP for .NET Documentation Version 7.0
© 2023 Dart Communications. All Rights Reserved.
Send comments on this topic