Availability
This routine is available since katl-commons 1.0 .
Syntax:
deleteFile(path_to_file)
Description:
Deletes a file. It also returns true if the file was deleted successfully, false otherwise. If returned false check the log for a detailed reason on why it failed.Parameters:
Parameter name | Type | Required | Description |
---|---|---|---|
path_to_file | string | Yes | Specifies the file name to delete. |
Return type:
boolean (true/false)
Example:
deleteFile("C:/fileToDelete.txt");
Notes:
- It is recommended that you use forward slashes ( / ) for file paths.
See also: