$ps.file.removeDirectory
Overview¶
Deletes a specified directory using "$ps.file" in "Server Script". All subdirectories and files in the directory will be deleted.
Prerequisites¶
DisableServerScriptFile in "Script.json" must be set to false.
Syntax¶
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| section | string | Yes | Section name. For details about sections, see "About Sections" in "$ps.file". |
| path | string | Yes | Directory name. For both Windows and Linux, the directory separator is "/". |
Return Value¶
Returns true if the directory can be deleted, and false if it cannot be deleted.
Exceptions¶
If an exception occurs in C#, an exception is raised in the server script by putting the exception class name and error message into the Error object.
Usage Examples¶
The following example deletes a specified directory in the web server.
JavaScript¶
Supported Versions¶
| Supported versions | Body |
|---|---|
| 1.4.12.0 and later | Added function |