ssCore.Scratch.writeFile

Write the specified file contents to the scratch area in your application.


Availability:

First available in version 3.8 build 333.


Input Parameters:

path - Path to the file to be written to the scratch area. 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.writeFile( 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.writeFile( paramsObject );


Notes:

None.


Examples:

// write the contents of the file to the scratch area
ssCore.Scratch.writeFile({path:"startdir://new_scratch.txt"});