Environment.ExpandEnvironmentVariables(String) Método

Definición

Espacio de nombres:
System
Ensamblados:
mscorlib.dll, System.Runtime.Extensions.dll
Ensamblados:
netstandard.dll, System.Runtime.dll
Ensamblado:
System.Runtime.Extensions.dll
Ensamblado:
mscorlib.dll
Ensamblado:
netstandard.dll
Source:
Environment.cs
Source:
Environment.cs
Source:
Environment.cs
Source:
Environment.cs
Source:
Environment.cs

Reemplaza el nombre de cada variable de entorno incrustada en la cadena especificada por la cadena equivalente al valor de la variable y, a continuación, devuelve la cadena resultante.

public:
 static System::String ^ ExpandEnvironmentVariables(System::String ^ name);
public static string ExpandEnvironmentVariables(string name);
static member ExpandEnvironmentVariables : string -> string
Public Shared Function ExpandEnvironmentVariables (name As String) As String

Parámetros

name
String

Cadena que contiene los nombres de cero o más variables de entorno. Cada variable de entorno se cita con el carácter de signo de porcentaje (%).

Devoluciones

String

Cadena con cada variable de entorno reemplazada por su valor.

Excepciones

ArgumentNullException

name es null.

Ejemplos

En el ejemplo siguiente se muestra cómo obtener la unidad del sistema y las variables raíz del sistema.

// Sample for the Environment.ExpandEnvironmentVariables method
using System;

class Sample
{
    public static void Main()
    {
        // Keep this information secure!
        string query = "My system drive is %SystemDrive% and my system root is %SystemRoot%";

        string str = Environment.ExpandEnvironmentVariables(query);

        Console.WriteLine(str);
    }
}
/*
This example prints:

My system drive is C: and my system root is C:\WINDOWS
*/

// Sample for the Environment.ExpandEnvironmentVariables method
open System

let nl = Environment.NewLine

//  <-- Keep this information secure! -->
let query = "My system drive is %SystemDrive% and my system root is %SystemRoot%"
let str = Environment.ExpandEnvironmentVariables query
printfn $"\nExpandEnvironmentVariables: {nl}  {str}"

// This example produces the following results:
//     ExpandEnvironmentVariables:
//       My system drive is C: and my system root is C:\WINNT

' Sample for the Environment.ExpandEnvironmentVariables method
Class Sample
   Public Shared Sub Main()
      Dim str As [String]
      Dim nl As [String] = Environment.NewLine
      
      Console.WriteLine()
      '  <-- Keep this information secure! -->
      Dim query As [String] = "My system drive is %SystemDrive% and" & _ 
                              "my system root is %SystemRoot%"
      str = Environment.ExpandEnvironmentVariables(query)
      Console.WriteLine("ExpandEnvironmentVariables: {0}  {1}", nl, str)
   End Sub
End Class
'
'This example produces the following results:
'
'ExpandEnvironmentVariables:
'  My system drive is C: and my system root is C:\WINNT
'

Comentarios

La interoperabilidad COM se usa para recuperar las variables de entorno del sistema operativo. Si las variables de entorno no se pueden recuperar debido a un error COM, hrESULT que explica la causa del error se usa para generar una de varias excepciones posibles; es decir, la excepción depende de HRESULT. Para obtener más información sobre cómo se procesa HRESULT, vea la sección Comentarios del Marshal.ThrowExceptionForHR método .

El reemplazo solo se produce para las variables de entorno que se establecen. Por ejemplo, supongamos name que es "MyENV = %MyENV%". Si la variable de entorno, MyENV, se establece en 42, este método devuelve "MyENV = 42". Si MyENV no está establecido, no se produce ningún cambio; este método devuelve "MyENV = %MyENV%".

El tamaño del valor devuelto se limita a 32 000.

Se aplica a