Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / ExecuteCommandSession Class


In This Topic
    ExecuteCommandSession Class
    In This Topic
    Class that represents the session with the SSH server that will execute a command on the server.
    Object Model
    ExecuteCommandSession ClassSSHConnectionProtocolChannel ClassSSHChannelExitSignal ClassSSHClient ClassISSHTraceWriter Interface
    Syntax
    'Declaration
     
    
    Public Class ExecuteCommandSession 
       Inherits InteractiveSession
       Implements System.IDisposable 
    'Usage
     
    
    Dim instance As ExecuteCommandSession
    public class ExecuteCommandSession : InteractiveSession, System.IDisposable  
    Remarks

    The FtpConnection class implements the System.IDisposable interface meaning that every FtpConnection object that is created should also be disposed of by calling the Dispose method or, in C#, creating the FtpConnection within a using block. If an instance of an FtpConnection object is not disposed of, connections with the FTP server may remain active until the FTP server times-out or the garbage-collector passes.

    The FtpConnection will create connections with the FTP server transparently and as necessary until it is disposed of or garbage-collected. To prevent connections with an FTP server from being kept alive, the CloseConnections method can be called. The CloseConnections method will close any connections that are not being used, however the FtpConnection instance will remain usable.

    To test if a connection with the specified FTP server is possible before the FtpConnection instance is passed to FtpFile or FtpFolder objects, the TestConnection method can be used. If a connection with an FTP server is not possible, exceptions will be thrown when trying to access properties of the FtpFile and/or FtpFolder instances.

    Example
    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Client.InteractiveSession
          Xceed.SSH.Client.ExecuteCommandSession

    Public Constructors
     NameDescription
    Public ConstructorOverloaded. Class that represents the session with the SSH server that will execute a command on the server.  
    Top
    Public Fields
    Public Properties
     NameDescription
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property  
    Public PropertyTODODOC (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public Property (Inherited from Xceed.SSH.Client.InteractiveSession)
    Public PropertyTODODOC Gets or sets a value, in milliseconds, indicating after what period of time an SSH operation should timeout.  
    Public PropertyTODODOC Gets or sets a value, in seconds, indicating after what period of time an SSH operation should timeout.  
    Public PropertyGets or sets the System.IO.TextWriter which will trace the communications between the client-side and the FTP server. (Inherited from Xceed.SSH.Client.InteractiveSession)
    Top
    Public Methods
    Public Events
     NameDescription
    Public Event  
    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