SetEnvironmentVariableA, fonction (processenv.h)
Définit le contenu de la variable d’environnement spécifiée pour le processus actuel.
Syntaxe
BOOL SetEnvironmentVariableA(
[in] LPCSTR lpName,
[in, optional] LPCSTR lpValue
);
Paramètres
[in] lpName
Nom de la variable d’environnement. Le système d’exploitation crée la variable d’environnement s’il n’existe pas et lpValue n’est pas NULL.
[in, optional] lpValue
Contenu de la variable d’environnement. La taille maximale d’une variable d’environnement définie par l’utilisateur est de 32 767 caractères. Pour plus d’informations, consultez Variables d’environnement.
Windows Server 2003 et Windows XP : La taille totale du bloc d’environnement pour un processus peut ne pas dépasser 32 767 caractères.
Si ce paramètre est NULL, la variable est supprimée de l’environnement du processus actuel.
Valeur de retour
Si la fonction réussit, la valeur de retour est 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.
Remarques
Cette fonction n’a aucun effet sur les variables d’environnement système ou sur les variables d’environnement d’autres processus.
Exemples
Pour obtenir un exemple, consultez modification des variables d’environnement.
Note
L’en-tête processenv.h définit SetEnvironmentVariable 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 XP [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2003 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | processenv.h (inclure Windows.h sur Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |