ajDeleteFile function
Description
The ajDeleteFile function deletes a specified file.
Syntax
ajDeleteFile(file_path, [run_condition], [run_by_function_point_only])
| Argument Name | Argument Type | Description |
|---|---|---|
| file_path (required) | String | The path of the file that is to be deleted. Both the forward-slash (/) and backslash (\) are supported as the folder separator. |
| 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
=ajDeleteFile("c:\source.txt")
If the file exists and it is deleted successfully, the function returns TRUE. If the file does not exist, or any other error occurs such as the file is locked by another process, #VALUE! would be returned.
Click here to download the use case workbooks for further reference.
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 file path. |
| User does not have the right to operate the file. |