Full path: /system/filesystem/rmdir
Removes a directory.
This function returns Boolean TRUE if execution was successful. If the job execution fails, the outcome depends on the value of the Abort on error parameter, as follows:
•If the Abort on error parameter is TRUE (default value), the job execution is aborted. In this case, you can still handle errors by means of protected blocks (see Handling Step Errors).
•If the Abort on error parameter is FALSE, the function returns FALSE.
Parameters
Name |
Type |
Description |
|---|---|---|
Path |
string as directory |
The name of the directory you want to delete. |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if the job fails. If Abort on error is FALSE, the function will return Boolean FALSE as well. If Abort on error is TRUE, the job execution is aborted. The default value is TRUE. |
Working directory |
string as directory |
Specifies the working directory (for example, c:\somedirectory). If relative paths are used, they will be resolved against the working directory. |
