Transfer data to or from the FTP server and send progress events.


First available in version 3.0 build 2039.

Input Parameters:


Output Parameters:

No output parameters.

Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FTP.transfer( paramsObject [, callbackParamsObject] [, errorParamsObject] );

Synchronous Mode:

This method can only be called asynchronously.


FTP.transfer is an asynchronous command, meaning that the plugin will automatically process the command in the background without halting your application. Once the transfer is complete, you are responsible for calling FTP.close and/or FTP.disconnect to close the files/connection.

There are 2 ways of making use of FTP.transfer to perform a file transfer.

The registered progress variable will be updated as blocks (or chunks) of data get transferred. (The size of the blocks is determined by FTP.bufferSize.)

To abort a transfer in progress, you call FTP.close. This will result in the registered progress variable being set to "-1". Also, FTP.transfer will fail with the error code set to "24" (Transfer aborted).