SetEnvironmentVariableW 函数 (processenv.h)
设置当前进程的指定环境变量的内容。
语法
BOOL SetEnvironmentVariableW(
[in] LPCWSTR lpName,
[in, optional] LPCWSTR lpValue
);
参数
[in] lpName
环境变量的名称。 如果环境变量不存在,则操作系统会创建环境变量,lpValue 不为 NULL。
[in, optional] lpValue
环境变量的内容。
用户定义的环境变量的最大大小为 32,767 个字符。 环境块的大小没有技术限制。 但是,根据用于访问块的机制,存在实际限制。 例如,批处理文件无法设置长度超过最大命令行长度的变量。 有关详细信息,请参阅 环境变量。
Windows Server 2003 和 Windows XP:进程的环境块的总大小不得超过 32,767 个字符。
如果此参数为 NULL,则变量将从当前进程的环境中删除。
返回值
如果函数成功,则返回值为非零。
如果函数失败,则返回值为零。 若要获取扩展的错误信息,请调用 GetLastError。
言论
此函数对系统环境变量或其他进程的环境变量没有影响。
例子
有关示例,请参阅 更改环境变量。
注意
processenv.h 标头将 SetEnvironmentVariable 定义为一个别名,该别名根据 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 |