ssCore.Layout.extractFile

Extract a file from the layout.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

resource - The path to the file in the Layout (a leading '\' is required and means the path starts at the root of the layout).

destination - A fully qualified path to the destination file. If the file exists it will be overwritten. If the file does not exist it will be created. If the destination directory does not exist it will be created. 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.Layout.extractFile( 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.Layout.extractFile( paramsObject );


Notes:

None.


Examples:

ssCore.Layout.extractFile({resource:"\\myFolder\\file.txt", destination:"tempdir://myFolder\\file.txt"});