ssCore.FileSys.deleteFile

Removes the specified file.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to the file you want to delete. This parameter supports monikers.

failIfNotExist - [Optional] - Force the command to fail if the file doesn't exist. Valid values include: true,false. Default value is false.


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


Notes:

Normally, FileSys.deleteFile does not fail if the file specified by path doesn't exist. This behavior can be changed by setting failIfNotExist to TRUE.

                

Examples:

ssCore.FileSys.deleteFile({path:"startdir://file.txt"});