CommandLineConfigurationExtensions.AddCommandLine Método

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

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

Parámetros

Devoluciones

El IConfigurationBuilder.

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

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

Parámetros

Devoluciones

El IConfigurationBuilder.

Ejemplos

Una aplicación de consola sencilla que tiene cinco valores.

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

Comentarios

Los valores pasados en la línea de comandos, en la args matriz de cadenas, deben ser un conjunto de claves prefijos con dos guiones ("--") y, a continuación, valores, separados por el signo igual ("=") o un espacio (" ").

Se puede usar una barra diagonal ("/") como prefijo alternativo, con igual o espacio, y cuando se usa un signo igual, el prefijo puede dejarse por completo.

Hay cinco formatos alternativos básicos para los argumentos: key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5.

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

CommandLineConfigurationExtensions.cs

Source:

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

Parámetros

Devoluciones

El IConfigurationBuilder.

Ejemplos

Una aplicación de consola sencilla que tiene dos asignaciones de conmutadores de alias y cuatro cortas definidas.

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

Comentarios

Permite switchMappings usar formatos adicionales para claves de alias y abreviadas alternativas desde la línea de comandos. Consulte también la versión básica de AddCommandLine para los formatos estándar admitidos.

Las teclas cortas comienzan con un solo guión ("-") y se asignan al nombre de clave principal (sin prefijo) y se pueden usar con igual o espacio. Las asignaciones de guiones únicos están diseñadas para usarse para conmutadores alternativos más cortos.

Tenga en cuenta que no se puede acceder directamente a un conmutador de guión único, pero debe tener una asignación de conmutador definida y a la que se tenga acceso mediante la clave completa. Si se pasa un argumento de guión único indefinido, se producirá como FormatException.

Hay dos formatos para argumentos cortos: -k1=value1 -k2 value2.

Las definiciones de clave de alias comienzan con dos guiones ("--") y se asignan al nombre de clave principal (sin prefijo) y se pueden usar en lugar de la clave normal. También funcionan cuando se usa un prefijo de barra diagonal en la línea de comandos (pero no con el formato sin prefijo igual).

Solo hay cuatro formatos para los argumentos con alias: --alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6.