FileDelete() function
- Last UpdatedJul 22, 2024
- 1 minute read
Deletes an individual file.
Syntax
result = FileDelete (filename)
Parameters
filename
The path name and file name of the file to delete. A literal string value, message tagname, or string expression. UNC path names are supported.
Remarks
Do not use the wildcard characters (* and ?) with the FileDelete() function and do not use the FileDelete() function in asynchronous QuickFunctions.
The FileDelete() function does not delete directories.
Return value
A value indicating success or failure of the file deletion:
1 - file is deleted successfully
0 - file is not deleted successfully. Possible causes are attempts to delete a read only or a non-existent file.
Example(s)
This script deletes the file c:\Data.txt and returns 1 if the file was found and deleted successfully.
Status=FileDelete("c:\Data.txt");