Xceed .NET Libraries Documentation
Xceed.SSH.SFtp Assembly / Xceed.SSH.SFtp Namespace / GetFileAttributesPayload Class


In This Topic
    GetFileAttributesPayload Class
    In This Topic
    SFTP Version 6: 8.5. Retrieving File Attributes byte SSH_FXP_STAT uint32 request-id string path [UTF-8] uint32 flags where 'request-id' is the request identifier, and 'path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS. The flags field specify the attribute flags in which the client has particular interest. This is a hint to the server. For example, because retrieving owner / group and acl information can be an expensive operation under some operating systems, the server may choose not to retrieve this information unless the client expresses a specific interest in it. The client has no guarantee the server will provide all the fields that it has expressed an interest in. SFTP Version 3: 6.8 Retrieving File Attributes uint32 id string path where `id' is the request identifier, and `path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS.
    Object Model
    GetFileAttributesPayload ClassSFtp Class
    Syntax
    'Declaration
     
    
    Public Class GetFileAttributesPayload 
       Inherits SFtpPayload
       Implements IRequiresSFtp 
    'Usage
     
    
    Dim instance As GetFileAttributesPayload
    public class GetFileAttributesPayload : SFtpPayload, IRequiresSFtp  
    Inheritance Hierarchy

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

    Public Constructors
     NameDescription
    Public ConstructorSFTP Version 6: 8.5. Retrieving File Attributes byte SSH_FXP_STAT uint32 request-id string path [UTF-8] uint32 flags where 'request-id' is the request identifier, and 'path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS. The flags field specify the attribute flags in which the client has particular interest. This is a hint to the server. For example, because retrieving owner / group and acl information can be an expensive operation under some operating systems, the server may choose not to retrieve this information unless the client expresses a specific interest in it. The client has no guarantee the server will provide all the fields that it has expressed an interest in. SFTP Version 3: 6.8 Retrieving File Attributes uint32 id string path where `id' is the request identifier, and `path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS.  
    Top
    Public Fields
     NameDescription
    Public Field  
    Public Field (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public Field  
    Public Field  
    Public Field (Inherited from Xceed.SSH.SFtp.SFtpPayload)
    Top
    Protected Fields
     NameDescription
    Protected Field  
    Top
    Public Properties
     NameDescription
    Public PropertyOverridden.   
    Public Property  
    Top
    Public Methods
     NameDescription
    Public Method (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public MethodOverloaded.  (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public MethodOverloaded.  (Inherited from Xceed.SSH.Core.SSHPayload)
    Public Method (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public Method (Inherited from Xceed.SSH.Core.SSHPacketPayload)
    Public Method (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public MethodOverloaded.  (Inherited from Xceed.SSH.Core.SSHPayload)
    Top
    Protected Methods
     NameDescription
    Protected MethodOverridden.   
    Protected MethodOverridden.   
    Protected MethodOverridden.   
    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