GetEnvironmentVariableW 函数 (processenv.h)

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

语法

DWORD GetEnvironmentVariableW(
  [in, optional]  LPCWSTR lpName,
  [out, optional] LPWSTR  lpBuffer,
  [in]            DWORD   nSize
);

参数

[in, optional] lpName

环境变量的名称。

[out, optional] lpBuffer

指向缓冲区的指针,该缓冲区接收指定环境变量的内容作为以 null 结尾的字符串。

用户定义的环境变量的最大大小为 32,767 个字符。 环境块的大小没有技术限制。 但是,根据用于访问块的机制,存在实际限制。 例如,批处理文件无法设置长度超过最大命令行长度的变量。 有关详细信息,请参阅 环境变量

[in] nSize

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

返回值

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

如果 lpBuffer 不足以容纳数据,则返回值为缓冲区大小(以字符为单位)来保存字符串及其终止 null 字符,并且未定义 lpBuffer 的内容。

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

言论

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

例子

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

注意

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

要求

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

另请参阅

环境变量

GetEnvironmentStrings

SetEnvironmentVariable