[in] lpFileName
要删除的文件的名称。
默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 个宽字符,请在路径前面添加“\?\”。 有关详细信息,请参阅
命名文件、路径和命名空间
。
从 Windows 10 版本 1607 开始,可以选择删除MAX_PATH限制,而无需在前面添加“\\?\”。 有关详细信息,请参阅
命名文件、路径和命名空间
的“最大路径长度限制”部分。
如果该函数成功,则返回值为非零值。
如果函数失败,则返回值为零 (0) 。 要获得更多的错误信息,请调用 GetLastError。
如果应用程序尝试删除不存在的文件,
DeleteFile
函数将失败并
显示ERROR_FILE_NOT_FOUND
。 如果文件是只读文件,则函数将失败并
ERROR_ACCESS_DENIED
。
以下列表列出了删除、删除或关闭文件的一些提示:
若要删除只读文件,首先必须删除只读属性。
若要删除或重命名文件,必须对文件具有删除权限,或在父目录中删除子权限。
若要以递归方式删除目录中的文件,请使用
SHFileOperation
函数。
若要删除空目录,请使用
RemoveDirectory
函数。
若要关闭打开的文件,请使用
CloseHandle
函数。
如果设置了除 delete 和 delete child 以外的所有访问权限的目录,并且继承了新文件的 ACL) 访问控制 (列表,则可以创建文件,而无需删除它。 但是,你可以创建一个文件,然后获取在创建文件时返回给你的句柄上请求的所有访问权限。
如果在创建文件时请求删除权限,则可以使用该句柄删除或重命名文件,但不能使用任何其他句柄。 有关详细信息,请参阅
文件安全性和访问权限
。
如果应用程序尝试删除有其他句柄为正常 I/O 打开的文件或作为内存映射文件的文件 (
FILE_SHARE_DELETE
必须在打开其他句柄) 时指定,则
DeleteFile
函数将失败。
DeleteFile
函数在关闭时标记要删除的文件。 因此,在关闭文件的最后一个句柄之前,不会删除文件。 后续调用
CreateFile
以打开文件失败,
ERROR_ACCESS_DENIED
。
符号链接行为 —
如果路径指向符号链接,则会删除符号链接,而不是目标。 若要删除目标,必须调用
CreateFile
并指定
FILE_FLAG_DELETE_ON_CLOSE
。
在Windows 8和Windows Server 2012中,以下技术支持此功能。
服务器消息块 (SMB) 3.0 协议
SMB 3.0 透明故障转移 (TFO)
具有横向扩展文件共享的 SMB 3.0 (SO)
群集共享卷文件系统 (CsvFS)
弹性文件系统 (ReFS)
有关示例,请参阅
在文件中锁定和解锁字节范围
。
fileapi.h 标头将 DeleteFile 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅
函数原型的约定
。