ssCore.FTP.localFile

Setting FTP.localFile tells the plugin where to create the file being downloaded, or where to get the file to be uploaded.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

localFile - Fully qualified path to a local file. This parameter supports monikers.


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


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FTP.localFile( paramsObject );


Notes:

The local file will be created when you call FTP.open. If the local file exists, it will be overwritten. If the local file does not exist it will be created. If the path does not exist, it will be created.

                

Examples:

ssCore.FTP.localFile({localFile:"startdir://file.jpg"});