GetWindowsDirectoryA 函数 (sysinfoapi.h)

  • 项目

检索 Windows 目录的路径。

提供此函数主要用于与旧版应用程序的兼容性。 新应用程序应将代码存储在“程序文件”文件夹中，并将持久数据存储在用户配置文件的“应用程序数据”文件夹中。 有关详细信息，请参阅 ShGetFolderPath。

语法

UINT GetWindowsDirectoryA(
  [out] LPSTR lpBuffer,
  [in]  UINT  uSize
);

参数

[out] lpBuffer

指向接收路径的缓冲区的指针。 除非 Windows 目录是根目录，否则此路径不会以反斜杠结尾。 例如，如果 Windows 目录在驱动器 C 上名为 Windows，则此函数检索到的 Windows 目录的路径为 C：\Windows。 如果系统安装在驱动器 C 的根目录中，则检索的路径为 C：。

[in] uSize

lpBuffer 参数指定的缓冲区的最大大小（以 TCHAR 为单位）。 此值应设置为 MAX_PATH。

返回值

如果函数成功，则返回值是复制到缓冲区的字符串的长度（以 TCHAR 为单位），不包括终止 null 字符。

如果长度大于缓冲区的大小，则返回值是保存路径所需的缓冲区的大小。

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

注解

Windows 目录是某些旧版应用程序在其中存储初始化和帮助文件的目录。 新应用程序不应将文件存储在 Windows 目录中;相反，它们应将系统范围的数据存储在应用程序的安装目录中，并将特定于用户的数据存储在用户的配置文件中。

如果用户运行的是共享版本的系统，则保证 Windows 目录对于每个用户都是私有的。

如果应用程序创建希望按用户存储的其他文件，则应将它们放在 HOMEPATH 环境变量指定的目录中。 如果管理员通过用户管理器管理工具指定，则每个用户的此目录将有所不同。 HOMEPATH 始终指定用户的主目录（保证每个用户是专用目录）或默认目录 (例如 C：\USERS\DEFAULT) 用户将拥有所有访问权限。

终端服务： 如果应用程序在终端服务环境中运行，则每个用户都有一个专用的 Windows 目录。 系统还有一个共享的 Windows 目录。 如果应用程序是终端服务感知 (在映像标头) 中设置了 IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE 标志，则此函数将返回系统 Windows 目录的路径，就像 GetSystemWindowsDirectory 函数一样。 否则，它将检索用户的专用 Windows 目录的路径。

示例

有关示例，请参阅 获取系统信息。

注意

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

要求

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

另请参阅

GetCurrentDirectory

GetSystemDirectory

GetSystemWindowsDirectory

系统信息函数