Back to product page

StateChange method


Called when wodSSH changes its state.

Type

None

Syntax

  • Basic
object.StateChange Owner, OldState
The StateChange(object,Owner,OldState) syntax has these parts:
objectAn expression evaluating to an object of type IwodSSHNotify.
OwnerA wodSSHCom object.
OldStateA StatesEnum enumeration, as described in settings.

Remarks

The settings for OldState are:

Constant Value Description
Disconnected 0 Disconnected from server.
Connecting 1 Connecting to server.
LogonInProgress 2 Sending authentication data.
Connected 3 Connected to server - idle.
ReceivedPrompt 4 Received command prompt.
Receiving 5 Receiving data from server.
Sending 6 Sending data to server.


This method is called only if you implemented the IwodSSHNotify interface in your application, and the wodSSH.Notification property has received a reference to the instance of your implementation.

The StateChange event is fired each time wodSSH's internal state changes. Initially it is set to Disconnected. Once you initiate a new connection it will change to Connecting, etc..

Using this event you can see if there is something happening with wodSSH, or it is idle and waiting for your commands.

You can determine the current state using the State property.

Platforms

Windows