Функция SetEnvironmentVariableA (processenv.h)

Статья
11/20/2024

Задает содержимое указанной переменной среды для текущего процесса.

Синтаксис

BOOL SetEnvironmentVariableA(
  [in]           LPCSTR lpName,
  [in, optional] LPCSTR lpValue
);

Параметры

[in] lpName

Имя переменной среды. Операционная система создает переменную среды, если она не существует и lpValue не имеет значения NULL.

[in, optional] lpValue

Содержимое переменной среды. Максимальный размер определяемой пользователем переменной среды составляет 32 767 символов. Дополнительные сведения см. в переменных среды.

Windows Server 2003 и Windows XP: Общий размер блока среды для процесса может не превышать 32 767 символов.

Если этот параметр имеет значение NULL, переменная удаляется из среды текущего процесса.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение ненулевое.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Эта функция не влияет на системные переменные среды или переменные среды других процессов.

Примеры

Пример см. в разделе изменение переменных среды.

Заметка

Заголовок processenv.h определяет SetEnvironmentVariable в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [классические приложения \| Приложения UWP]
минимальный поддерживаемый сервер	Windows Server 2003 [классические приложения \| Приложения UWP]
целевая платформа	Виндоус
заголовка	processenv.h (включая Windows.h в Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
библиотеки	Kernel32.lib
DLL	Kernel32.dll

См. также

переменных среды

GetEnvironmentVariable

Поделиться через