Delete Folder
Delete a folder with the given path.
Privileges
Normal
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Folder Name | String | Yes | The full path of the folder to be deleted. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
|
Folder Name |
String |
Yes |
C:\folder1\folder2 |
|
Recurse |
Boolean |
No |
If Recuse is not selected, only empty folders can be deleted. Select Recuse to delete all files and folders contained within the specified folder. |