Deletes an existing file.

To perform this operation as a transacted operation, use theDeleteFileTransacted function.

Syntax

BOOL DeleteFileA(  [in] LPCSTR lpFileName);

Parameters

[in] lpFileName

The name of the file to be deleted.

By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, seeNaming Files, Paths, and Namespaces.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, callGetLastError.

Remarks

If an application attempts to delete a file that does not exist, theDeleteFile function fails withERROR_FILE_NOT_FOUND. If the file is a read-only file, the function fails withERROR_ACCESS_DENIED.

The following list identifies some tips for deleting, removing, or closing files:

• To delete a read-only file, first you must remove the read-only attribute.
• To delete or rename a file, you must have either delete permission on the file, or delete child permission in the parent directory.
• To recursively delete the files in a directory, use theSHFileOperation function.
• To remove an empty directory, use theRemoveDirectory function.
• To close an open file, use theCloseHandle function.

If you set up a directory with all access except delete and delete child, and the access control lists (ACL) of new files are inherited, then you can create a file without being able to delete it. However, then you can create a file, and then get all the access you request on the handle that is returned to you at the time you create the file.

If you request delete permission at the time you create a file, you can delete or rename the file with that handle, but not with any other handle. For more information, seeFile Security and Access Rights.

TheDeleteFile function fails if an application attempts to delete a file that has other handles open for normal I/O or as a memory-mapped file (FILE_SHARE_DELETE must have been specified when other handles were opened).

TheDeleteFile function marks a file for deletion on close. Therefore, the file deletion does not occur until the last handle to the file is closed. Subsequent calls toCreateFile to open the file fail withERROR_ACCESS_DENIED.

The use of POSIX delete causes the file to be deleted while handles remain open. Subsequent calls toCreateFile to open the file fail withERROR_FILE_NOT_FOUND.

Symbolic link behavior:

If the path points to a symbolic link, the symbolic link is deleted, not the target. To delete a target, you must callCreateFile and specifyFILE_FLAG_DELETE_ON_CLOSE.

In Windows 8 and Windows Server 2012, this function is supported by the following technologies:

Examples

For an example, seeLocking and Unlocking Byte Ranges in Files.

Requirements

See also

CloseHandle

CreateFile

DeleteFileTransacted

File Management Functions

Symbolic Links