CommandLineConfigurationExtensions.AddCommandLine Metoda

Definicja

Przestrzeń nazw:

Microsoft.Extensions.Configuration

Zestaw:

Microsoft.Extensions.Configuration.CommandLine.dll

Pakiet:

Microsoft.Extensions.Configuration.CommandLine v9.0.0-preview.3.24172.9

Przeciążenia

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.
AddCommandLine(IConfigurationBuilder, String[])	Dodaje element CommandLineConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Dodaje element CommandLineConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia przy użyciu określonych mapowań przełącznika.

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

Źródło:

CommandLineConfigurationExtensions.cs

Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Action<Microsoft::Extensions::Configuration::CommandLine::CommandLineConfigurationSource ^> ^ configureSource);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine (this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource>? configureSource);

static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddCommandLine (builder As IConfigurationBuilder, configureSource As Action(Of CommandLineConfigurationSource)) As IConfigurationBuilder

Parametry

builder

IConfigurationBuilder

Element do dodania IConfigurationBuilder .

configureSource

Action<CommandLineConfigurationSource>

Konfiguruje źródło.

Zwraca

IConfigurationBuilder

Element IConfigurationBuilder.

AddCommandLine(IConfigurationBuilder, String[])

Źródło:

CommandLineConfigurationExtensions.cs

Dodaje element CommandLineConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, cli::array <System::String ^> ^ args);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string[] args);

static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * string[] -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddCommandLine (configurationBuilder As IConfigurationBuilder, args As String()) As IConfigurationBuilder

Parametry

configurationBuilder

IConfigurationBuilder

Element do dodania IConfigurationBuilder .

args

String[]

Wiersz polecenia args.

Zwraca

IConfigurationBuilder

Element IConfigurationBuilder.

Przykłady

Prosta aplikacja konsolowa, która ma pięć wartości.

// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5

using Microsoft.Extensions.Configuration;
using System;

namespace CommandLineSample
{
   public class Program
   {
       public static void Main(string[] args)
       {
           var builder = new ConfigurationBuilder();
           builder.AddCommandLine(args);

           var config = builder.Build();

           Console.WriteLine($"Key1: '{config["Key1"]}'");
           Console.WriteLine($"Key2: '{config["Key2"]}'");
           Console.WriteLine($"Key3: '{config["Key3"]}'");
           Console.WriteLine($"Key4: '{config["Key4"]}'");
           Console.WriteLine($"Key5: '{config["Key5"]}'");
       }
   }
}

Uwagi

Wartości przekazane w wierszu polecenia w args tablicy ciągów powinny być zestawem kluczy poprzedzonych dwoma kreskami ("--"), a następnie wartościami oddzielonymi znakiem równości ("=") lub spacją (""). Ukośnik ("/") może być używany jako alternatywny prefiks z równym lub spacją. W przypadku używania znaku równości prefiks można całkowicie pominąć.

Istnieje pięć podstawowych alternatywnych formatów argumentów:

key1=value1
--key2=value2
/key3=value3
--key4 value4
/key5 value5

AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)

Źródło:

CommandLineConfigurationExtensions.cs

Dodaje element CommandLineConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia przy użyciu określonych mapowań przełącznika.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, cli::array <System::String ^> ^ args, System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ switchMappings);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine (this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string[] args, System.Collections.Generic.IDictionary<string,string>? switchMappings);

static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * string[] * System.Collections.Generic.IDictionary<string, string> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddCommandLine (configurationBuilder As IConfigurationBuilder, args As String(), switchMappings As IDictionary(Of String, String)) As IConfigurationBuilder

Parametry

configurationBuilder

IConfigurationBuilder

Element do dodania IConfigurationBuilder .

args

String[]

Wiersz polecenia args.

switchMappings

IDictionary<String,String>

Mapowania przełączników. Słownik krótki (z prefiksem "-") i kluczami aliasu (z prefiksem "--"), zamapowany na klucz konfiguracji (bez prefiksu).

Zwraca

IConfigurationBuilder

Element IConfigurationBuilder.

Przykłady

Prosta aplikacja konsolowa, która ma zdefiniowane dwa krótkie i cztery mapowania przełączników aliasów.

// dotnet run k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6

using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;

namespace CommandLineSample
{
   public class Program
   {
       public static void Main(string[] args)
       {
           var switchMappings = new Dictionary<string, string>()
           {
               { "-k1", "key1" },
               { "-k2", "key2" },
               { "--alt3", "key3" },
               { "--alt4", "key4" },
               { "--alt5", "key5" },
               { "--alt6", "key6" },
           };
           var builder = new ConfigurationBuilder();
           builder.AddCommandLine(args, switchMappings);

           var config = builder.Build();

           Console.WriteLine($"Key1: '{config["Key1"]}'");
           Console.WriteLine($"Key2: '{config["Key2"]}'");
           Console.WriteLine($"Key3: '{config["Key3"]}'");
           Console.WriteLine($"Key4: '{config["Key4"]}'");
           Console.WriteLine($"Key5: '{config["Key5"]}'");
           Console.WriteLine($"Key6: '{config["Key6"]}'");
       }
   }
}

Uwagi

Element switchMappings umożliwia używanie alternatywnych krótkich i aliasowych kluczy z wiersza polecenia dodatkowych formatów. Aby zapoznać się ze standardowymi formatami obsługiwanymi, zobacz podstawową wersję programu AddCommandLine.

Krótkie klucze zaczynają się od pojedynczej kreski ("-") i są mapowane na główną nazwę klucza (bez prefiksu) i mogą być używane z równymi lub spacjami. Mapowania z jedną kreską są przeznaczone do krótszych przełączników alternatywnych. Nie można uzyskać bezpośredniego dostępu do jednego przełącznika kreskowego, ale musi mieć zdefiniowane mapowanie przełącznika i uzyskać do tego dostępu przy użyciu pełnego klucza. Przekazanie niezdefiniowanego argumentu z jedną kreską spowoduje błąd FormatException.

Istnieją dwa formaty krótkich argumentów: -k1=value1 i -k2 value2.

Definicje kluczy aliasu zaczynają się od dwóch kresków ("--") i są mapowane na główną nazwę klucza (bez prefiksu) i mogą być używane zamiast klucza normalnego. Działają one również, gdy prefiks ukośnika jest używany w wierszu polecenia (ale nie z prefiksem równości).

Istnieją tylko cztery formaty argumentów aliasowanych:

--alt3=value3
/alt4=value4
--alt5 value5
/alt6 value6