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


In This Topic
    StatusResponsePayload Class
    In This Topic
    Represents a response from the server to the client that contains a status code.
    Syntax
    'Declaration
 

    Public Class StatusResponsePayload 
   Inherits SFtpPayload
    'Usage
 

    Dim instance As StatusResponsePayload
    public class StatusResponsePayload : SFtpPayload
    Remarks

    After a request from the client, the server responds using one of a few response packets. All requests can return a SSH_FXP_STATUS response, which this class represents, upon failure. When an operation is successful, and no data needs to be returned, the SSH_FXP_STATUS response with SSH_FX_OK status is sent.

    An instance of this class is sometimes provided within exception classes as supplemental information to explain why an operation failed.

    Inheritance Hierarchy

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

    Public Constructors
     NameDescription
    Public ConstructorStatusResponsePayload ConstructorRepresents a response from the server to the client that contains a status code.  
    Top
    Public Fields
     NameDescription
    Public FieldCodeMachine readable status code indicating the result of the request.  
    Public FieldLanguageTagSpecifies the language the error message is in.  
    Public FieldLength (Inherited from Xceed.SSH.SFtp.SFtpPayloadBase)
    Public FieldMessageHuman readable description of the error.  
    Public FieldPacketType  
    Public FieldRequestID (Inherited from Xceed.SSH.SFtp.SFtpPayload)
    Top
    Public Properties
     NameDescription
    Public PropertyIDOverridden. Gets the type code for the packet payload.  
    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

    StatusResponsePayload Members
    Xceed.SSH.SFtp Namespace
    SFtpStatusResponseException Class

    Send Feedback