ssCore.Scratch.readFile

Read the file from the scratch area in your application and save it to disk.


Availability:

First available in version 3.8 build 333.


Input Parameters:

path - The path where the file should be written. 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.Scratch.readFile( 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.Scratch.readFile( paramsObject );


Notes:

None.


Examples:

// read the scratch area, and write it to disk
ssCore.Scratch.readFile({path:"startdir://existing_scratch.txt"});