CommandLineConfigurationExtensions.AddCommandLine メソッド

定義

オーバーロード

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

コマンド ラインから構成値を読み取る IConfigurationProvider を追加します。Adds an IConfigurationProvider that reads configuration values from the command line.

AddCommandLine(IConfigurationBuilder, String[])

コマンド ラインから構成値を読み取る CommandLineConfigurationProviderIConfigurationProvider を追加します。Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line.

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

指定されたスイッチ マッピングを使用してコマンド ラインから構成値を読み取る CommandLineConfigurationProviderIConfigurationProvider を追加します。Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line using the specified switch mappings.

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

コマンド ラインから構成値を読み取る IConfigurationProvider を追加します。Adds an IConfigurationProvider that reads configuration values from the command line.

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

パラメーター

builder
IConfigurationBuilder

追加先の IConfigurationBuilderThe IConfigurationBuilder to add to.

configureSource
Action<CommandLineConfigurationSource>

ソースを構成します。Configures the source.

戻り値

IConfigurationBuilder

IConfigurationBuilderThe IConfigurationBuilder.

適用対象

AddCommandLine(IConfigurationBuilder, String[])

コマンド ラインから構成値を読み取る CommandLineConfigurationProviderIConfigurationProvider を追加します。Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line.

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

パラメーター

configurationBuilder
IConfigurationBuilder

追加先の IConfigurationBuilderThe IConfigurationBuilder to add to.

args
String[]

コマンド ライン引数。The command line args.

戻り値

IConfigurationBuilder

IConfigurationBuilderThe IConfigurationBuilder.

5つの値を持つ単純なコンソールアプリケーション。A simple console application that has five values.

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

注釈

Args文字列配列内のコマンドラインで渡される値は、2つのダッシュ ("--") と、等号 ("=") またはスペース ("") で区切られた値で始まる一連のキーである必要があります。The values passed on the command line, in the args string array, should be a set of keys prefixed with two dashes ("--") and then values, separate by either the equals sign ("=") or a space (" ").

スラッシュ ("/") は、等号またはスペースを使用して代替プレフィックスとして使用できます。また、等号 (=) を使用すると、プレフィックスを完全に残すことができます。A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using an equals sign the prefix can be left out altogether.

引数には、次の5つの基本的な代替形式があります。 key1 = value1--key2 = value2/key3 = value3--key4 value4/key5 value5There are five basic alternative formats for arguments: key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5.

適用対象

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

指定されたスイッチ マッピングを使用してコマンド ラインから構成値を読み取る CommandLineConfigurationProviderIConfigurationProvider を追加します。Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line using the specified switch mappings.

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

パラメーター

configurationBuilder
IConfigurationBuilder

追加先の IConfigurationBuilderThe IConfigurationBuilder to add to.

args
String[]

コマンド ライン引数。The command line args.

switchMappings
IDictionary<String,String>

スイッチ マッピング。The switch mappings. 構成キー (プレフィックスなし) にマップされた short 型 (プレフィックス "-") とキーのエイリアス (プレフィックス "--") のディクショナリ。A dictionary of short (with prefix "-") and alias keys (with prefix "--"), mapped to the configuration key (no prefix).

戻り値

IConfigurationBuilder

IConfigurationBuilderThe IConfigurationBuilder.

2つの短いエイリアスと4つのエイリアススイッチのマッピングが定義された単純なコンソールアプリケーション。A simple console application that has two short and four alias switch mappings defined.

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

注釈

Switchmappingsでは、コマンドラインから代替の短いキーとエイリアスキーを使用するための追加の形式を使用できます。The switchMappings allows additional formats for alternative short and alias keys to be used from the command line. サポートされている標準形式については、 Addcommandline の基本バージョンも参照してください。Also see the basic version of AddCommandLine for the standard formats supported.

短いキーは、1つのダッシュ ("-") で始まり、メインキー名 (プレフィックスなし) にマップされ、equals または space で使用できます。Short keys start with a single dash ("-") and are mapped to the main key name (without prefix), and can be used with either equals or space. 単一のダッシュマップは、短い代替スイッチに使用することを目的としています。The single dash mappings are intended to be used for shorter alternative switches.

1つのダッシュスイッチに直接アクセスすることはできませんが、フルキーを使用して、スイッチマッピングを定義してアクセスする必要があります。Note that a single dash switch cannot be accessed directly, but must have a switch mapping defined and accessed using the full key. 定義されていない単一のダッシュの引数を渡すと、 FormatExceptionが発生します。Passing an undefined single dash argument will cause as FormatException.

短い引数には 、-k1 = value1-k2 value2の2つの形式があります。There are two formats for short arguments: -k1=value1 -k2 value2.

エイリアスキー定義は、2つのダッシュ ("--") で始まり、メインキー名 (プレフィックスなし) にマップされ、通常のキーの代わりに使用できます。Alias key definitions start with two dashes ("--") and are mapped to the main key name (without prefix), and can be used in place of the normal key. また、コマンドラインでスラッシュプレフィックスが使用されている場合にも機能します (プレフィックスが付いていないという形式ではありません)。They also work when a forward slash prefix is used in the command line (but not with the no prefix equals format).

エイリアス化された引数には、次の4つの形式のみがあります。 --alt3 = value3/alt4 = value4--alt5 value5/alt6 value6There are only four formats for aliased arguments: --alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6.

適用対象