Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.SSH.SFtp Assembly / Xceed.SSH.SFtp Namespace / ReadDirectoryPayload Class


In This Topic
    ReadDirectoryPayload Class
    In This Topic
    SFTP Version 6: 8.2.2. Reading Directories byte SSH_FXP_READDIR uint32 request-id string handle handle 'handle' is a handle returned by SSH_FXP_OPENDIR. If 'handle' is an ordinary file handle returned by SSH_FXP_OPEN, the server MUST return SSH_FX_INVALID_HANDLE. The server responds to this request with either a SSH_FXP_NAME or a SSH_FXP_STATUS message. One or more names may be returned at a time. Full status information is returned for each name in order to speed up typical directory listings. If there are no more names available to be read, the server MUST respond with a SSH_FXP_STATUS message with error code of SSH_FX_EOF.
    Syntax
    'Declaration
 

    Public Class ReadDirectoryPayload 
   Inherits SFtpPayload
    'Usage
 

    Dim instance As ReadDirectoryPayload
    public class ReadDirectoryPayload : SFtpPayload
    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Core.SSHPayload
          Xceed.SSH.Core.SSHPacketPayload
             Xceed.SSH.SFtp.SFtpPayloadBase
                Xceed.SSH.SFtp.SFtpPayload
                   Xceed.SSH.SFtp.ReadDirectoryPayload

    Public Constructors
     NameDescription
    Public ConstructorReadDirectoryPayload ConstructorSFTP Version 6: 8.2.2. Reading Directories byte SSH_FXP_READDIR uint32 request-id string handle handle 'handle' is a handle returned by SSH_FXP_OPENDIR. If 'handle' is an ordinary file handle returned by SSH_FXP_OPEN, the server MUST return SSH_FX_INVALID_HANDLE. The server responds to this request with either a SSH_FXP_NAME or a SSH_FXP_STATUS message. One or more names may be returned at a time. Full status information is returned for each name in order to speed up typical directory listings. If there are no more names available to be read, the server MUST respond with a SSH_FXP_STATUS message with error code of SSH_FX_EOF.  
    Top
    Public Fields
     NameDescription
    Public FieldHandle  
    Public FieldLength (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public FieldPacketType  
    Public FieldRequestID (Inherited from Xceed.SSH.SFtp.SFtpPayload)
    Top
    Public Properties
     NameDescription
    Public PropertyIDOverridden.   
    Top
    Public Methods
     NameDescription
    Public MethodGetCurrentSize (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public MethodReadOverloaded.  (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public MethodReadPayloadOverloaded.  (Inherited from Xceed.SSH.Core.SSHPayload)
    Public MethodSetID (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public MethodSetPacketLength (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public MethodWrite (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public MethodWritePayloadOverloaded.  (Inherited from Xceed.SSH.Core.SSHPayload)
    Top
    Protected Methods
     NameDescription
    Protected MethodDoGetCurrentSizeOverridden.   
    Protected MethodDoReadOverridden.   
    Protected MethodDoWriteOverridden.   
    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

    ReadDirectoryPayload Members
    Xceed.SSH.SFtp Namespace

    Send Feedback