Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SFtpConnection Class


In This Topic
    SFtpConnection Class
    In This Topic
    This class has been renamed to SFtpSession. Please change the name in your code. The class functionality is the same. Only the class name has changed.
    Object Model
    SFtpConnection ClassSFtpClient ClassSSHClient Class
    Syntax
    'Declaration
 

    <ObsoleteAttribute("The SFtpConnection class has been renamed to SFtpSession. Please change the name in your code. The class functionality is the same. Only the class name has changed.")>
Public Class SFtpConnection 
   Inherits SFtpSession
   Implements System.IDisposable 
    'Usage
 

    Dim instance As SFtpConnection
    [Obsolete("The SFtpConnection class has been renamed to SFtpSession. Please change the name in your code. The class functionality is the same. Only the class name has changed.")]
public class SFtpConnection : SFtpSession, System.IDisposable
    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Client.SFtpSession
          Xceed.SSH.Client.SFtpConnection

    Public Constructors
     NameDescription
    Public ConstructorSFtpConnection ConstructorOverloaded. This class has been renamed to SFtpSession. Please change the name in your code. The class functionality is the same. Only the class name has changed.  
    Top
    Protected Fields
     NameDescription
    Protected FieldSftpClientInternalThe SFtpClient that uses this SFtpSession. (Inherited from Xceed.SSH.Client.SFtpSession)
    Protected FieldSshClientInternalThe SSHClient that uses this SFtpSession. (Inherited from Xceed.SSH.Client.SFtpSession)
    Protected FieldTraceWriterInternalThe System.IO.TextWriter which will trace the communications between the client-side and the SFTP server. (Inherited from Xceed.SSH.Client.SFtpSession)
    Top
    Public Properties
     NameDescription
    Public PropertyConnectedTODODOC (Inherited from Xceed.SSH.Client.SFtpSession)
    Public PropertySFtpClientGets the SFtpClient that uses this SFtpSession. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public PropertySFtpServerProtocolVersionGets a value that indicates the SFtp protocol version number that the SFtp server uses for the current session. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public PropertySshClientGets the SSHClient that uses this SFtpSession. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public PropertyTimeoutGets or sets a value, in seconds, indicating after what period of time an SFTP operation should timeout. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public PropertyTraceWriterGets or sets the System.IO.TextWriter which will trace the communications between the client-side and the SFTP server. (Inherited from Xceed.SSH.Client.SFtpSession)
    Top
    Public Methods
     NameDescription
    Public MethodComputeHostedFullNameComputes a human-readable full pathname starting with "sftp://hostname" representing the fully qualified path of all host files containing the item and the path of the item itself. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public MethodComputeStreamBufferSizeComputes the optimal buffer size for SFtp file transfers on the specified stream. (Inherited from Xceed.SSH.Client.SFtpSession)
    Public MethodConnectOverloaded.  (Inherited from Xceed.SSH.Client.SFtpSession)
    Public MethodDisconnect (Inherited from Xceed.SSH.Client.SFtpSession)
    Public MethodDisposeOverloaded. Releases all cached connections. (Inherited from Xceed.SSH.Client.SFtpSession)
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalizeAllows the SFtpSession object to attempt to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Xceed.SSH.Client.SFtpSession)
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    SFtpConnection Members
    Xceed.SSH.Client Namespace

    Send Feedback