SetFirmwareEnvironmentVariableExA, fonction (winbase.h)
Définit la valeur de la variable d’environnement du microprogramme spécifiée en tant qu’attributs qui indiquent comment cette variable est stockée et conservée.
Syntaxe
BOOL SetFirmwareEnvironmentVariableExA(
[in] LPCSTR lpName,
[in] LPCSTR lpGuid,
[in] PVOID pValue,
[in] DWORD nSize,
[in] DWORD dwAttributes
);
Paramètres
[in] lpName
Nom de la variable d’environnement du microprogramme. Le pointeur ne doit pas être NULL.
[in] lpGuid
GUID qui représente l’espace de noms de la variable d’environnement du microprogramme. Le GUID doit être une chaîne au format « {xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} ». Si le système ne prend pas en charge les espaces de noms basés sur GUID, ce paramètre est ignoré. Le pointeur ne doit pas être NULL.
[in] pValue
Pointeur vers la nouvelle valeur de la variable d’environnement du microprogramme.
[in] nSize
Taille de la mémoire tampon pValue
[in] dwAttributes
Masque de bits pour définir les attributs de variable UEFI associés à la variable. Consultez également spécification UEFI 2.3.1, section 7.2.
| Valeur | Signification |
|---|---|
|
La variable d’environnement du microprogramme est stockée dans une mémoire non volatile (par exemple, NVRAM). |
|
La variable d’environnement du microprogramme est accessible pendant le service de démarrage. |
|
La variable d’environnement du microprogramme est accessible au moment de l’exécution.
Remarque Variables avec ce jeu d’attributs, doivent également avoir VARIABLE_ATTRIBUTE_BOOTSERVICE_ACCESS ensemble.
|
|
Indique les erreurs liées au matériel rencontrées lors de l’exécution. |
|
Indique une exigence d’authentification qui doit être remplie avant d’écrire dans cette variable d’environnement du microprogramme. Pour plus d’informations, consultez spécification UEFI 2.3.1. |
|
Indique les exigences d’authentification et d’horodatage qui doivent être remplies avant d’écrire dans cette variable d’environnement du microprogramme. Lorsque cet attribut est défini, la mémoire tampon, représentée par pValue, commence par une instance d’un descripteur complet (et sérialisé EFI_VARIABLE_AUTHENTICATION_2). Pour plus d’informations, consultez spécification UEFI 2.3.1. |
|
Ajoutez une variable d’environnement existante avec la valeur de pValue. Si le microprogramme ne prend pas en charge l’opération, SetFirmwareEnvironmentVariableEx retourne ERROR_INVALID_FUNCTION. |
Valeur de retour
Si la fonction réussit, la valeur de retour est une valeur différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError. Les codes d’erreur possibles incluent ERROR_INVALID_FUNCTION.
Remarques
À compter de Windows 10, version 1803, les applications Windows universelles peuvent lire et écrire des variables de microprogramme UEFI. Pour plus d’informations, consultez Accéder aux variables de microprogramme UEFI à partir d’une application Windows universelle.
À compter de Windows 10, version 1803, la lecture des variables de microprogramme UEFI est également prise en charge à partir de pilotes UMDF (User-Mode Driver Framework). L’écriture de variables de microprogramme UEFI à partir de pilotes UMDF n’est pas prise en charge.
Pour écrire une variable d’environnement de microprogramme, le compte d’utilisateur sous lequel l’application s’exécute doit avoir le privilège SE_SYSTEM_ENVIRONMENT_NAME. Une application Windows universelle doit être exécutée à partir d’un compte d’administrateur et respecter les exigences décrites dans Accéder aux variables de microprogramme UEFI à partir d’une application Windows universelle.
La méthode correcte de modification des attributs d’une variable consiste à supprimer la variable et à la recréer avec différents attributs.
L’ensemble exact de variables d’environnement du microprogramme est déterminé par le microprogramme de démarrage. L’emplacement de ces variables d’environnement est également spécifié par le microprogramme. Par exemple, sur un système UEFI, NVRAM contient des variables d’environnement de microprogramme qui spécifient les paramètres de démarrage du système. Pour plus d’informations sur des variables spécifiques utilisées, consultez la spécification UEFI. Pour plus d’informations sur UEFI et Windows, consultez UEFI et Windows.
Les variables de microprogramme ne sont pas prises en charge sur un système BIOS hérité. La fonction SetFirmwareEnvironmentVariableEx échoue toujours sur un système BIOS hérité ou si Windows a été installé à l’aide du BIOS hérité sur un système qui prend en charge le BIOS hérité et UEFI. Pour identifier ces conditions, appelez la fonction avec un nom d’environnement de microprogramme factice tel qu’une chaîne vide (« ») pour le paramètre lpName et un GUID factice tel que «{00000000-0000-0000-0000-000000000000}» pour le paramètre lpGuid. Sur un système BIOS hérité ou sur un système qui prend en charge le BIOS hérité et UEFI où Windows a été installé à l’aide du BIOS hérité, la fonction échoue avec ERROR_INVALID_FUNCTION. Sur un système UEFI, la fonction échoue avec une erreur spécifique au microprogramme, par exemple ERROR_NOACCESS, pour indiquer que l’espace de noms GUID factice n’existe pas.
Note
L’en-tête winbase.h définit SetFirmwareEnvironmentVariableEx comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows 8 [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2012 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | winbase.h (inclure Windows.h) |
| bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |
Voir aussi
Accéder aux variables de microprogramme UEFI à partir d’une application Windows universelle