GetEnvironmentVariable 함수(winbase.h)

호출 프로세스의 환경 블록에서 지정된 변수의 내용을 검색합니다.

구문

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

매개 변수

[in, optional] lpName

환경 변수의 이름입니다.

[out, optional] lpBuffer

지정된 환경 변수의 내용을 null로 끝나는 문자열로 수신하는 버퍼에 대한 포인터입니다. 환경 변수의 최대 크기 제한은 null 종료 문자를 포함하여 32,767자입니다.

[in] nSize

null 종료 문자를 포함하여 lpBuffer 매개 변수가 가리키는 버퍼의 크기(문자)입니다.

반환 값

함수가 성공하면 반환 값은 종료 null 문자를 포함하지 않고 lpBuffer가 가리키는 버퍼에 저장된 문자 수입니다.

lpBuffer가 데이터를 저장할 만큼 크지 않은 경우 반환 값은 문자열과 종료 null 문자를 보유하는 데 필요한 버퍼 크기(문자)이며 lpBuffer의 내용은 정의되지 않습니다.

함수가 실패하면 반환 값은 0입니다. 환경 블록에서 지정된 환경 변수를 찾을 수 없는 경우 GetLastError 는 ERROR_ENVVAR_NOT_FOUND 반환합니다.

설명

이 함수는 시스템 환경 변수 또는 사용자 환경 변수를 검색할 수 있습니다.

예제

예제는 환경 변수 변경을 참조하세요.

요구 사항

요구 사항
지원되는 최소 클라이언트 Windows XP [데스크톱 앱 | UWP 앱]
지원되는 최소 서버 Windows Server 2003 [데스크톱 앱 | UWP 앱]
대상 플랫폼 Windows
헤더 winbase.h(Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2에 Windows.h 포함)
라이브러리 Kernel32.lib
DLL Kernel32.dll

참고 항목

환경 변수

GetEnvironmentStrings

SetEnvironmentVariable