CommandLineConfigurationExtensions.AddCommandLine Methode

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

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

Parameters

Retouren

De IConfigurationBuilder.

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

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

Parameters

Retouren

De IConfigurationBuilder.

Voorbeelden

Een eenvoudige consoletoepassing met vijf waarden.

// 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"]}'");
       }
   }
}

Opmerkingen

De waarden die zijn doorgegeven op de opdrachtregel, in de args tekenreeksmatrix, moeten een set sleutels zijn die zijn voorafgegaan door twee streepjes ("--") en vervolgens waarden, gescheiden door het gelijkteken ("=") of een spatie (" ").

Een slash ("/") kan worden gebruikt als een alternatief voorvoegsel, met gelijk of spatie, en wanneer u een gelijkteken gebruikt, kan het voorvoegsel helemaal worden weggelaten.

Er zijn vijf alternatieve indelingen voor argumenten: key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5.

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

Bron:

CommandLineConfigurationExtensions.cs

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

Parameters

Retouren

De IConfigurationBuilder.

Voorbeelden

Een eenvoudige consoletoepassing met twee korte en vier aliasswitchtoewijzingen gedefinieerd.

// 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"]}'");
       }
   }
}

Opmerkingen

Hiermee switchMappings kunnen extra indelingen worden gebruikt voor alternatieve korte en aliassleutels vanaf de opdrachtregel. Zie ook de basisversie van AddCommandLine de ondersteunde standaardindelingen.

Korte toetsen beginnen met één streepje (-) en worden toegewezen aan de hoofdsleutelnaam (zonder voorvoegsel) en kunnen worden gebruikt met gelijk aan of spatie. De toewijzingen met één streepje zijn bedoeld voor kortere alternatieve switches.

Houd er rekening mee dat een switch met één streepje niet rechtstreeks kan worden geopend, maar moet een switchtoewijzing zijn gedefinieerd en geopend met behulp van de volledige sleutel. Als u een niet-gedefinieerd argument met één streepje doorgeeft, wordt dit veroorzaakt door FormatException.

Er zijn twee notaties voor korte argumenten: -k1=value1 -k2 value2.

Aliassleuteldefinities beginnen met twee streepjes (--) en worden toegewezen aan de hoofdsleutelnaam (zonder voorvoegsel) en kunnen worden gebruikt in plaats van de normale sleutel. Ze werken ook wanneer een slash-voorvoegsel wordt gebruikt in de opdrachtregel (maar niet met het voorvoegsel is gelijk aan de notatie).

Er zijn slechts vier indelingen voor aliasargumenten: --alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6.