Environment.ExpandEnvironmentVariables(String) Metoda

Definicja

Przestrzeń nazw:

System

Zestaw:

System.Runtime.Extensions.dll

Zestaw:

System.Runtime.dll

Zestaw:

mscorlib.dll

Zestaw:

netstandard.dll

Zastępuje nazwę każdej zmiennej środowiskowej osadzonej w określonym ciągu ciągiem równoważnym wartości zmiennej, a następnie zwraca wynikowy ciąg.

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

Parametry

name

String

Ciąg zawierający nazwy zera lub większej liczby zmiennych środowiskowych. Każda zmienna środowiskowa jest cytowana znakiem procentu (%).

Zwraca

String

Ciąg z każdą zmienną środowiskową zastąpioną przez jego wartość.

Wyjątki

ArgumentNullException

name to null.

Przykłady

W poniższym przykładzie pokazano, jak uzyskać dyski systemowe i zmienne główne systemu.

// Sample for the Environment::ExpandEnvironmentVariables method
using namespace System;
int main()
{
   String^ str;
   String^ nl = Environment::NewLine;
   Console::WriteLine();
   
   //  <-- Keep this information secure! -->
   String^ query = "My system drive is %SystemDrive% and my system root is %SystemRoot%";
   str = Environment::ExpandEnvironmentVariables( query );
   Console::WriteLine( "ExpandEnvironmentVariables: {0} {1}", 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
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
'

Uwagi

Międzyoperacyjna com służy do pobierania zmiennych środowiskowych z systemu operacyjnego. Jeśli nie można pobrać zmiennych środowiskowych z powodu błędu COM, HRESULT, który wyjaśnia przyczynę błędu jest używany do generowania jednego z kilku możliwych wyjątków; oznacza to, że wyjątek zależy od HRESULT. Aby uzyskać więcej informacji na temat przetwarzania hrESULT, zobacz sekcję Uwagi metody Marshal.ThrowExceptionForHR .

Zamiana odbywa się tylko dla zmiennych środowiskowych, które są ustawione. Załóżmy na przykład, że name wartość "MyENV = %MyENV%". Jeśli zmienna środowiskowa MyENV jest ustawiona na 42, ta metoda zwraca wartość "MyENV = 42". Jeśli program MyENV nie jest ustawiony, nie nastąpi żadna zmiana; Ta metoda zwraca wartość "MyENV = %MyENV%".

Rozmiar wartości zwracanej jest ograniczony do 32K.