$ps.file.removeFile
Overview¶
Delete the specified file using "$ps.file" in "Server Script".
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 | File name. For both Windows and Linux, use "/" as the directory separator. |
Return Value¶
Returns true if the file can be deleted, and false if it cannot be deleted.
Exceptions¶
If an exception occurs in C#, the exception class name and error message are placed in the Error object in the server script to raise an exception.
Usage Examples¶
The following example deletes a specified file in the web server.
JavaScript¶
Supported Versions¶
| Supported versions | Body |
|---|---|
| 1.4.12.0 and later | Added function |