Table of Contents

Class Shell

Namespace
Renci.SshNet
Assembly
Renci.SshNet.dll

Represents instance of the SSH shell object.

public class Shell : IDisposable

Inheritance

Implements

Inherited Members

Properties

IsStarted

Gets a value indicating whether this shell is started.

public bool IsStarted { get; }

Property Value

bool

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Start()

Starts this shell.

public void Start()

Exceptions

SshException

Shell is started.

SshException

The pseudo-terminal request was not accepted by the server.

SshException

The request to start a shell was not accepted by the server.

Stop()

Stops this shell.

public void Stop()

Exceptions

SshException

Shell is not started.

ErrorOccurred

Occurs when an error occurred.

public event EventHandler<ExceptionEventArgs> ErrorOccurred

Event Type

EventHandler<ExceptionEventArgs>

Started

Occurs when shell is started.

public event EventHandler<EventArgs> Started

Event Type

EventHandler<EventArgs>

Starting

Occurs when shell is starting.

public event EventHandler<EventArgs> Starting

Event Type

EventHandler<EventArgs>

Stopped

Occurs when shell is stopped.

public event EventHandler<EventArgs> Stopped

Event Type

EventHandler<EventArgs>

Stopping

Occurs when shell is stopping.

public event EventHandler<EventArgs> Stopping

Event Type

EventHandler<EventArgs>