Environment.SetEnvironmentVariable Метод

Исходный код:

Environment.cs

Исходный код:

Environment.cs

Исходный код:

Environment.cs

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

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

Параметры

Исключения

Примеры

В следующем примере выполняется попытка получить значение переменной среды с именем Test1 из блока среды процесса. Если переменная не существует, в примере создается переменная и извлекается его значение. В примере отображается значение переменной. Для реализаций .NET, работающих в системах Windows, он также вызывает метод GetEnvironmentVariables(EnvironmentVariableTarget) с каждым членом перечисления EnvironmentVariableTarget, чтобы установить, что переменная может быть получена только из текущего блока среды процесса. (Реализации .NET в таких системах unix поддерживают только переменные в блоке среды процесса.) Наконец, если в примере была создана переменная, она удаляет ее.

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.

Комментарии

Вызов этого метода эквивалентен вызову перегрузки SetEnvironmentVariable(String, String, EnvironmentVariableTarget) со значением EnvironmentVariableTarget.Process для аргумента target.

В системах, таких как Unix, вызовы метода SetEnvironmentVariable(String, String) не влияют на собственные библиотеки, которые являются или будут загружены. (И наоборот, изменения среды внутри процесса, внесенные собственными библиотеками, не рассматриваются вызывающими пользователями.)

Если аргумент value не null и переменная среды с именем параметра variable не существует, то переменная среды создается и назначается содержимое value. Если он существует, его значение изменяется. Так как переменная среды определена только в блоке среды текущего процесса, она не сохраняется после завершения процесса.

Если variable содержит неинициальный шестнадцатеричный нулевой знак, символы до нуля считаются именем переменной среды, а все последующие символы игнорируются.

Если value содержит неинициальный шестнадцатеричный нулевой знак, то символы до назначения нулевого символа переменной среды и все последующие символы игнорируются.

Если valuenull (или пуст в версиях до .NET 9), а переменная среды с именем variable существует, переменная среды удаляется. Если variable не существует, ошибка не возникает, даже если операция не может быть выполнена. value считается пустым в любом из следующих условий:

• Это String.Empty.
• Он состоит из одного символа, значение которого равно U+0000.

См. также раздел

• GetEnvironmentVariable(String)
• GetEnvironmentVariables()

Исходный код:

Environment.cs

Исходный код:

Environment.cs

Исходный код:

Environment.cs

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

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

Параметры

Исключения

Примеры

В следующем примере создаются переменные среды для EnvironmentVariableTarget.Process, EnvironmentVariableTarget.Userи целевых объектов Machine, проверяет, содержит ли реестр операционных систем переменные среды пользователя и компьютера, а затем удаляет переменные среды среды. Так как .NET в таких системах, как Unix, не поддерживает переменные среды для каждого пользователя и на компьютере, SetEnvironmentVariable(String, String) и SetEnvironmentVariable(String, String, EnvironmentVariableTarget) со значением EnvironmentVariableTarget.Process успешно хранить переменную среды в блоке среды процесса.

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...

Комментарии

Метод SetEnvironmentVariable(String, String, EnvironmentVariableTarget) позволяет определить переменную среды, доступную для текущего процесса (значение Process). Переменные среды, уникальные для текущего блока среды процесса, сохраняются только до завершения процесса.

Кроме того, только в системах Windows метод SetEnvironmentVariable(String, String, EnvironmentVariableTarget) позволяет определить переменную среды, доступную для всех процессов, выполняемых на компьютере (значение EnvironmentVariableTarget.Machine) и для всех процессов, выполняемых пользователем (значением EnvironmentVariableTarget.User). Переменные среды для каждого компьютера и каждого пользователя копируются в блок среды текущего процесса.

В таких системах Unix вызовы метода SetEnvironmentVariable(String, String, EnvironmentVariableTarget) со значением EnvironmentVariableTarget.Machine или EnvironmentVariableTarget.User игнорируются.

В таких системах Unix вызовы метода SetEnvironmentVariable(String, String, EnvironmentVariableTarget) со значением EnvironmentVariableTarget.Process не влияют на собственные библиотеки, которые являются или будут загружены. (И наоборот, изменения среды внутри процесса, внесенные собственными библиотеками, не рассматриваются вызывающими пользователями.)

Если аргумент value не null и переменная среды, именуемая аргументом variable, не существует, то переменная среды создается и назначается содержимое value. Если он существует, его значение изменяется.

Если variable содержит неинициальный шестнадцатеричный нулевой знак, символы до нуля считаются именем переменной среды, а все последующие символы игнорируются.

Если value содержит неинициальный шестнадцатеричный нулевой знак, то символы до назначения нулевого символа переменной среды и все последующие символы игнорируются.

Если valuenull (или пуст в версиях до .NET 9), а переменная среды с именем variable существует, переменная среды удаляется. value считается пустым в любом из следующих условий:

• Это String.Empty.
• Он состоит из одного символа, значение которого равно U+0000.

Если variable не существует, ошибка не возникает, хотя операция не может быть выполнена. Будьте осторожны, если targetMachine, так как вы можете случайно удалить переменную среды, которая влияет на весь локальный компьютер, а не только на текущий процесс или пользователя.

EnvironmentVariableTarget.Machine и EnvironmentVariableTarget.User в системах Windows

Если targetEnvironmentVariableTarget.User, переменная среды хранится в разделе HKEY_CURRENT_USER\Environment реестра локального компьютера. Он также копируется в экземпляры проводника, которые выполняются в качестве текущего пользователя. Затем переменная среды наследуется любыми новыми процессами, запускаемыми пользователем из проводника.

Аналогичным образом, если targetEnvironmentVariableTarget.Machine, переменная среды хранится в разделе HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Session Manager\Environment реестра локального компьютера. Он также копируется во все экземпляры проводника. Затем переменная среды наследуется любыми новыми процессами, запускаемыми из проводника.

Если targetUser или Machine, другие приложения уведомляются об операции установки сообщением WM_SETTINGCHANGE Windows.

Если targetEnvironmentVariableTarget.User или EnvironmentVariableTarget.Machine, рекомендуется, чтобы длина value была меньше 2048 символов.

См. также раздел

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