Функция GetEnvironmentVariable


Функция GetEnvironmentVariable извлекает содержание заданной переменной из блока конфигурации вызывающего процесса. Содержание находится в форме строки символов с нулем в конце.

Синтаксис

DWORD GetEnvironmentVariable(

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

LPTSTR lpBuffer, // буфер для значения переменной

DWORD nSize      // размер буфера

);

Параметры

lpName

[in] Указатель на символьную строку с нулем в конце, которая устанавливает переменную окружения.

lpBuffer

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

nSize

Размер буфера, указанного параметром lpBuffer, в TCHAR (в символах).

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

Если функция завершается успешно, величина возвращаемого значения - число TCHAR (символов), сохраненное в буфере, указанном в lpBuffer, исключая символ завершения строки (ноль-терминатор).

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

Если буфер, указанный параметром lpBuffer не достаточно большой, величина возвращаемого значения - размер буфера, в TCHAR (в символах), требуемых, чтобы вместить строку значений и ее символ завершения (ноль-терминатор).

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

Код примера

Пример смотри в статье Изменение переменных окружения.

Смотри также

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

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

Windows. NET Server

Да

Windows XP

Да

Windows 2000

Да

Windows NT

Да

Windows Me

Да

Windows 98

Да

Windows 95

Да

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

Kernel32.lib

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

 

- объявлено в

Winbase.h

- включено в

Windows.h

Unicode

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

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

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

Не имеется

 

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

Hosted by uCoz