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-xxxxxx}” 格式的字符串,其中 'x' 代表十六進位值。
[out] pBuffer
接收指定韌體環境變數值的緩衝區指標。
[in] nSize
pBuffer 緩衝區的大小,以位元組為單位。
傳回值
如果函式成功,傳回值就是儲存在 pBuffer 緩衝區中的位元元組數目。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 可能的錯誤碼包括ERROR_INVALID_FUNCTION。
言論
從 Windows 10 版本 1803 開始,通用 Windows 應用程式可以讀取和寫入整合可擴展韌體介面 (UEFI) 韌體變數。 如需詳細資訊,請參閱從通用 Windows 應用程式
若要讀取韌體環境變數,應用程式執行下的使用者帳戶必須具有 SE_SYSTEM_ENVIRONMENT_NAME 許可權。 通用 Windows 應用程式必須從系統管理員帳戶執行,並遵循通用 Windows 應用程式
從 Windows 10 版本 1803 開始,從 User-Mode Driver Framework (UMDF) 驅動程式也支援讀取整合可擴展韌體介面 (UEFI) 變數。 不支援從 UMDF 驅動程式撰寫 UEFI 變數。
確切的一組韌體環境變數是由開機韌體所決定。 這些環境變數的位置也會由韌體指定。 例如,在以 UEFI 為基礎的系統上,NVRAM 包含指定系統開機設定的韌體環境變數。 如需所使用特定變數的相關信息,請參閱
舊版 BIOS 型系統上不支援韌體變數。 GetFirmwareEnvironmentVariable 函式在舊版 BIOS 型系統上一律會失敗,或在支援舊版 BIOS 和 UEFI 的系統上使用舊版 BIOS 安裝 Windows 時,一律會失敗。 若要識別這些條件,請使用虛擬韌體環境名稱呼叫函式,例如 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 應用程式] |
目標平臺 | 窗戶 |
標頭 | winbase.h (包括 Windows.h) |
連結庫 | Kernel32.lib |
DLL | Kernel32.dll |
另請參閱
GetFirmwareEnvironmentVariableEx