Функция SetEnvironmentVariable

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

Синтаксис

BOOL SetEnvironmentVariable(

LPCTSTR lpName, // имя переменной окружения

LPCTSTR lpValue // новое значение переменой

);

Параметры

lpName

[in] Указатель на строку с нулем в конце, которая определяет имя переменной окружения. Операционная система создает переменную окружения тогда, если она не существует, а параметр lpValue имеет значение не ПУСТО (NULL).

lpValue

[in] Указатель на строку с нулем в конце, определяющую содержание переменной окружения. Переменная окружения имеет предел максимального размера 32,767 байтов, включая в себя завершающий нуль - признак конца.

Если этот параметр имеет значение ПУСТО (NULL), переменная удаляется из конфигурации текущего процесса.

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

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

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

Замечания

Эта функция не имеет никакого воздействия на переменные конфигурации системы или на переменные окружения других процессов. Для получения дополнительной информации, см. Переменные окружения.

Windows 95/98/Me: функция SetEnvironmentVariableW поддерживается подпрограммой Microsoft Layer for Unicode. Чтобы использовать ее, Вы должны добавить некоторые файлы к вашему приложению, как изложено в Microsoft Layer for Unicode для систем Windows 95/98/Me.

Смотри также

Краткий обзор Процессы и потоки, Функции, используемые процессами и потоками, GetEnvironmentVariable

Размещение и совместимость SetEnvironmentVariable

Windows. NET Server

Да

Windows XP

Да

Windows 2000

Да

Windows NT

Да версии 3.1 и выше

Windows Me

Да

Windows 98

Да

Windows 95

Да

Используемая библиотека

Kernel32.lib

Заголовочный файл

 

- объявлено в

Winbase.h

- включено в

Windows.h

Unicode

Реализуется как версии Уникод и ANSI в Windows NT /2000/XP.

Поддерживается также подпрограммой Microsoft Layer for Unicode

Замечания по платформе

Не имеется

 

Назад в оглавление
На главную страницу
На оглавление справки

Hosted by uCoz