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 函数。
如果设置了除删除和删除子级以外的所有访问权限的目录,并且继承了新文件的访问控制列表(ACL),则可以创建一个文件,而无需删除它。 但是,可以创建一个文件,然后在创建文件时返回的句柄上获取请求的所有访问权限。

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

如果应用程序尝试删除具有其他句柄的文件,或者作为内存映射文件打开,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)
群集共享卷文件系统 (CsvFS)
可复原文件系统 (ReFS)
 

SMB 3.0 不支持 TxF。

注意

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

要求

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

另请参阅

CloseHandle

CreateFileTransacted

文件管理功能

符号链接

事务性 NTFS