Back to product page

State property


Holds the current state information.

Type

A StatesEnum enumeration. Holds current state.

Syntax

  • Basic
object.State
The State(object) syntax has these parts:
objectAn expression evaluating to an object of type wodSSH.

Remarks

The State property holds the state of the current connection between the wodSSH component and the remote server. For each change of this state, the StateChange event is fired.

To get a string expression that represents any state (not just one held in the State property) you can use the StateText property.

A list of all states can be found here.

Platforms

Windows