SetEnvironmentVariable, fonction (winbase.h)

Définit le contenu de la variable d’environnement spécifiée pour le processus actuel.

Syntaxe

BOOL SetEnvironmentVariable(
  [in]           LPCTSTR lpName,
  [in, optional] LPCTSTR 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.

Configuration requise

Voir aussi

Variables d’environnement

GetEnvironmentVariable