StateText method
Provides string expression of a state.
Type
A String value. Text explanation of requested state.Syntax
object.StateText (StateID)
The StateText(object,StateID) syntax has these parts:
| object | An expression evaluating to an object of type wodSSHD. |
| StateID | Required. A SSHStates enumeration, as described in settings. Represents some state. |
Remarks
| Constant | Value | Description |
| Disconnected | 0 | Disconnected from server. |
| Connecting | 1 | Connecting to server. |
| Negotiating | 2 | Negotiating encryption algorithms. |
| Connected | 3 | Connected to server - idle. |
| Sending | 4 | 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.
Back to product page