ssCore.FileSys.removeDir

Removes a directory.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to a directory. 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.removeDir( 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.removeDir( paramsObject );


Notes:

Removes the target directory including all files and subdirectories. There are no prompts or confirmation dialogs displayed when using FileSys.removeDir. Exercise extreme caution when working with this command.

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

                

Examples:

ssCore.FileSys.removeDir({path:"startdir://archive"});