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 が指すバッファーに格納されている文字数であり、終端の null 文字は含まれません。
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 を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |