Environment.SetEnvironmentVariable Метод

Определение

Пространство имен:: System

Сборки:: mscorlib.dll, System.Runtime.Extensions.dll

Сборки:: netstandard.dll, System.Runtime.dll

Сборка:: System.Runtime.Extensions.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Создает, изменяет или удаляет переменную среды.

Перегрузки

Имя	Описание
SetEnvironmentVariable(String, String)	Создает, изменяет или удаляет переменную среды, хранящуюся в текущем процессе.
SetEnvironmentVariable(String, String, EnvironmentVariableTarget)	Создает, изменяет или удаляет переменную среды, хранящуюся в текущем процессе или в разделе реестра операционной системы Windows, зарезервированном для текущего пользователя или локального компьютера.

SetEnvironmentVariable(String, String)

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Создает, изменяет или удаляет переменную среды, хранящуюся в текущем процессе.

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

public static void SetEnvironmentVariable(string variable, 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)

Параметры

variable: String

Имя переменной среды.

value: String

Значение для назначения variable.

Исключения

ArgumentNullException

variable равно null.

ArgumentException

variable содержит строку нулевой длины, начальный шестнадцатеричный нулевой знак (0x00) или знак равенства ("=").

–или–

Длина variable или value больше или равна 32 767 символам.

–или–

Произошла ошибка во время выполнения этой операции.

SecurityException

Вызывающий объект не имеет требуемого разрешения для выполнения этой операции.

Примеры

В следующем примере выполняется попытка получить значение переменной среды с именем 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.

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.

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

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

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

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

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

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

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

Применяется к

SetEnvironmentVariable(String, String, EnvironmentVariableTarget)

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Исходный код:: Environment.cs

Создает, изменяет или удаляет переменную среды, хранящуюся в текущем процессе или в разделе реестра операционной системы Windows, зарезервированном для текущего пользователя или локального компьютера.

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

public static void SetEnvironmentVariable(string variable, 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)

Параметры

variable: String

Имя переменной среды.

value: String

Значение для назначения variable.

target: EnvironmentVariableTarget

Одно из значений перечисления, указывающее расположение переменной среды.

Исключения

ArgumentNullException

variable равно null.

ArgumentException

variable содержит строку нулевой длины, начальный шестнадцатеричный нулевой знак (0x00) или знак равенства ("=").

–или–

Длина variable больше или равна 32 767 символам.

–или–

target не является членом перечисления EnvironmentVariableTarget .

–или–

target имеет Machine значение или User, а длина variable больше или равна 255.

–или–

target имеет Process значение и длина value больше или равна 32 767 символам.

–или–

Произошла ошибка во время выполнения этой операции.

SecurityException

Вызывающий объект не имеет требуемого разрешения для выполнения этой операции.

Примеры

В следующем примере создаются переменные среды для 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...

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

Этот 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. Если он существует, его значение изменяется.

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

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

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

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

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

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

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

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

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

Применяется к

Обратная связь

Были ли сведения на этой странице полезными?

Environment.SetEnvironmentVariable Метод

Определение

Перегрузки

SetEnvironmentVariable(String, String)

Параметры

Исключения

Примеры

Комментарии

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

Применяется к

SetEnvironmentVariable(String, String, EnvironmentVariableTarget)

Параметры

Исключения

Примеры

Комментарии

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

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

Применяется к