State Property

Gets a value that reflects the current TCP connection state and SSH authentication state.

Syntax

'Declaration
 
Public ReadOnly Property State As ConnectionState

'Usage
 
Dim instance As SshConnection
Dim value As ConnectionState
 
value = instance.State

public ConnectionState State {get;}

public: __property ConnectionState get_State();

public:
property ConnectionState State {
   ConnectionState get();
}

Remarks

If this property returns ConnectionState.ConnectedAndPartiallyAuthenticated, Connection.GetRemainingAuthMethods may be used to get a list of the authentication methods your server supports at the current stage of the authentication process.

The calling application can be notified of a change in this value by registering a delegate with the StateChanged event.