Environment.ExpandEnvironmentVariables(String) Метод

Определение

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

System

Сборка:

System.Runtime.Extensions.dll

Сборка:

System.Runtime.dll

Сборка:

mscorlib.dll

Сборка:

netstandard.dll

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

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

Параметры

name

String

Строка, содержащая либо не содержащая имена переменных среды. Каждая переменная среды с двух сторон окружена знаками процента (%).

Возвращаемое значение

String

Строка, в которой каждая переменная среды замещена ее значением.

Исключения

ArgumentNullException

name имеет значение null.

Примеры

В следующем примере показано, как получить системный диск и системные корневые переменные.

// 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
'

Комментарии

COM-взаимодействие используется для получения переменных среды из операционной системы. Если переменные среды не могут быть получены из-за ошибки COM, HRESULT, объясняющий причину сбоя, используется для создания одного из нескольких возможных исключений; то есть исключение зависит от HRESULT. Дополнительные сведения об обработке HRESULT см. в Marshal.ThrowExceptionForHR разделе "Примечания" метода.

Замена происходит только для заданных переменных среды. Например, предположим name , что это "MyENV = %MyENV%". Если переменной среды MyENV задано значение 42, этот метод возвращает значение MyENV = 42. Если myENV не задан, изменения не происходят; этот метод возвращает "MyENV = %MyENV%".

Размер возвращаемого значения ограничен 32 КБ.