ajDeleteFolder function
Available since AlchemyJ v4.1.3
Description
The ajDeleteFolder function deletes a specified folder.
Syntax
ajDeleteFolder(folder_path, [permanent_delete_files],[run_condition], [run_by_function_point_only])
| Argument Name | Argument Type | Description |
|---|---|---|
| folder_path (required) | String | The path of the folder that is to be deleted. Both the forward-slash (/) and backslash (\) are supported as the folder separator. |
| permanent_delete_files (optional) | Boolean | TRUE - permanent delete file(s) and folder in the sepecified folder path, FALSE - only delete empty folder. The default value is FALSE. |
| run_condition (optional) | Boolean | The function will run when the value is TRUE. Otherwise will not run. The default value is TRUE. |
| run_by_function_point_only (optional) | Boolean | If it equals FALSE, the function can be executed through ‘Excel Calculation’ (can be either Automatic or Manual, Calculate Now or Calculate Sheet) or Preview Function Point. If it equals TRUE, the function can be executed with Preview Function Point (AlchemyJ ribbon \ Preview Function Point) only. The default value is TRUE. |
The function will return:
1) Return Value: TRUE, #VALUE!
2) Return Type: Single Value
Example
=ajDeleteFolder("c:\folder1")
If the folder exists and it is deleted successfully, the function returns TRUE. If the folder does not exist, or any other error occurs such as the folder being locked by another process, #VALUE! would be returned.
Error Scenarios
It will return #VALUE! when missing any required parameter or mismatch parameter type. Besides, system will raise error for below scenario(s).
| Error Scenario |
|---|
| Invalid folder path. |