Back to product page

State property


Holds current state information.

Type

A StatesEnum enumeration.

Syntax

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

Remarks

The State property holds the current connection state between the wodSSHTunnel component and the remote server. For each change of this state, the StateChange event is fired. A list of all possible states can be found on the StatesEnum page.

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

Platforms

Windows