CommandLineConfigurationExtensions.AddCommandLine メソッド

定義

名前空間:

Microsoft.Extensions.Configuration

アセンブリ:

Microsoft.Extensions.Configuration.CommandLine.dll

パッケージ:

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

オーバーロード

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	コマンド ラインから構成値を読み取る IConfigurationProvider を追加します。
AddCommandLine(IConfigurationBuilder, String[])	コマンド ラインから構成値を読み取る CommandLineConfigurationProvider を追加します。
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	指定されたスイッチ マッピングを使用してコマンド ラインから構成値を読み取る CommandLineConfigurationProvider を追加します。

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

ソース:

CommandLineConfigurationExtensions.cs

コマンド ラインから構成値を読み取る IConfigurationProvider を追加します。

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

追加先の IConfigurationBuilder。

configureSource

Action<CommandLineConfigurationSource>

ソースを構成します。

戻り値

IConfigurationBuilder

IConfigurationBuilder。

AddCommandLine(IConfigurationBuilder, String[])

ソース:

CommandLineConfigurationExtensions.cs

コマンド ラインから構成値を読み取る CommandLineConfigurationProvider を追加します。

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

追加先の IConfigurationBuilder。

args

String[]

コマンド ライン引数。

戻り値

IConfigurationBuilder

IConfigurationBuilder。

例

5 つの値を持つ単純なコンソール アプリケーション。

// 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 つのダッシュ ("--") で始まる一連のキーと、等号 ("=") またはスペース (" ") で区切られた値である必要があります。 スラッシュ ("/") は、 と等しいかスペースを持つ代替プレフィックスとして使用できます。 等号を使用する場合は、プレフィックスを完全に省略できます。

引数には、次の 5 つの基本的な代替形式があります。

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

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

ソース:

CommandLineConfigurationExtensions.cs

指定されたスイッチ マッピングを使用してコマンド ラインから構成値を読み取る CommandLineConfigurationProvider を追加します。

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

追加先の IConfigurationBuilder。

args

String[]

コマンド ライン引数。

switchMappings

IDictionary<String,String>

スイッチ マッピング。 構成キー (プレフィックスなし) にマップされた short 型 (プレフィックス "-") とキーのエイリアス (プレフィックス "--") のディクショナリ。

戻り値

IConfigurationBuilder

IConfigurationBuilder。

例

2 つの短いスイッチと 4 つのエイリアス スイッチ マッピングが定義されている単純なコンソール アプリケーション。

// 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 使用すると、代替の短いキーとエイリアス キーの追加の形式をコマンド ラインから使用できます。 サポートされている標準形式については、 の基本バージョン AddCommandLineを参照してください。

短いキーは 1 つのダッシュ ("-") で始まり、メインキー名 (プレフィックスなし) にマップされ、等号またはスペースで使用できます。 単一ダッシュ マッピングは、短い代替スイッチに使用することを目的としています。 1 つのダッシュ スイッチに直接アクセスすることはできませんが、完全なキーを使用してスイッチ マッピングを定義してアクセスする必要があります。 未定義の単一ダッシュ引数を渡すと、 が発生します FormatException。

短い引数 -k1=value1 には、 と -k2 value2の 2 つの形式があります。

エイリアス キー定義は 2 つのダッシュ ("--") で始まり、メインキー名 (プレフィックスなし) にマップされ、通常のキーの代わりに使用できます。 また、スラッシュ プレフィックスがコマンド ラインで使用されている場合にも機能します (ただし、プレフィックスが形式と等しくない場合は機能しません)。

エイリアス化された引数には、次の 4 つの形式しかありません。

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