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 si elle n’existe pas et si lpValue n’a pas la valeur 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 d’un processus ne peut pas dépasser 32 767 caractères.

Si ce paramètre a la valeur NULL, la variable est supprimée de l’environnement du processus actuel.

Valeur retournée

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étaillées sur l’erreur, appelez GetLastError.

Remarques

Cette fonction n’a aucun effet sur les variables d’environnement système ou les variables d’environnement d’autres processus.

Exemples

Pour obtenir un exemple, consultez Modification des variables d’environnement.

Notes

L’en-tête processenv.h définit SetEnvironmentVariable en tant qu’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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau | applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau | applications UWP]
Plateforme cible	Windows
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

Voir aussi

Variables d’environnement

GetEnvironmentVariable