SetFileAttributesTransactedA 函数 (winbase.h)

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

将文件或目录的属性设置为事务操作。

语法

BOOL SetFileAttributesTransactedA(
  [in] LPCSTR lpFileName,
  [in] DWORD  dwFileAttributes,
  [in] HANDLE hTransaction
);

参数

[in] lpFileName

要设置其属性的文件的名称。

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

提示

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

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

[in] dwFileAttributes

要为文件设置的文件属性。

有关文件属性值及其说明的列表,请参阅 文件属性常量。 此参数可以是一个或多个值,使用按位 OR 运算符组合。 但是,所有其他值都替代 FILE_ATTRIBUTE_NORMAL

此函数不支持所有属性。 有关详细信息,请参阅“备注”部分。

下面是支持的属性值列表。

FILE_ATTRIBUTE_ARCHIVE (32 (0x20)

FILE_ATTRIBUTE_HIDDEN (2 (0x2)

FILE_ATTRIBUTE_NORMAL (128 (0x80)

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (8192 (0x2000)

FILE_ATTRIBUTE_OFFLINE (4096 (0x1000)

FILE_ATTRIBUTE_READONLY (1 (0x1)

FILE_ATTRIBUTE_SYSTEM (4 (0x4)

FILE_ATTRIBUTE_TEMPORARY (256 (0x100)

[in] hTransaction

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

返回值

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

如果函数失败,则返回值为零。 若要获取扩展的错误信息,请调用 GetLastError

言论

下表介绍了如何使用 SetFileAttributesTransacted设置无法设置的属性。 请注意,这些操作不是事务处理的操作。

属性 如何设置
FILE_ATTRIBUTE_COMPRESSED

0x800

若要设置文件的压缩状态,请将 DeviceIoControl 函数与 FSCTL_SET_COMPRESSION 操作一起使用。
FILE_ATTRIBUTE_DEVICE

0x40

保留;请勿使用。
FILE_ATTRIBUTE_DIRECTORY

0x10

无法将文件转换为目录。 若要创建目录,请使用 CreateDirectoryCreateDirectoryEx 函数。
FILE_ATTRIBUTE_ENCRYPTED

0x4000

若要创建加密文件,请使用具有 FILE_ATTRIBUTE_ENCRYPTED 属性的 CreateFile 函数。 若要将现有文件转换为加密文件,请使用 EncryptFile 函数。
FILE_ATTRIBUTE_REPARSE_POINT

0x400

若要将重新分析点与文件或目录相关联,请将 DeviceIoControl 函数与 FSCTL_SET_REPARSE_POINT 操作配合使用。
FILE_ATTRIBUTE_SPARSE_FILE

0x200

若要设置文件的稀疏属性,请将 DeviceIoControl 函数与 FSCTL_SET_SPARSE 操作一起使用。
 

如果文件在事务中打开进行修改,则其他任何线程都无法成功打开该文件进行修改,直到提交事务。 如果事务处理线程首先打开文件,则尝试在提交事务之前打开文件进行修改的任何后续线程都将收到共享冲突。 如果非事务处理线程在事务处理线程之前打开文件进行修改,并且事务处理线程尝试打开该文件时仍处于打开状态,则事务将收到 ERROR_TRANSACTIONAL_CONFLICT 错误。

有关事务的详细信息,请参阅 事务 NTFS

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

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

SMB 3.0 不支持 TxF。

事务处理操作

如果文件在事务中打开进行修改,则其他任何线程都无法打开该文件进行修改,直到提交事务。 因此,如果事务处理线程首先打开文件,则尝试在提交事务之前修改文件的任何后续线程都会收到共享冲突。 如果非事务处理线程在事务处理线程之前修改文件,并且当事务尝试打开该文件时,该文件仍处于打开状态,则事务收到错误 ERROR_TRANSACTIONAL_CONFLICT

注意

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

要求

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

另请参阅

文件属性常量

文件管理功能

GetFileAttributesTransacted

符号链接

事务性 NTFS