Xceed Logo
Shop
Xceed .NET Libraries Documentation
[Root] / Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SFtpClient Class


In This Topic
    SFtpClient Class
    In This Topic
    Object Model
    SFtpClient ClassSSHConnectionProtocolChannel ClassAttrs ClassAttrs ClassAttrs ClassSFtpStream ClassSFtpStream ClassSFtp ClassSSHClient Class
    Syntax
    'Declaration
 

    Public Class SFtpClient 
    'Usage
 

    Dim instance As SFtpClient
    public class SFtpClient
    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Client.SFtpClient

    Public Constructors
     NameDescription
    Public ConstructorSFtpClient Constructor TODODOC  
    Top
    Public Fields
     NameDescription
    Public FieldDefaultMaximumReceivePacketSize  
    Public FieldDefaultReadFileShareA constant System.IO.FileShare value that represents the default file sharing options to use when opening remote SFtp files for reading.  
    Public FieldDefaultWriteFileShareA constant System.IO.FileShare value that represents the default file sharing options to use when opening remote SFtp files for writing.  
    Top
    Protected Fields
     NameDescription
    Protected FieldAbsoluteHomePathInternal  
    Protected FieldChannelInternal  
    Protected FieldConnectionProtocolInternal  
    Protected FieldLocalWindowAdjustmentThresholdInternal  
    Protected FieldLocalWindowInitialSizeInternal  
    Protected FieldLocalWindowTargetSizeInternal  
    Protected FieldMaximumReceivePacketSizeInternal  
    Protected FieldPacketIOManagerInternal  
    Protected FieldSFtpInternal  
    Protected FieldSFTPPacketIOManagerInternal  
    Protected FieldSshClientInternal  
    Protected FieldSupportsUidGidNamesFromIDInternal  
    Top
    Public Properties
     NameDescription
    Public PropertyChannel  
    Public PropertyConnected TODODOC  
    Public PropertyLocalWindowAdjustmentThreshold  
    Public PropertyLocalWindowInitialSize  
    Public PropertyLocalWindowTargetSize  
    Public PropertyMaximumReceivePacketSize  
    Public PropertySFtp  
    Public PropertySFtpClientProtocolVersion  
    Public PropertySFtpServerProtocolVersion  
    Public PropertySSHClient  
    Public PropertySupportsUidGidNames  
    Top
    Public Methods
     NameDescription
    Public MethodCloseHandle  
    Public MethodConnectOverloaded.   
    Public MethodCreateDirectory  
    Public MethodCreateFile  
    Public MethodDisconnect TODODOC  
    Public MethodDownloadFileOverloaded.   
    Public MethodFileExistsOverloaded.   
    Public MethodFillItemUidGidName  
    Public MethodFolderExistsOverloaded.   
    Public MethodGetFileAttributes  
    Public MethodGetFolderAttributes  
    Public MethodGetHandleAttributes  
    Public MethodGetRealPath  
    Public MethodOpenReadHandleOverloaded.   
    Public MethodOpenReadStreamOverloaded.   
    Public MethodOpenWriteHandleOverloaded.   
    Public MethodOpenWriteStreamOverloaded.   
    Public MethodReadDirectory  
    Public MethodReadFile  
    Public MethodReceiveRequestPayloadOverloaded.   
    Public MethodRemoveDirectory  
    Public MethodRemoveFile  
    Public MethodRenameItemOverloaded.   
    Public MethodSetFileAttributes  
    Public MethodSetFolderAttributes  
    Public MethodSetItemAttributes  
    Public Methodstatic (Shared in Visual Basic)ToFileSystemDirectory  
    Public Methodstatic (Shared in Visual Basic)ToFileSystemPath  
    Public Methodstatic (Shared in Visual Basic)ToSftpDirectory  
    Public Methodstatic (Shared in Visual Basic)ToSftpPath  
    Public MethodUploadFileOverloaded.   
    Public MethodValidateConnection  
    Public MethodWriteFile  
    Top
    Protected Methods
     NameDescription
    Protected MethodOnInitializingSFtpReadStream  
    Top
    Public Events
     NameDescription
    Public EventInitializingSFtpReadStream TODODOC  
    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

    SFtpClient Members
    Xceed.SSH.Client Namespace

    Send Feedback