setEnvironmentVariable 函数 (winbase.h)

  • 项目

设置当前进程的指定环境变量的内容。

语法

BOOL SetEnvironmentVariable(
  [in]           LPCTSTR lpName,
  [in, optional] LPCTSTR lpValue
);

参数

[in] lpName

环境变量的名称。 如果环境变量不存在且 lpValue 不为 NULL，则操作系统将创建该环境变量。

[in, optional] lpValue

环境变量的内容。 用户定义的环境变量的最大大小为 32,767 个字符。 有关详细信息，请参阅 环境变量。

Windows Server 2003 和 Windows XP： 进程的环境块的总大小不能超过 32,767 个字符。

如果此参数为 NULL，则会从当前进程的环境中删除变量。

返回值

如果该函数成功，则返回值为非零值。

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

注解

此函数对系统环境变量或其他进程的环境变量没有影响。

示例

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

要求

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

另请参阅

环境变量

GetEnvironmentVariable