共用方式為

GetFirmwareEnvironmentVariableA 函式 (winbase.h)

  • 發行項

擷取指定韌體環境變數的值。

語法

DWORD GetFirmwareEnvironmentVariableA(
  [in]  LPCSTR lpName,
  [in]  LPCSTR lpGuid,
  [out] PVOID  pBuffer,
  [in]  DWORD  nSize
);

參數

[in] lpName

韌體環境變數的名稱。 指標不得為 Null。

[in] lpGuid

表示韌體環境變數命名空間的 GUID。 GUID 必須是格式為 「{xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}」 的字串，其中 'x' 代表十六進位值。

[out] pBuffer

接收指定韌體環境變數值的緩衝區指標。

[in] nSize

pBuffer緩衝區的大小，以位元組為單位。

傳回值

如果函式成功，則傳回值是儲存在 pBuffer 緩衝區中的位元組數目。

如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。 可能的錯誤碼包括ERROR_INVALID_FUNCTION。

備註

從 Windows 10 版本 1803 開始，通用 Windows app 可以讀取和寫入整合可擴展韌體介面 (UEFI) 韌體變數。 如需詳細資訊，請參閱 從通用 Windows App 存取 UEFI 韌體變數 。

若要讀取韌體環境變數，應用程式執行所在的使用者帳戶必須具有 SE_SYSTEM_ENVIRONMENT_NAME 許可權。 通用 Windows 應用程式必須從系統管理員帳戶執行，並遵循 從通用 Windows App 存取 UEFI 韌體變數中所述的需求。

從 Windows 10 1803 版開始，從 User-Mode Driver Framework (UMDF) 驅動程式也支援讀取整合可擴展韌體介面 (UEFI) 變數。 不支援從 UMDF 驅動程式撰寫 UEFI 變數。

確切的韌體環境變數集是由開機韌體所決定。 這些環境變數的位置也會由韌體指定。 例如，在以 UEFI 為基礎的系統上，NVRAM 包含指定系統開機設定的韌體環境變數。 如需所使用特定變數的相關資訊，請參閱 UEFI 規格。 如需 UEFI 和 Windows 的詳細資訊，請參閱 UEFI 和 Windows。

舊版 BIOS 型系統不支援韌體變數。 GetFirmwareEnvironmentVariable函式在舊版 BIOS 型系統上一律會失敗，或者如果 Windows 在支援舊版 BIOS 和 UEFI 的系統上使用舊版 BIOS 安裝， 若要識別這些條件，請使用虛擬韌體環境名稱呼叫函式，例如lpName參數的空字串 (「」「) ，以及lpGuid參數的虛擬 GUID，例如 」 {00000000-0000-0000-0000-000000000000} 」。 在舊版 BIOS 型系統上，或在支援使用舊版 BIOS 安裝 Windows 的舊版 BIOS 和 UEFI 的系統上，函式將會失敗並ERROR_INVALID_FUNCTION。 在以 UEFI 為基礎的系統上，函式將會失敗，並出現韌體特定的錯誤，例如ERROR_NOACCESS，以指出虛擬 GUID 命名空間不存在。

如果您要建立備份應用程式，您可以使用此函式來儲存系統的所有開機設定，以便視需要使用 SetFirmwareEnvironmentVariable 函式加以還原。

GetFirmwareEnvironmentVariable 是 相當於 ExGetFirmwareEnvironmentVariable 核心模式常式的使用者模式。

注意

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

規格需求

   
最低支援的用戶端 Windows Vista、Windows XP SP1 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2003 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 winbase.h (包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

從通用 Windows App 存取 UEFI 韌體變數

GetFirmwareEnvironmentVariableEx

SetFirmwareEnvironmentVariable

系統資訊函式