Функция 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.

Комментарии

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

Примеры

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

Требования

См. также

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

GetEnvironmentVariable