Environment.ExpandEnvironmentVariables(String) Método

Definição

Espaço de Nomes:
System
Assemblagens:
mscorlib.dll, System.Runtime.Extensions.dll
Assemblagem:
mscorlib.dll
Assemblagem:
System.Runtime.Extensions.dll
Assemblagem:
netstandard.dll

Substitui o nome de cada variável de ambiente embutida na cadeia especificada pelo equivalente da cadeia do valor da variável, e depois devolve a cadeia 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

Uma cadeia contendo os nomes de zero ou mais variáveis de ambiente. Cada variável de ambiente é citada com o carácter sinal de percentagem (%).

Devoluções

String

Uma cadeia com cada variável de ambiente substituída pelo seu valor.

Exceções

ArgumentNullException

name é null.

Exemplos

O exemplo seguinte mostra como obter a drive do sistema e as variáveis raiz do 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
'

Observações

A interoperabilidade COM é usada para recuperar as variáveis de ambiente do sistema operativo. Se as variáveis de ambiente não puderem ser recuperadas devido a um erro COM, o HRESULT que explica a causa da falha é usado para gerar uma das várias possíveis exceções; isto é, a exceção depende do HRESULT. Para mais informações sobre como o HRESULT é processado, consulte a secção Observações do Marshal.ThrowExceptionForHR método.

A substituição ocorre apenas para variáveis de ambiente que estejam definidas. Por exemplo, suponha name que é "MyENV = %MyENV%". Se a variável de ambiente, MyENV, estiver definida para 42, este método devolve "MyENV = 42". Se o MyENV não estiver definido, não ocorre alteração; este método devolve "MyENV = %MyENV%".

O valor do retorno é limitado a 32K.

Aplica-se a