Environment.SetEnvironmentVariable Méthode

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Crée, modifie ou supprime une variable d'environnement.

Surcharges

SetEnvironmentVariable(String, String)	Crée, modifie ou supprime une variable d'environnement stockée dans le processus en cours.
SetEnvironmentVariable(String, String, EnvironmentVariableTarget)	Crée, modifie ou supprime une variable d'environnement stockée dans le processus en cours ou dans la clé de Registre du système d'exploitation Windows réservée pour l'utilisateur ou l'ordinateur local actuel.

SetEnvironmentVariable(String, String)

Source:

Environment.cs

Crée, modifie ou supprime une variable d'environnement stockée dans le processus en cours.

public:
 static void SetEnvironmentVariable(System::String ^ variable, System::String ^ value);

public static void SetEnvironmentVariable (string variable, string? value);

static member SetEnvironmentVariable : string * string -> unit

Public Shared Sub SetEnvironmentVariable (variable As String, value As String)

Paramètres

variable

String

Nom d'une variable d'environnement.

value

String

Valeur à assigner à variable.

Exceptions

ArgumentNullException

variable a la valeur null.

ArgumentException

variable contient une chaîne de longueur nulle, un caractère zéro hexadécimal initial (0x00) ou un signe égal (« = »).

- ou -

La longueur de variable ou value est supérieure ou égale à 32 767 caractères.

- ou -

Une erreur s’est produite lors de l’exécution de cette opération.

SecurityException

L’appelant n’a pas l’autorisation nécessaire pour effectuer cette opération.

Exemples

L’exemple suivant tente de récupérer la valeur d’une variable d’environnement nommée Test1 à partir du bloc d’environnement de processus. Si la variable n’existe pas, l’exemple crée la variable et récupère sa valeur. L’exemple montre comment afficher la valeur de la variable . Pour les implémentations .NET exécutées sur des systèmes Windows, elle appelle également la GetEnvironmentVariables(EnvironmentVariableTarget) méthode avec chaque membre de l’énumération EnvironmentVariableTarget pour établir que la variable peut être récupérée uniquement à partir du bloc d’environnement de processus actuel. (Les implémentations .NET sur des systèmes de type Unix prennent uniquement en charge les variables dans le bloc d’environnement de processus.) Enfin, si l’exemple a créé la variable, il la supprime.

using System;

public class Example
{
   public static void Main()
   {
      string value;
      bool toDelete = false;

      // Check whether the environment variable exists.
      value = Environment.GetEnvironmentVariable("Test1");
      // If necessary, create it.
      if (value == null)
      {
         Environment.SetEnvironmentVariable("Test1", "Value1");
         toDelete = true;

         // Now retrieve it.
         value = Environment.GetEnvironmentVariable("Test1");
      }
      // Display the value.
      Console.WriteLine($"Test1: {value}\n");

      // Confirm that the value can only be retrieved from the process
      // environment block if running on a Windows system.
      if (Environment.OSVersion.Platform == PlatformID.Win32NT)
      {
         Console.WriteLine("Attempting to retrieve Test1 from:");
         foreach (EnvironmentVariableTarget enumValue in
                           Enum.GetValues(typeof(EnvironmentVariableTarget))) {
            value = Environment.GetEnvironmentVariable("Test1", enumValue);
            Console.WriteLine($"   {enumValue}: {(value != null ? "found" : "not found")}");
         }
         Console.WriteLine();
      }

      // If we've created it, now delete it.
      if (toDelete) {
         Environment.SetEnvironmentVariable("Test1", null);
         // Confirm the deletion.
         if (Environment.GetEnvironmentVariable("Test1") == null)
            Console.WriteLine("Test1 has been deleted.");
      }
   }
}
// The example displays the following output if run on a Windows system:
//      Test1: Value1
//
//      Attempting to retrieve Test1 from:
//         Process: found
//         User: not found
//         Machine: not found
//
//      Test1 has been deleted.
//
// The example displays the following output if run on a Unix-based system:
//      Test1: Value1
//
//      Test1 has been deleted.

module Example

open System

let mutable toDelete = false

// Check whether the environment variable exists.
let value = 
    let v = Environment.GetEnvironmentVariable "Test1"
    // If necessary, create it.
    if isNull v then
        Environment.SetEnvironmentVariable("Test1", "Value1")
        toDelete <- true
        Environment.GetEnvironmentVariable "Test1"
    else 
        v

// Display the value.
printfn $"Test1: {value}\n"

// Confirm that the value can only be retrieved from the process
// environment block if running on a Windows system.
if Environment.OSVersion.Platform = PlatformID.Win32NT then
    printfn "Attempting to retrieve Test1 from:"
    for enumValue in Enum.GetValues typeof<EnvironmentVariableTarget> do
        let value = Environment.GetEnvironmentVariable("Test1", enumValue :?> EnvironmentVariableTarget)
        printfn $"""   {enumValue}: {if value <> null then "found" else "not found"}"""
    printfn ""

// If we've created it, now delete it.
if toDelete then
    Environment.SetEnvironmentVariable("Test1", null)
    // Confirm the deletion.
    if Environment.GetEnvironmentVariable "Test1" |> isNull then
        printfn "Test1 has been deleted."
// The example displays the following output if run on a Windows system:
//      Test1: Value1
//
//      Attempting to retrieve Test1 from:
//         Process: found
//         User: not found
//         Machine: not found
//
//      Test1 has been deleted.
//
// The example displays the following output if run on a Unix-based system:
//      Test1: Value1
//
//      Test1 has been deleted.

Module Example
   Public Sub Main()
      Dim value As String 
      Dim toDelete As Boolean = False
      
      ' Check whether the environment variable exists.
      value = Environment.GetEnvironmentVariable("Test1")
      ' If necessary, create it.
      If value Is Nothing Then
         Environment.SetEnvironmentVariable("Test1", "Value1")
         toDelete = True
         
         ' Now retrieve it.
         value = Environment.GetEnvironmentVariable("Test1")
      End If
      ' Display the value.
      Console.WriteLine($"Test1: {value}")
      Console.WriteLine()
      
      ' Confirm that the value can only be retrieved from the process
      ' environment block if running on a Windows system.
      If Environment.OSVersion.Platform = PlatformID.Win32NT Then
         Console.WriteLine("Attempting to retrieve Test1 from:")
         For Each enumValue As EnvironmentVariableTarget In 
                           [Enum].GetValues(GetType(EnvironmentVariableTarget))
            value = Environment.GetEnvironmentVariable("Test1", enumValue)
            Console.WriteLine($"   {enumValue}: {If(value IsNot Nothing, "found", "not found")}")
         Next
         Console.WriteLine()
      End If

      ' If we've created it, now delete it.
      If toDelete Then 
         Environment.SetEnvironmentVariable("Test1", Nothing)
         ' Confirm the deletion.
         If Environment.GetEnvironmentVariable("Test1") = Nothing Then
            Console.WriteLine("Test1 has been deleted.")
         End If
      End If         
   End Sub
End Module
' The example displays the following output if run on a Windows system:
'      Test1: Value1
'
'      Attempting to retrieve Test1 from:
'         Process: found
'         User: not found
'         Machine: not found
'
'      Test1 has been deleted.
'
' The example displays the following output if run on a Unix-based system:
'      Test1: Value1
'
'      Test1 has been deleted.

Remarques

L’appel de cette méthode revient à appeler la SetEnvironmentVariable(String, String, EnvironmentVariableTarget) surcharge avec la valeur pour EnvironmentVariableTarget.Process l’argument target .

Sur les systèmes de type Unix, les appels à la SetEnvironmentVariable(String, String) méthode n’ont aucun effet sur les bibliothèques natives qui sont ou seront chargées. (À l’inverse, les modifications de l’environnement in-process effectuées par les bibliothèques natives ne sont pas vues par les appelants managés.)

Si l’argument value n’est pas vide (voir la discussion sur la suppression d’une variable d’environnement plus loin dans cette section pour la définition d’une valeur vide) et que la variable d’environnement nommée par le variable paramètre n’existe pas, la variable d’environnement est créée et affectée au contenu de value. S’il existe, sa valeur est modifiée. Étant donné que la variable d’environnement est définie dans le bloc d’environnement du processus actuel uniquement, elle ne persiste pas une fois le processus terminé.

Si variable contient un caractère zéro hexadécimal non initial, les caractères avant le caractère zéro sont considérés comme le nom de la variable d’environnement et tous les caractères suivants sont ignorés.

Si value contient un zéro hexadécimal non initial, les caractères avant le caractère zéro sont affectés à la variable d’environnement et tous les caractères suivants sont ignorés.

Si value est vide et que la variable d’environnement nommée par variable existe, la variable d’environnement est supprimée. Si variable n’existe pas, aucune erreur ne se produit même si l’opération ne peut pas être effectuée. value est considéré comme vide dans l’une des conditions suivantes :

• Il s’agit de null.
• Il s’agit de String.Empty.
• Il se compose d’un caractère unique dont la valeur est U+0000.

Voir aussi

• GetEnvironmentVariable(String)
• GetEnvironmentVariables()

SetEnvironmentVariable(String, String, EnvironmentVariableTarget)

Source:

Environment.cs

Crée, modifie ou supprime une variable d'environnement stockée dans le processus en cours ou dans la clé de Registre du système d'exploitation Windows réservée pour l'utilisateur ou l'ordinateur local actuel.

public:
 static void SetEnvironmentVariable(System::String ^ variable, System::String ^ value, EnvironmentVariableTarget target);

public static void SetEnvironmentVariable (string variable, string? value, EnvironmentVariableTarget target);

static member SetEnvironmentVariable : string * string * EnvironmentVariableTarget -> unit

Public Shared Sub SetEnvironmentVariable (variable As String, value As String, target As EnvironmentVariableTarget)

Paramètres

variable

String

Nom d'une variable d'environnement.

value

String

Valeur à assigner à variable.

target

EnvironmentVariableTarget

Une des valeurs d'énumération qui spécifie l'emplacement de la variable d'environnement.

Exceptions

ArgumentNullException

variable a la valeur null.

ArgumentException

variable contient une chaîne de longueur nulle, un caractère zéro hexadécimal initial (0x00) ou un signe égal (« = »).

- ou -

La longueur de variable est supérieure ou égale à 32 767 caractères.

- ou -

target n’est pas membre de l’énumération EnvironmentVariableTarget .

- ou -

target est Machine ou User, et la longueur de variable est supérieure ou égale à 255.

- ou -

target est Process , et la longueur de value est supérieure ou égale à 32 767 caractères.

- ou -

Une erreur s’est produite lors de l’exécution de cette opération.

SecurityException

L’appelant n’a pas l’autorisation nécessaire pour effectuer cette opération.

Exemples

L’exemple suivant crée des variables d’environnement pour les EnvironmentVariableTarget.Processcibles , EnvironmentVariableTarget.Useret Machine vérifie si le registre du système d’exploitation contient les variables d’environnement utilisateur et machine, puis supprime les variables d’environnement. Étant donné que .NET sur les systèmes de type Unix ne prend pas en charge les variables d’environnement par utilisateur et par machine, seuls SetEnvironmentVariable(String, String) et SetEnvironmentVariable(String, String, EnvironmentVariableTarget) avec la valeur EnvironmentVariableTarget.Process de stocker correctement une variable d’environnement dans le bloc d’environnement de processus.

using System;
using System.Collections;
using Microsoft.Win32;

class Sample
{
    public static void Main()
    {
        // Environment variable names for default, process, user, and machine targets.
        string defaultEnvVar = nameof(defaultEnvVar);
        string processEnvVar = nameof(processEnvVar);
        string userEnvVar = nameof(userEnvVar);
        string machineEnvVar = nameof(machineEnvVar);

        string dft = nameof(dft);
        string process = nameof(process);
        string user = nameof(user);
        string machine = nameof(machine);

        // Set the environment variable for each target.
        Console.WriteLine("Setting environment variables for each target...\n");
        // The default target (the current process).
        Environment.SetEnvironmentVariable(defaultEnvVar, dft);
        // The current process.
        Environment.SetEnvironmentVariable(processEnvVar, process,
                                           EnvironmentVariableTarget.Process);
        // The current user.
        Environment.SetEnvironmentVariable(userEnvVar, user,
                                           EnvironmentVariableTarget.User);
        // The local machine.
        Environment.SetEnvironmentVariable(machineEnvVar, machine,
                                           EnvironmentVariableTarget.Machine);

        // Define an array of environment variables.
        string[] envVars = { defaultEnvVar,processEnvVar, userEnvVar, machineEnvVar };

        // Try to get the environment variables from each target.
        // The default (no specified target).
        Console.WriteLine("Retrieving environment variables from the default target:");
        foreach (var envVar in envVars)
        {
          var value = Environment.GetEnvironmentVariable(envVar) ?? "(none)";
          Console.WriteLine($"   {envVar}: {value}");
        }
        // The process block.
        Console.WriteLine("\nRetrieving environment variables from the Process target:");
        foreach (var envVar in envVars)
        {
          var value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Process) ?? "(none)";
          Console.WriteLine($"   {envVar}: {value}");
        }
        // The user block.
        Console.WriteLine("\nRetrieving environment variables from the User target:");
        foreach (var envVar in envVars)
        {
          var value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.User) ?? "(none)";
          Console.WriteLine($"   {envVar}: {value}");
        }
        // The machine block.
        Console.WriteLine("\nRetrieving environment variables from the Machine target:");
        foreach (var envVar in envVars)
        {
          var value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Machine) ?? "(none)";
          Console.WriteLine($"   {envVar}: {value}");
        }

        // Delete the environment variable for each target.
        Console.WriteLine("\nDeleting environment variables for each target...\n");
        // The default target (the current process).
        Environment.SetEnvironmentVariable(defaultEnvVar, null);
        // The current process.
        Environment.SetEnvironmentVariable(processEnvVar, null,
                                           EnvironmentVariableTarget.Process);
        // The current user.
        Environment.SetEnvironmentVariable(userEnvVar, null,
                                           EnvironmentVariableTarget.User);
        // The local machine.
        Environment.SetEnvironmentVariable(machineEnvVar, null,
                                           EnvironmentVariableTarget.Machine);
    }
}
// The example displays the following output if run on a Windows system:
//      Setting environment variables for each target...
//
//      Retrieving environment variables from the default target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Process target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the User target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Machine target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: machine
//
//      Deleting environment variables for each target...
//
// The example displays the following output if run on a Unix-based system:
//
//      Setting environment variables for each target...
//
//      Retrieving environment variables from the default target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Process target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the User target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Machine target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Deleting environment variables for each target...

module Sample

open System

// Environment variable names for default, process, user, and machine targets.
let rec defaultEnvVar = nameof defaultEnvVar
let rec processEnvVar = nameof processEnvVar
let rec userEnvVar = nameof userEnvVar
let rec machineEnvVar = nameof machineEnvVar

let rec dft = nameof dft
let rec proc = nameof proc
let rec user = nameof user
let rec machine = nameof machine

// Set the environment variable for each target.
printfn "Setting environment variables for each target...\n"
// The default target (the current process).
Environment.SetEnvironmentVariable(defaultEnvVar, dft)
// The current process.
Environment.SetEnvironmentVariable(processEnvVar, proc, EnvironmentVariableTarget.Process)
// The current user.
Environment.SetEnvironmentVariable(userEnvVar, user, EnvironmentVariableTarget.User)
// The local machine.
Environment.SetEnvironmentVariable(machineEnvVar, machine, EnvironmentVariableTarget.Machine)

// Define a list of environment variables.
let envVars = [ defaultEnvVar; processEnvVar; userEnvVar; machineEnvVar ]

// Try to get the environment variables from each target.
// The default (no specified target).
printfn "Retrieving environment variables from the default target:"
for envVar in envVars do
    let value = 
        match Environment.GetEnvironmentVariable envVar with
        | null -> "(none)"
        | v -> v
    printfn $"   {envVar}: {value}"

// The process block.
printfn "\nRetrieving environment variables from the Process target:"
for envVar in envVars do
    let value = 
        match Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Process) with
        | null -> "(none)"
        | v -> v
    printfn $"   {envVar}: {value}"

// The user block.
printfn "\nRetrieving environment variables from the User target:"
for envVar in envVars do
    let value = 
        match Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.User) with
        | null -> "(none)"
        | v -> v
    printfn $"   {envVar}: {value}"

// The machine block.
printfn "\nRetrieving environment variables from the Machine target:"
for envVar in envVars do
    let value = 
        match Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Machine) with
        | null -> "(none)"
        | v -> v
    printfn $"   {envVar}: {value}"

// Delete the environment variable for each target.
printfn "\nDeleting environment variables for each target...\n"
// The default target (the current process).
Environment.SetEnvironmentVariable(defaultEnvVar, null)
// The current process.
Environment.SetEnvironmentVariable(processEnvVar, null, EnvironmentVariableTarget.Process)
// The current user.
Environment.SetEnvironmentVariable(userEnvVar, null, EnvironmentVariableTarget.User)
// The local machine.
Environment.SetEnvironmentVariable(machineEnvVar, null, EnvironmentVariableTarget.Machine)

// The example displays the following output if run on a Windows system:
//      Setting environment variables for each target...
//
//      Retrieving environment variables from the default target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Process target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the User target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: user
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Machine target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: machine
//
//      Deleting environment variables for each target...
//
// The example displays the following output if run on a Unix-based system:
//
//      Setting environment variables for each target...
//
//      Retrieving environment variables from the default target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Process target:
//        defaultEnvVar: dft
//        processEnvVar: process
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the User target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Retrieving environment variables from the Machine target:
//        defaultEnvVar: (none)
//        processEnvVar: (none)
//        userEnvVar: (none)
//        machineEnvVar: (none)
//
//      Deleting environment variables for each target...

Imports System.Collections
Imports Microsoft.Win32

Module Sample 
    Public Sub Main() 
        ' Environment variable names for default, process, user, and machine targets.
        Dim defaultEnvVar As String = NameOf(defaultEnvVar)
        Dim processEnvVar As String = NameOf(processEnvVar)
        Dim userEnvVar As String = NameOf(userEnvVar)
        Dim machineEnvVar As String = NameOf(machineEnvVar)

        Dim dft As String = NameOf(dft)
        Dim process As String = NameOf(process)
        Dim user As String = NameOf(user)
        Dim machine As String = NameOf(machine)

        ' Set the environment variable for each target.
        Console.WriteLine("Setting environment variables for each target...")
        ' The default target (the current process).
        Environment.SetEnvironmentVariable(defaultEnvVar, dft)
        ' The current process.
        Environment.SetEnvironmentVariable(processEnvVar, process, 
                                           EnvironmentVariableTarget.Process)
        ' The current user.
        Environment.SetEnvironmentVariable(userEnvVar, user, 
                                           EnvironmentVariableTarget.User)
        ' The local machine.
        Environment.SetEnvironmentVariable(machineEnvVar, machine, 
                                           EnvironmentVariableTarget.Machine)
        Console.WriteLine()

        ' Define an array of environment variables.
        Dim envVars As String() = { defaultEnvVar, processEnvVar, userEnvVar, machineEnvVar }
        
        ' Try to get the environment variables from each target.
        ' The default (no specified target).
        Console.WriteLine("Retrieving environment variables from the default target:")
        For Each envVar in envVars
          Dim value = Environment.GetEnvironmentVariable(envVar)
          Console.WriteLine($"   {envVar}: {If(value IsNot Nothing, value, "(none)")}")
        Next
        Console.WriteLine()
        ' The process block.
        Console.WriteLine("Retrieving environment variables from the Process target:")
        For Each envVar in envVars
          Dim value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Process)
          Console.WriteLine($"   {envVar}: {If(value IsNot Nothing, value, "(none)")}")
        Next
        Console.WriteLine()
        ' The user block.
        Console.WriteLine("Retrieving environment variables from the User target:")
        For Each envVar in envVars
          Dim value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.User)
          Console.WriteLine($"   {envVar}: {value}")
        Next
        Console.WriteLine()
        ' The machine block.
        Console.WriteLine("Retrieving environment variables from the Machine target:")
        For Each envVar in envVars
          Dim value = Environment.GetEnvironmentVariable(envVar, EnvironmentVariableTarget.Machine)
          Console.WriteLine($"   {envVar}: {value}")
        Next
        Console.WriteLine()

        ' Delete the environment variable for each target.
        Console.WriteLine("Deleting environment variables for each target...")
        ' The default target (the current process).
        Environment.SetEnvironmentVariable(defaultEnvVar, Nothing)
        ' The current process.
        Environment.SetEnvironmentVariable(processEnvVar, Nothing, 
                                           EnvironmentVariableTarget.Process)
        ' The current user.
        Environment.SetEnvironmentVariable(userEnvVar, Nothing, 
                                           EnvironmentVariableTarget.User)
        ' The local machine.
        Environment.SetEnvironmentVariable(machineEnvVar, Nothing, 
                                           EnvironmentVariableTarget.Machine)
    End Sub
End Module
' The example displays the following output if run on a Windows system:
'      Setting environment variables for each target...
'
'      Retrieving environment variables from the default target:
'        defaultEnvVar: dft
'        processEnvVar: process
'        userEnvVar: user
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the Process target:
'        defaultEnvVar: dft
'        processEnvVar: process
'        userEnvVar: user
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the User target:
'        defaultEnvVar: (none)
'        processEnvVar: (none)
'        userEnvVar: user
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the Machine target:
'        defaultEnvVar: (none)
'        processEnvVar: (none)
'        userEnvVar: (none)
'        machineEnvVar: machine
'
'      Deleting environment variables for each target...
'
' The example displays the following output if run on a Unix-based system:
'
'      Setting environment variables for each target...
'
'      Retrieving environment variables from the default target:
'        defaultEnvVar: dft
'        processEnvVar: process
'        userEnvVar: (none)
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the Process target:
'        defaultEnvVar: dft
'        processEnvVar: process
'        userEnvVar: (none)
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the User target:
'        defaultEnvVar: (none)
'        processEnvVar: (none)
'        userEnvVar: (none)
'        machineEnvVar: (none)
'
'      Retrieving environment variables from the Machine target:
'        defaultEnvVar: (none)
'        processEnvVar: (none)
'        userEnvVar: (none)
'        machineEnvVar: (none)
'
'      Deleting environment variables for each target...

Remarques

La SetEnvironmentVariable(String, String, EnvironmentVariableTarget) méthode vous permet de définir une variable d’environnement disponible pour le processus actuel (la Process valeur). Les variables d’environnement propres au bloc d’environnement de processus actuel sont conservées uniquement jusqu’à la fin du processus.

En outre, sur les systèmes Windows uniquement, la SetEnvironmentVariable(String, String, EnvironmentVariableTarget) méthode vous permet de définir une variable d’environnement disponible pour tous les processus qui s’exécutent sur un ordinateur (la EnvironmentVariableTarget.Machine valeur) et pour tous les processus exécutés par un utilisateur (la EnvironmentVariableTarget.User valeur). Les variables d’environnement par ordinateur et par utilisateur sont copiées dans le bloc d’environnement du processus actuel.

Sur les systèmes de type Unix, les appels à la SetEnvironmentVariable(String, String, EnvironmentVariableTarget) méthode avec la valeur EnvironmentVariableTarget.Machine ou EnvironmentVariableTarget.User sont ignorés.

Sur les systèmes de type Unix, les appels à la SetEnvironmentVariable(String, String, EnvironmentVariableTarget) méthode avec une valeur de EnvironmentVariableTarget.Process n’ont aucun effet sur les bibliothèques natives qui sont, ou seront, chargées. (À l’inverse, les modifications de l’environnement in-process effectuées par les bibliothèques natives ne sont pas vues par les appelants managés.)

Si l’argument value n’est pas vide (voir la discussion sur la suppression d’une variable d’environnement plus loin dans cette section pour la définition d’une valeur vide) et que la variable d’environnement nommée par l’argument variable n’existe pas, la variable d’environnement est créée et affectée au contenu de value. S’il existe, sa valeur est modifiée.

Si variable contient un caractère zéro hexadécimal non initial, les caractères avant le caractère zéro sont considérés comme le nom de la variable d’environnement et tous les caractères suivants sont ignorés.

Si value contient un zéro hexadécimal non initial, les caractères avant le caractère zéro sont affectés à la variable d’environnement et tous les caractères suivants sont ignorés.

Si value est vide et que la variable d’environnement nommée par variable existe, la variable d’environnement est supprimée. value est considéré comme vide dans l’une des conditions suivantes :

• Il s’agit de null.
• Il s’agit de String.Empty.
• Il se compose d’un caractère unique dont la valeur est U+0000.

Si variable n’existe pas, aucune erreur ne se produit, bien que l’opération ne puisse pas être effectuée. Soyez prudent lorsque target est Machine, car vous pouvez supprimer accidentellement une variable d’environnement qui affecte l’ensemble de votre ordinateur local, pas seulement le processus ou l’utilisateur actuel.

EnvironmentVariableTarget.Machine et EnvironmentVariableTarget.User sur les systèmes Windows

Si target a la valeur EnvironmentVariableTarget.User, la variable d’environnement est stockée dans la clé HKEY_CURRENT_USER\Environment du registre de l’ordinateur local. Il est également copié dans des instances de Explorateur de fichiers qui s’exécutent en tant qu’utilisateur actuel. La variable d’environnement est ensuite héritée par les nouveaux processus que l’utilisateur lance à partir de Explorateur de fichiers.

De même, si target a EnvironmentVariableTarget.Machinela valeur , la variable d’environnement est stockée dans la clé HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment du registre de l’ordinateur local. Il est également copié dans toutes les instances de Explorateur de fichiers. La variable d’environnement est ensuite héritée par tous les nouveaux processus lancés à partir de Explorateur de fichiers.

Si target est User ou Machine, d’autres applications sont averties de l’opération set par un message Windows WM_SETTINGCHANGE .

Si target est EnvironmentVariableTarget.User ou EnvironmentVariableTarget.Machine, nous recommandons que la longueur de value soit inférieure à 2 048 caractères.

Voir aussi

• GetEnvironmentVariable(String, EnvironmentVariableTarget)
• GetEnvironmentVariables(EnvironmentVariableTarget)
• EnvironmentVariableTarget