getFileAttributesA 函数 (fileapi.h)

项目
06/02/2023

检索指定文件或目录的文件系统属性。

若要获取更多属性信息，请使用 GetFileAttributesEx 函数。

若要以事务处理操作的形式执行此操作，请使用 GetFileAttributesTransacted 函数。

语法

DWORD GetFileAttributesA(
  [in] LPCSTR lpFileName
);

参数

[in] lpFileName

文件或目录的名称。

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

提示

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

返回值

如果函数成功，则返回值包含指定文件或目录的属性。有关属性值及其说明的列表，请参阅文件属性常量。

如果函数失败，则返回值 INVALID_FILE_ATTRIBUTES。要获得更多的错误信息，请调用 GetLastError。

注解

在装载文件夹的目录上调用 GetFileAttributes 时，它将返回目录的文件系统属性，而不是装载的文件夹与目录关联的卷中根目录的属性。若要获取关联卷的文件属性，请调用 GetVolumeNameForVolumeMountPoint 以获取关联卷的名称。然后在调用 GetFileAttributes 时使用生成的名称。结果是关联卷上根目录的属性。

如果为网络共享调用 GetFileAttributes ，则函数将失败，并且 GetLastError 将返回 ERROR_BAD_NETPATH。必须指定该共享上的子文件夹的路径。

在Windows 8和Windows Server 2012中，以下技术支持此功能。

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

符号链接行为 - 如果路径指向符号链接，函数将返回符号链接的属性。

事务处理操作

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

示例

有关示例，请参阅检索和更改文件属性。

注意

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

要求


最低受支持的客户端	Windows XP [桌面应用 \|UWP 应用]
最低受支持的服务器	Windows Server 2003 [桌面应用 \|UWP 应用]
目标平台	Windows
标头	fileapi.h (包括 Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll