wodSFTP API library - wodSFTP Object
    
 
Description

wodSFTP API library.


Members
You should prefix all member functions listed below with 'Sftp_'.

Construction/destruction functions
Create Creates and initializes a new instance of the wodSFTP client.
Destroy Destroys an instance of the wodSFTP client.

Method functions
Abort Aborts the current method.
About Displays the About box.
AppendData Appends data from a string variable to a remote file.
AppendDataLen Appends data from a fixed-size buffer to a remote file.
AppendFile Appends to a remote file.
Connect Connects to a remote server.
DeleteFile Deletes file on the server.
DeleteFiles Deletes multiple files in a sequence, recursive.
Disconnect Disconnects from the remote server.
ExtendedCmd Sends extended command to the server.
GetAttributes Retrieves file or folder attributes.
GetData Retrieves the contents of a remote file to a string variable
GetDataAt Retrieves the contents of a remote file to a string variable, starting from a given position.
GetDataToBuffer Retrieves the contents of a remote file to a locally specified buffer.
GetDataToBufferAt Retrieves the contents of a remote file to a locally specified buffer, starting from a given position.
GetFile Receives a file from the server.
GetFileAt Receives a file from the server, starting from a given position.
GetFiles Downloads multiple files in a sequence, recursive.
ListAttributes Lists the contents of a directory as a structure.
ListDir Lists the contents of a directory on the server.
ListNames Lists file and folder names in a directory on the server.
LoadPrivateKey Loads a private key from external file.
LoopFiles Loops through multiple files in a sequence, recursive, giving their names.
MakeDir Creates a directory on the server.
PutData Stores data from a string variable to a remote file.
PutDataAt Stores data from a string variable to a remote file, at a given position.
PutDataLen Stores data from a fixed-size buffer to a remote file.
PutDataLenAt Stores data from a fixed-size buffer to a remote file, at a given position.
PutFile Sends a file to the server.
PutFileAt Sends a file to the server, appending it at a given position.
PutFiles Uploads multiple files in a sequence, recursive.
RealPath Retrieves the real path for a symbolic link.
RemoteClose Closes remote file.
RemoteOpen Opens remote file for raw access.
RemoteRead Reads from remote file.
RemoteWrite Writes to remote file.
RemoveDir Removes a directory from the server.
Rename Renames a file or directory on the server.
SetAttributes Sets attributes for a file or folder
 

You should prefix all the following properties with 'Sftp_Get' or 'Sftp_Set'.

Property functions
Authentication Read-write property Determines which authentication type is used.
Blocking Read-write property Determines whether methods are blocking.
BufferSize Read-write property Determines the size of incoming and outgoing buffers.
Compression Read-write property Determines the level of compression used.
Encryption Read-write property Determines the encryption algorithm to be used with the SSH layer.
ErrorText Read-only property Provides a string expression describing an error.
Extensions Read-only property Holds list of extensions supported by the server.
FIPS Read-write property Specifies FIPS enabled libeay32.dll to load.
Hostname Read-write property Determines the Hostname of the remote server.
LastError Read-only property Holds the last error returned by the method.
ListItem Read-only property Holds the value of the last ListItems and Attributes event
LocalPath Read-write property Holds name of the local path used for transferring.
Login Read-write property Determines the username/login to be used with the server.
MaxTransferRate Read-write property Determines maximum upload/download speed.
MyHostname Read-write property Holds the hostname of the local computer.
MyIP Read-write property Holds the IP address of the local computer.
Password Read-write property Determines the password to be used with server.
Port Read-write property Determines the port on the remote server where wodSFTP will connect.
PrivateKey Read-write property Private key used for authentication.
ProxyHostname Read-write property Specifies the hostname of the proxy to use.
ProxyLogin Read-write property Specifies the login/username to use when connecting to a proxy server.
ProxyPassword Read-write property Specifies the password to use when connecting to a proxy server.
ProxyPort Read-write property Specifies the port to use for a proxy server.
ProxyType Read-write property Specifies the type of proxy to use.
RemoteIdentification Read-only property Holds the remote identification string
RemotePath Read-write property Holds the name of the path on the server used for transferring.
Resume Read-write property Determines whether wodSFTP will resume file transfer.
ServerErrorCode Read-only property Holds the error code returned by the server.
ServerErrorText Read-only property Holds the error text returned by the server.
State Read-only property Holds the current state information.
StateText Read-only property Provides a string expression describing a State.
Timeout Read-write property Timeout value, in seconds.
Timezone Read-write property Determines whether dates are shown in Local or UTC time zone.
TransferMode Read-write property Determines whether transfers are Binary or ASCII.
TransferRate Read-only property Determines whether transfers are Binary or ASCII.
TransferTime Read-only property Time needed to transfer current or previous file.
UseIPv6 Read-write property Determines if IPv6 addresses are allowed.
Version Read-write property Holds version information.

To get more information on how to use below callbacks, read here.

Event callbacks
Attributes Called when wodSFTP retrieves file or directory attributes.
AttributesData Called when wodSFTP retrieves directory attributes.
Connected Called when wodSFTP connects to a remote server.
CryptoInformation Called before wodSFTP established encrypted connection with the server.
Disconnected Called when wodSFTP disconnects from the server.
Done Called when wodSFTP finishes a method.
ExtendedCmdReply Called after wodSFTP receives reply on ExtendedCmd.
HostFingerprint Called when the remote server provides public key fingerprint information.
ListItems Called when the server returns information about a file or directory.
LoginChallenge Called when the server requests a response to login challenge.
LoopError Called after wodSFTP performs operation on item and error occurs.
LoopItem Called before wodSFTP performs operation on item from the GetFiles/PutFiles/DeleteFiles/LoopFiles sequence.
Progress Called during file sending or receiving.
RemoteData Called after wodSFTP has some data to be provided as result of RemoteRead command.
StateChange Called when wodSFTP changes its state.