Back to product page

State function


Holds the current state information.

Type

A Long value. If successful, 0 is returned, otherwise error as specified here

Syntax

  • C
long Sftp_GetState(void *Sftp, StatesEnum *pVal);
The State(void *Sftp,StatesEnum *pVal) syntax has these parts:
void *SftpHandle of the created Sftp instance.
StatesEnum *pValConstant value that represents the current state.

Remarks

The State function holds the state of the current connection between the wodSFTP component and the remote server. For each change of this state, the StateChange callback is invoked.

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

For a list of possible states, please see the StatesEnum page.

Platforms

Windows