ssCore.FileSys.renameFile

Renames an existing file.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to a file. This parameter supports monikers.

newName - The new name for the file.


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.FileSys.renameFile( 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.FileSys.renameFile( paramsObject );


Notes:

None.


Examples:

ssCore.FileSys.renameFile({path:"startdir://document1.txt", newName:"Fiscal Report.txt"});