wodSFTP API library - State Property
      
 

Description

Holds the current state information.


Return type

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


Syntax

long Sftp_GetState(void *Sftp, StatesEnum *pVal);

The State function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
StatesEnum *pVal Constant 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.