Funzione GetFirmwareEnvironmentVariableExA (winbase.h)

  • Articolo

Recupera il valore della variabile di ambiente firmware specificata e dei relativi attributi.

Sintassi

DWORD GetFirmwareEnvironmentVariableExA(
  LPCSTR lpName,
  LPCSTR lpGuid,
  PVOID  pBuffer,
  DWORD  nSize,
  PDWORD pdwAttribubutes
);

Parametri

lpName

Nome della variabile di ambiente del firmware. Il puntatore non deve essere NULL.

lpGuid

GUID che rappresenta lo spazio dei nomi della variabile di ambiente del firmware. Il GUID deve essere una stringa nel formato "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" dove 'x' rappresenta un valore esadecimale. Il puntatore non deve essere NULL.

pBuffer

Puntatore a un buffer che riceve il valore della variabile di ambiente firmware specificata.

nSize

Dimensioni del buffer pValue , in byte.

pdwAttribubutes

Maschera di bit che identifica gli attributi della variabile UEFI associati alla variabile. Per la definizione della maschera di bit, vedere SetFirmwareEnvironmentVariableEx .

Valore restituito

Se la funzione ha esito positivo, il valore restituito corrisponde al numero di byte archiviati nel buffer pValue .

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError. I codici di errore possibili includono ERROR_INVALID_FUNCTION.

Commenti

A partire da Windows 10 versione 1803, le app di Windows universali possono leggere e scrivere variabili del firmware UEFI. Per informazioni dettagliate, vedere Accedere alle variabili del firmware UEFI da un'app di Windows universale .

Per leggere una variabile di ambiente del firmware UEFI, l'account utente in cui è in esecuzione l'app deve avere il privilegio SE_SYSTEM_ENVIRONMENT_NAME . Un'app di Windows universale deve essere eseguita da un account amministratore e seguire i requisiti descritti in Accedere alle variabili del firmware UEFI da un'app di Windows universale.

A partire da Windows 10 versione 1803, la lettura delle variabili UEFI (Unified Extensible Firmware Interface) è supportata anche dai driver User-Mode Driver Framework (UMDF). La scrittura di variabili UEFI dai driver UMDF non è supportata.

Il set esatto di variabili di ambiente del firmware è determinato dal firmware di avvio. La posizione di queste variabili di ambiente viene specificata anche dal firmware. Ad esempio, in un sistema basato su UEFI, NVRAM contiene variabili di ambiente del firmware che specificano le impostazioni di avvio del sistema. Per informazioni sulle variabili specifiche usate, vedere la specifica UEFI. Per altre informazioni su UEFI e Windows, vedere UEFI e Windows.

Le variabili del firmware non sono supportate in un sistema basato su BIOS legacy. La funzione GetFirmwareEnvironmentVariableEx avrà sempre esito negativo in un sistema legacy basato su BIOS o se Windows è stato installato usando bios legacy in un sistema che supporta sia BIOS legacy che UEFI. Per identificare queste condizioni, chiamare la funzione con un nome di ambiente firmware fittizio, ad esempio una stringa vuota ("") per il parametro lpName e un GUID fittizio, ad esempio "{00000000-0000-0000-0000-000000000000}" per il parametro lpGuid . In un sistema basato su BIOS legacy o in un sistema che supporta sia BIOS legacy che UEFI in cui Windows è stato installato tramite BIOS legacy, la funzione avrà esito negativo con ERROR_INVALID_FUNCTION. In un sistema basato su UEFI, la funzione avrà esito negativo con un errore specifico del firmware, ad esempio ERROR_NOACCESS, per indicare che lo spazio dei nomi GUID fittizio non esiste.

Se si crea un'applicazione di backup, è possibile usare questa funzione per salvare tutte le impostazioni di avvio per il sistema in modo che possano essere ripristinate usando la funzione SetFirmwareEnvironmentVariable , se necessario.

Nota

L'intestazione winbase.h definisce GetFirmwareEnvironmentVariableEx come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito Valore
Client minimo supportato Windows 8 [app desktop | App UWP]
Server minimo supportato Windows Server 2012 [app desktop | App UWP]
Piattaforma di destinazione Windows
Intestazione winbase.h (include Windows.h)
Libreria Kernel32.lib
DLL Kernel32.dll

Vedere anche

Accedere alle variabili del firmware UEFI da un'app di Windows universale

GetFirmwareEnvironmentVariable

SetFirmwareEnvironmentVariableEx