CommandLineConfigurationExtensions.AddCommandLine Méthode

Définition

Espace de noms:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.CommandLine.dll

Paquet:

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

Surcharges

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[])	Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande en utilisant les mappages de commutateur spécifiés.

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

Source:

CommandLineConfigurationExtensions.cs

Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.

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

Paramètres

builder

IConfigurationBuilder

IConfigurationBuilder auquel ajouter.

configureSource

Action<CommandLineConfigurationSource>

Configure la source.

Retours

IConfigurationBuilder

Le IConfigurationBuilder.

AddCommandLine(IConfigurationBuilder, String[])

Source:

CommandLineConfigurationExtensions.cs

Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.

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

Paramètres

configurationBuilder

IConfigurationBuilder

IConfigurationBuilder auquel ajouter.

args

String[]

Arguments de ligne de commande.

Retours

IConfigurationBuilder

Le IConfigurationBuilder.

Exemples

Une application console simple qui a cinq valeurs.

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

Remarques

Les valeurs passées sur la ligne de commande, dans le args tableau de chaînes, doivent être un ensemble de clés précédées de deux tirets (« -- »), puis de valeurs, séparées par le signe égal (« = ») ou un espace (« »). Une barre oblique (« / ») peut être utilisée comme préfixe de remplacement, avec égal ou espace. Lors de l’utilisation d’un signe égal, le préfixe peut être complètement omis.

Il existe cinq formats alternatifs de base pour les arguments :

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

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

Source:

CommandLineConfigurationExtensions.cs

Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande en utilisant les mappages de commutateur spécifiés.

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

Paramètres

configurationBuilder

IConfigurationBuilder

IConfigurationBuilder auquel ajouter.

args

String[]

Arguments de ligne de commande.

switchMappings

IDictionary<String,String>

Correspondances de commutateur. Dictionnaire de clés courtes (avec le préfixe « - ») et de clés d’alias (avec le préfixe « -- »), mappé à la clé de configuration (sans préfixe).

Retours

IConfigurationBuilder

Le IConfigurationBuilder.

Exemples

Application console simple qui a deux mappages de commutateurs courts et quatre alias définis.

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

Remarques

Permet d’utiliser switchMappings des formats supplémentaires pour les clés courtes et alias alternatives à partir de la ligne de commande. Pour connaître les formats standard pris en charge, consultez la version de base de AddCommandLine.

Les touches courtes commencent par un seul tiret (« - ») et sont mappées au nom de la clé main (sans préfixe) et peuvent être utilisées avec égal ou espace. Les mappages à tiret unique sont destinés à être utilisés pour d’autres commutateurs plus courts. Un commutateur de tiret unique n’est pas accessible directement, mais doit avoir un mappage de commutateur défini et accessible à l’aide de la touche complète. La transmission d’un argument à tiret unique non défini entraîne un FormatException.

Il existe deux formats pour les arguments courts : -k1=value1 et -k2 value2.

Les définitions de clé d’alias commencent par deux tirets (« -- ») et sont mappées au nom de clé main (sans préfixe) et peuvent être utilisées à la place de la clé normale. Ils fonctionnent également lorsqu’un préfixe de barre oblique est utilisé dans la ligne de commande (mais pas avec un préfixe égal au format).

Il n’existe que quatre formats pour les arguments avec alias :

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