CommandLineConfigurationExtensions.AddCommandLine Méthode

Définition

Espace de noms:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.CommandLine.dll

Paquet:: Microsoft.Extensions.Configuration.CommandLine v11.0.0-preview.4.26230.115

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

Nom	Description
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Ajoute une IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[])	Ajoute une CommandLineConfigurationProvider IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Ajoute une CommandLineConfigurationProvider IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande à l’aide des mappages de commutateur spécifiés.

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Ajoute une IConfigurationProvider valeur de configuration 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 À ajouter.

configureSource: Action<CommandLineConfigurationSource>

Configure la source.

Retours

IConfigurationBuilder

L’attribut IConfigurationBuilder.

S’applique à

AddCommandLine(IConfigurationBuilder, String[])

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Ajoute une CommandLineConfigurationProvider IConfigurationProvider valeur de configuration 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 À ajouter.

args: String[]

Arguments de ligne de commande.

Retours

IConfigurationBuilder

L’attribut IConfigurationBuilder.

Exemples

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 transmises 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 des valeurs, séparées par le signe égal (« = ») ou un espace ( » « ).

Une barre oblique (« / ») peut être utilisée comme préfixe alternatif, avec des égaux ou de l’espace, et lorsque vous utilisez un signe égal, le préfixe peut être laissé à l’écart.

Il existe cinq formats de base pour les arguments : key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5.

S’applique à

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

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Source:: CommandLineConfigurationExtensions.cs

Ajoute une CommandLineConfigurationProvider IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande à l’aide des 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 À ajouter.

args: String[]

Arguments de ligne de commande.

switchMappings: IDictionary<String,String>

Mappages de commutateurs. Dictionnaire de raccourcis (avec préfixe « - ») et clés d’alias (avec préfixe « - »), mappé à la clé de configuration (aucun préfixe).

Retours

IConfigurationBuilder

L’attribut IConfigurationBuilder.

Exemples

Application console simple qui a deux mappages de commutateur d’alias courts et quatre 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

Les switchMappings formats supplémentaires permettant d’utiliser d’autres clés courtes et d’alias à partir de la ligne de commande peuvent être utilisés. Consultez également la version de base des AddCommandLine formats standard pris en charge.

Les touches courtes commencent par un seul tiret (« - ») et sont mappées au nom de clé principal (sans préfixe) et peuvent être utilisées avec des valeurs égales ou spatiales. Les mappages de tirets uniques sont destinés à être utilisés pour des commutateurs de remplacement plus courts.

Notez qu’un seul commutateur de tirets n’est pas accessible directement, mais doit avoir un mappage de commutateur défini et accessible à l’aide de la clé complète. Le passage d’un argument de tiret unique non défini entraîne la mise en place de FormatException.

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

Les définitions de clé d’alias commencent par deux tirets (« - ») et sont mappées au nom de clé principal (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 le format égal au préfixe).

Il n’existe que quatre formats pour les arguments alias : --alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6.

S’applique à

Commentaires

Cette page a-t-elle été utile ?