Функция GetEnvironmentVariable (winbase.h)

  • Статья

Извлекает содержимое указанной переменной из блока среды вызывающего процесса.

Синтаксис

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  lpBuffer,
  [in]            DWORD   nSize
);

Параметры

[in, optional] lpName

Имя переменной среды.

[out, optional] lpBuffer

Указатель на буфер, который получает содержимое указанной переменной среды в виде строки, завершаемой null. Максимальный размер переменной среды составляет 32 767 символов, включая завершающий символ null.

[in] nSize

Размер буфера, на который указывает параметр lpBuffer , включая символ конца null, в символах.

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

Если функция выполняется успешно, возвращаемое значение — это количество символов, хранящихся в буфере, на который указывает lpBuffer, не включая завершающий пустой символ.

Если значение lpBuffer недостаточно велико для хранения данных, возвращаемое значение представляет собой размер буфера в символах, необходимый для хранения строки и завершающего ее символа NULL, а содержимое lpBuffer не определено.

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

Комментарии

Эта функция может получить либо системную переменную среды, либо переменную среды пользователя.

Примеры

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

Требования

Требование Значение
Минимальная версия клиента Windows XP [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2003 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header winbase.h (включает Windows.h в Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

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

GetEnvironmentStrings

SetEnvironmentVariable