共用方式為

GetEnvironmentVariableA 函式 （processenv.h）

  • 發行項

從呼叫進程的環境區塊擷取指定變數的內容。

語法

DWORD GetEnvironmentVariableA(
  [in, optional]  LPCSTR lpName,
  [out, optional] LPSTR  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。

言論

此函式可以擷取系統環境變數或用戶環境變數。

例子

如需範例，請參閱 變更環境變數。

注意

processenv.h 標頭會根據 UNICODE 預處理器常數的定義，將 GetEnvironmentVariable 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱函式原型的 慣例。

要求

要求 價值
最低支援的用戶端 Windows XP [傳統型應用程式 |UWP 應用程式]
支援的最低伺服器 Windows Server 2003 [傳統型應用程式 |UWP 應用程式]
目標平臺 窗戶
標頭 processenv.h （包括 Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2 上的 Windows.h）
連結庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

環境變數

GetEnvironmentStrings

SetEnvironmentVariable