Environment.GetEnvironmentVariable Método

Definición

Espacio de nombres:

System

Ensamblado:

System.Runtime.dll

Recupera el valor de una variable de entorno.

Sobrecargas

GetEnvironmentVariable(String)	Recupera el valor de una variable de entorno del proceso actual.
GetEnvironmentVariable(String, EnvironmentVariableTarget)	Recupera el valor de una variable de entorno del proceso actual o de la clave del Registro del sistema operativo Windows para la máquina local o el usuario actual.

GetEnvironmentVariable(String)

Source:

Environment.cs

Recupera el valor de una variable de entorno del proceso actual.

C#

public static string? GetEnvironmentVariable (string variable);

Parámetros

variable

String

Nombre de la variable de entorno.

Devoluciones

String

El valor de la variable de entorno especificada por variable o null si no se encuentra la variable de entorno.

Excepciones

ArgumentNullException

variable es null.

SecurityException

El autor de la llamada no tiene el permiso requerido para llevar a cabo esta operación.

Ejemplos

En el ejemplo siguiente se usa el GetEnvironmentVariable método para recuperar la windir variable de entorno, que contiene la ruta de acceso del directorio de Windows.

C#

using System;
using System.IO;

public class Example
{
   public static void Main()
   {
      if (Environment.OSVersion.Platform == PlatformID.Win32NT)
      {
         // Change the directory to %WINDIR%
         Environment.CurrentDirectory = Environment.GetEnvironmentVariable("windir");
         DirectoryInfo info = new DirectoryInfo(".");

         Console.WriteLine("Directory Info:   " + info.FullName);
      }
      else
      {
         Console.WriteLine("This example runs on Windows only.");
      }
   }
}
// The example displays output like the following on a .NET implementation running on Windows:
//        Directory Info:   C:\windows
// The example displays the following output on a .NET implementation on Unix-based systems:
//        This example runs on Windows only.

En el ejemplo siguiente se intenta recuperar el valor de una variable de entorno denominada Test1 del bloque de entorno de proceso. Si la variable no existe, el ejemplo lo crea y recupera su valor. En el ejemplo se muestra el valor de la variable . Si el ejemplo creó la variable, también llama al GetEnvironmentVariables(EnvironmentVariableTarget) método con cada miembro de la EnvironmentVariableTarget enumeración para establecer que la variable solo se puede recuperar del bloque de entorno de proceso actual. Por último, si el ejemplo creó la variable , la elimina.

C#

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.

Comentarios

Para obtener más información sobre esta API, consulte Comentarios complementarios de la API para Environment.GetEnvironmentVariable.

Consulte también

• GetEnvironmentVariables()
• SetEnvironmentVariable(String, String)
• EnvironmentVariableTarget

GetEnvironmentVariable(String, EnvironmentVariableTarget)

Source:

Environment.cs

Recupera el valor de una variable de entorno del proceso actual o de la clave del Registro del sistema operativo Windows para la máquina local o el usuario actual.

C#

public static string? GetEnvironmentVariable (string variable, EnvironmentVariableTarget target);

Parámetros

variable

String

Nombre de una variable de entorno.

target

EnvironmentVariableTarget

Uno de los valores de EnvironmentVariableTarget. Solo Process se admite en .NET que se ejecuta en sistemas similares a Unix.

Devoluciones

String

El valor de la variable de entorno especificada por los parámetros variable y target, o null si no se encuentra la variable de entorno.

Excepciones

ArgumentNullException

variable es null.

ArgumentException

target no es un valor EnvironmentVariableTarget válido.

SecurityException

El autor de la llamada no tiene el permiso requerido para llevar a cabo esta operación.

Ejemplos

En el ejemplo siguiente se crean variables de entorno para los EnvironmentVariableTarget.Processdestinos , EnvironmentVariableTarget.Usery Machine , se comprueba si el registro del sistema operativo contiene las variables de entorno de usuario y máquina y, a continuación, elimina las variables de entorno. Dado que .NET en sistemas similares a Unix no admite variables de entorno por usuario y por equipo, solo SetEnvironmentVariable(String, String) y SetEnvironmentVariable(String, String, EnvironmentVariableTarget) con un valor de almacenar correctamente una variable de EnvironmentVariableTarget.Process entorno en el bloque de entorno de proceso.

C#

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

Comentarios

Para obtener más información sobre esta API, consulte Comentarios complementarios de la API para Environment.GetEnvironmentVariable.

Consulte también

• SetEnvironmentVariable(String, String, EnvironmentVariableTarget)
• GetEnvironmentVariables()
• EnvironmentVariableTarget