Back to product page

StateChange method


Called when wodSFTP 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 IwodSFTPNotify.
OwnerA wodSFTPCom object.
OldStateA StatesEnum enumeration, as described in settings. Holds previous state.

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.
Receiving 4 Receiving data from server.
Sending 5 Sending data to server.
Executing 6 Executing command on server.


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

The StateChange notification method is called each time wodSFTP changes its internal state. Initially it is set to Disconnected. Once you initiate a new connection, it will change to Connecting, etc..

Using this notification you can see if wodSFTP is doing something or it is idle and waiting for your commands.

You can determine the current state by using State property.

Platforms

Windows