getEnvironmentVariable 函数 (winbase.h)

从调用进程的环境块检索指定变量的内容。

语法

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  lpBuffer,
  [in]            DWORD   nSize
);

[in, optional] lpName

环境变量的名称。

[out, optional] lpBuffer

指向缓冲区的指针，该缓冲区以 null 结尾的字符串的形式接收指定环境变量的内容。环境变量的最大大小限制为 32,767 个字符，包括 null 终止字符。

[in] nSize

lpBuffer 参数指向的缓冲区的大小，包括 null 终止符，以字符为单位。

如果函数成功，则返回值是 lpBuffer 指向的缓冲区中存储的字符数，不包括终止 null 字符。

如果 lpBuffer 不够大来保存数据，则返回值是保存字符串及其终止 null 字符所需的缓冲区大小（以字符为单位）， lpBuffer 的内容未定义。

如果函数失败，则返回值为零。如果在环境块中找不到指定的环境变量， GetLastError 将返回ERROR_ENVVAR_NOT_FOUND。

此函数可以检索系统环境变量或用户环境变量。

有关示例，请参阅更改环境变量。

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