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 的內容。
如果此函式失敗，則傳回值為零。 如果在環境區塊中找不到指定的環境變數， 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) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |