ajDeleteFile function
Description
The ajDeleteFile function deletes a specified file.
Syntax
ajDeleteFile(file_path, [run_condition], [run_by_function_point_only])
| Argument Name | Description |
|---|---|
| file_path (required) | Specify the full path of the file that is to be deleted. Both the forward-slash (/) and backslash (\) are supported as the folder separator. |
| run_condition (optional) | The function will run when the value is TRUE. Otherwise will not run. If you do not specify anything, the default value will always be TRUE. |
| run_by_function_point_only (optional) | If it equals FALSE, the function can be executed through ‘Excel Calculation’ (can be either Automatic or Manual, Calculate Now or Calculate Sheet) or Run Function Point. If it equals TRUE, the function can be executed with Run Function Point (AlchemyJ toolbar \ Run Function Point) only. If you do not specify anything, the default value will always be TRUE. |
The function will return:
1) Content type: TRUE, #VALUE!
2) Method: within a cell / cell array
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.