FileDelete()

Auto Hotkey

FileDelete

Deletes one or more files.

FileDelete FilePattern
Command  Example: FileDelete A_ScriptDir "\MyFile.txt"
Function Example: FileDelete(A_ScriptDir "\MyFile.txt")

Parameters

FilePattern

The name of a single file or a wildcard pattern such as C:\Temp\*.tmp. FilePattern is assumed to be in %A_WorkingDir% if an absolute path isn't specified.

To remove an entire folder, along with all its sub-folders and files, use DirDelete.

ErrorLevel

ErrorLevel is set to the number of files that failed to be deleted (if any) or 0 otherwise. Deleting a wildcard pattern such as *.tmp is considered a success even if it does not match any files; thus ErrorLevel is set to 0.

If files were found, A_LastError is set to 0 (zero) or the result of the operating system's GetLastError() function immediately after the last failure. Otherwise A_LastError contains an error code that might indicate why no files were found.

Remarks

To delete a read-only file, first remove the read-only attribute. For example: FileSetAttrib, -R, C:\My File.txt.

Related

FileRecycle, DirDelete, FileCopy, FileMove

Example

FileDelete, C:\temp files\*.tmp