deleteFileTransactedA 函数 (winbase.h)

[Microsoft 强烈建议开发人员利用替代方法来实现应用程序的需求。 TxF 致力于实现的许多方案都可以通过更简单、更易用的技术来实现。 此外,TxF 在 Microsoft Windows 的将来版本中可能不可用。 有关详细信息,以及 TxF 的替代方法,请参阅事务性 NTFS 的替代方法。]

将现有文件作为事务处理操作删除。

语法

BOOL DeleteFileTransactedA(
  [in] LPCSTR lpFileName,
  [in] HANDLE hTransaction
);

参数

[in] lpFileName

要删除的文件的名称。

默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 个宽字符,请在路径前面添加“\\?\”。 有关详细信息,请参阅命名文件、路径和命名空间

提示

从 Windows 10 版本 1607 开始,可以选择删除MAX_PATH限制,而无需在前面添加“\\?\”。 有关详细信息,请参阅 命名文件、路径和命名空间 的“最大路径长度限制”部分。

文件必须驻留在本地计算机上;否则,函数将失败,最后一个错误代码设置为 ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE

[in] hTransaction

事务的句柄。 此句柄由 CreateTransaction 函数返回。

返回值

如果该函数成功,则返回值为非零值。

如果函数失败,则返回值为 0(零)。 要获得更多的错误信息,请调用 GetLastError。

注解

如果应用程序尝试删除不存在的文件, DeleteFileTransacted 函数将失败 并ERROR_FILE_NOT_FOUND。 如果文件是只读文件,则函数将失败并 ERROR_ACCESS_DENIED

以下列表标识了删除、删除或关闭文件的一些提示:

  • 若要删除只读文件,首先必须删除只读属性。
  • 若要删除或重命名文件,必须对文件具有删除权限,或者具有父目录中的删除子权限。
  • 若要以递归方式删除目录中的文件,请使用 SHFileOperation 函数。
  • 若要删除空目录,请使用 RemoveDirectoryTransacted 函数。
  • 若要关闭打开的文件,请使用 CloseHandle 函数。
如果设置了除 delete 和 delete child 以外的所有访问权限的目录,并且访问控制列表 (ACL) 继承了新文件,则可以创建一个文件,但无法将其删除。 但是,你可以创建一个文件,然后获取在创建文件时返回给你的句柄上请求的所有访问权限。

如果在创建文件时请求删除权限,则可以使用该句柄删除或重命名文件,但不能使用任何其他句柄。 有关详细信息,请参阅 文件安全和访问权限

如果应用程序尝试删除具有打开正常 I/O 的其他句柄的文件或作为内存映射文件的文件, DeleteFileTransacted 函数将失败, (FILE_SHARE_DELETE 必须在打开其他句柄) 时指定。

DeleteFileTransacted 函数在关闭时标记要删除的文件。 文件在关闭文件的最后一个事务处理编写器句柄后删除,前提是事务仍处于活动状态。 如果文件已被标记为要删除,并且事务处理编写器句柄在事务完成后仍处于打开状态,则不会删除该文件。

符号链接: 如果路径指向符号链接,则删除符号链接,而不是目标。 若要删除目标,必须调用 CreateFile 并指定 FILE_FLAG_DELETE_ON_CLOSE

在 Windows 8 和 Windows Server 2012 中,此函数由以下技术支持。

技术 支持
服务器消息块 (SMB) 3.0 协议
SMB 3.0 透明故障转移 (TFO)
具有横向扩展文件共享的 SMB 3.0 (SO)
群集共享卷文件系统 (CSV)
弹性文件系统 (ReFS)
 

SMB 3.0 不支持 TxF。

注意

winbase.h 标头将 DeleteFileTransacted 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 winbase.h (包括 Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

CloseHandle

CreateFileTransacted

文件管理函数

符号链接

事务性 NTFS