ssCore.FTP.open

Begin an FTP transfer.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

None.


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.open( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

This method can only be called asynchronously.


Notes:

Values for FTP.localFile, FTP.remoteFile and FTP.direction must be supplied before calling FTP.open. Optionally you can also set the FTP.transferMode (if not supplied, the plugin will default to binary transfer mode).

                

Examples:

ssCore.FTP.open({}, {callback:"fileOpened", scope:this});

function fileOpened(return_obj, callback_obj, error_obj)
{
    if (return_obj.success)
    {
        // File was opened successfully.
    }
    else
    {
        ssDebug.trace('ERROR: '+error_obj.description);
    }
}