review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.Extensions.Configuration.CommandLine</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">\r
   8             <summary>\r
   9             Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">\r
  13             <summary>\r
  14               Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> \r
  15               that reads configuration values from the command line.\r
  16             </summary>\r
  17             <param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
  18             <param name="args">The command line args.</param>\r
  19             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  20             <remarks>\r
  21               <para>\r
  22                 The values passed on the command line, in the <c>args</c> string array, should be a set\r
  23                 of keys prefixed with two dashes ("--") and then values, separate by either the \r
  24                 equals sign ("=") or a space (" ").\r
  25               </para>\r
  26               <para>\r
  27                 A forward slash ("/") can be used as an alternative prefix, with either equals or space, and when using\r
  28                 an equals sign the prefix can be left out altogether. \r
  29               </para>\r
  30               <para>\r
  31                 There are five basic alternative formats for arguments: \r
  32                 <c>key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5</c>.\r
  33               </para>\r
  34             </remarks>\r
  35             <example>\r
  36               A simple console application that has five values. \r
  37               <code>\r
  38                 // dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5\r
  39                 \r
  40                 using Microsoft.Extensions.Configuration;\r
  41                 using System;\r
  42                 \r
  43                 namespace CommandLineSample\r
  44                 {\r
  45                    public class Program\r
  46                    {\r
  47                        public static void Main(string[] args)\r
  48                        {\r
  49                            var builder = new ConfigurationBuilder();\r
  50                            builder.AddCommandLine(args);\r
  51                 \r
  52                            var config = builder.Build();\r
  53                 \r
  54                            Console.WriteLine($"Key1: '{config["Key1"]}'");\r
  55                            Console.WriteLine($"Key2: '{config["Key2"]}'");\r
  56                            Console.WriteLine($"Key3: '{config["Key3"]}'");\r
  57                            Console.WriteLine($"Key4: '{config["Key4"]}'");\r
  58                            Console.WriteLine($"Key5: '{config["Key5"]}'");\r
  59                        }\r
  60                    }\r
  61                 }\r
  62               </code>\r
  63             </example>\r
  64         </member>\r
  65         <member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">\r
  66             <summary>\r
  67               Adds a <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads\r
  68               configuration values from the command line using the specified switch mappings.\r
  69             </summary>\r
  70             <param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
  71             <param name="args">The command line args.</param>\r
  72             <param name="switchMappings">\r
  73               The switch mappings. A dictionary of short (with prefix "-") and \r
  74               alias keys (with prefix "--"), mapped to the configuration key (no prefix).\r
  75             </param>\r
  76             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  77             <remarks>\r
  78               <para>\r
  79                 The <c>switchMappings</c> allows additional formats for alternative short and alias keys \r
  80                 to be used from the command line. Also see the basic version of <c>AddCommandLine</c> for\r
  81                 the standard formats supported.\r
  82               </para>\r
  83               <para>\r
  84                 Short keys start with a single dash ("-") and are mapped to the main key name (without\r
  85                 prefix), and can be used with either equals or space. The single dash mappings are intended\r
  86                 to be used for shorter alternative switches.\r
  87               </para>\r
  88               <para>\r
  89                 Note that a single dash switch cannot be accessed directly, but must have a switch mapping\r
  90                 defined and accessed using the full key. Passing an undefined single dash argument will\r
  91                 cause as <c>FormatException</c>.\r
  92               </para>\r
  93               <para>\r
  94                 There are two formats for short arguments: \r
  95                 <c>-k1=value1 -k2 value2</c>.\r
  96               </para>\r
  97               <para>\r
  98                 Alias key definitions start with two dashes ("--") and are mapped to the main key name (without\r
  99                 prefix), and can be used in place of the normal key. They also work when a forward slash prefix \r
 100                 is used in the command line (but not with the no prefix equals format).\r
 101               </para>\r
 102               <para>\r
 103                 There are only four formats for aliased arguments: \r
 104                 <c>--alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6</c>.\r
 105               </para>\r
 106             </remarks>\r
 107             <example>\r
 108               A simple console application that has two short and four alias switch mappings defined. \r
 109               <code>\r
 110                 // dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6\r
 111                 \r
 112                 using Microsoft.Extensions.Configuration;\r
 113                 using System;\r
 114                 using System.Collections.Generic;\r
 115                 \r
 116                 namespace CommandLineSample\r
 117                 {\r
 118                    public class Program\r
 119                    {\r
 120                        public static void Main(string[] args)\r
 121                        {\r
 122                            var switchMappings = new Dictionary&lt;string, string&gt;()\r
 123                            {\r
 124                                { "-k1", "key1" },\r
 125                                { "-k2", "key2" },\r
 126                                { "--alt3", "key3" },\r
 127                                { "--alt4", "key4" },\r
 128                                { "--alt5", "key5" },\r
 129                                { "--alt6", "key6" },\r
 130                            };\r
 131                            var builder = new ConfigurationBuilder();\r
 132                            builder.AddCommandLine(args, switchMappings);\r
 133                 \r
 134                            var config = builder.Build();\r
 135                 \r
 136                            Console.WriteLine($"Key1: '{config["Key1"]}'");\r
 137                            Console.WriteLine($"Key2: '{config["Key2"]}'");\r
 138                            Console.WriteLine($"Key3: '{config["Key3"]}'");\r
 139                            Console.WriteLine($"Key4: '{config["Key4"]}'");\r
 140                            Console.WriteLine($"Key5: '{config["Key5"]}'");\r
 141                            Console.WriteLine($"Key6: '{config["Key6"]}'");\r
 142                        }\r
 143                    }\r
 144                 }\r
 145               </code>\r
 146             </example>\r
 147         </member>\r
 148         <member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">\r
 149             <summary>\r
 150             Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.\r
 151             </summary>\r
 152             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
 153             <param name="configureSource">Configures the source.</param>\r
 154             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
 155         </member>\r
 156         <member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">\r
 157             <summary>\r
 158             A command line based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.\r
 159             </summary>\r
 160         </member>\r
 161         <member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">\r
 162             <summary>\r
 163             Initializes a new instance.\r
 164             </summary>\r
 165             <param name="args">The command line args.</param>\r
 166             <param name="switchMappings">The switch mappings.</param>\r
 167         </member>\r
 168         <member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">\r
 169             <summary>\r
 170             The command line arguments.\r
 171             </summary>\r
 172         </member>\r
 173         <member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">\r
 174             <summary>\r
 175             Loads the configuration data from the command line args.\r
 176             </summary>\r
 177         </member>\r
 178         <member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">\r
 179             <summary>\r
 180             Represents command line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.\r
 181             </summary>\r
 182         </member>\r
 183         <member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">\r
 184             <summary>\r
 185             Gets or sets the switch mappings.\r
 186             </summary>\r
 187         </member>\r
 188         <member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">\r
 189             <summary>\r
 190             Gets or sets the command line args.\r
 191             </summary>\r
 192         </member>\r
 193         <member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
 194             <summary>\r
 195             Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.\r
 196             </summary>\r
 197             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
 198             <returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/></returns>\r
 199         </member>\r
 200         <member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_DuplicatedKeyInSwitchMappings">\r
 201             <summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>\r
 202         </member>\r
 203         <member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_DuplicatedKeyInSwitchMappings(System.Object)">\r
 204             <summary>Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.</summary>\r
 205         </member>\r
 206         <member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_InvalidSwitchMapping">\r
 207             <summary>The switch mappings contain an invalid switch '{0}'.</summary>\r
 208         </member>\r
 209         <member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_InvalidSwitchMapping(System.Object)">\r
 210             <summary>The switch mappings contain an invalid switch '{0}'.</summary>\r
 211         </member>\r
 212         <member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_ShortSwitchNotDefined">\r
 213             <summary>The short switch '{0}' is not defined in the switch mappings.</summary>\r
 214         </member>\r
 215         <member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_ShortSwitchNotDefined(System.Object)">\r
 216             <summary>The short switch '{0}' is not defined in the switch mappings.</summary>\r
 217         </member>\r
 218     </members>\r
 219 </doc>\r