GetFileAttributesA 函数 (fileapi.h)
检索指定文件或目录的文件系统属性。
若要获取更多属性信息,请使用 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 应用] |
目标平台 | 窗户 |
标头 | fileapi.h (包括 Windows.h) |
库 | Kernel32.lib |
DLL | Kernel32.dll |