Back to product page

StateText method

Provides string expression of a state.


A String value. Text explanation of requested state.


  • Basic
object.StateText (StateID)  
The StateText(object,StateID) syntax has these parts:
objectAn expression evaluating to an object of type wodSSHD.
StateIDRequired. A SSHStates enumeration, as described in settings. Represents some state.


Constant Value Description
Disconnected0 Disconnected from server.
Connecting 1 Connecting to server.
Negotiating2 Negotiating encryption algorithms.
Connected 3 Connected to server - idle.
Sending4 Sending data to server.
Receiving 5 Receiving data from server.

StateText property will return text description of a value given by StateID argument. For a list of possible values, look here.