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

  • Статья

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

Синтаксис

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]
Целевая платформа Windows
Header processenv.h (включает Windows.h в Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

Переменные среды

GetEnvironmentVariable