Microsoft.Extensions.Configuration.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.ChainedBuilderExtensions">
  8. <summary>
  9. IConfigurationBuilder extension methods for the chaind configuration provider.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Configuration.ChainedBuilderExtensions.AddConfiguration(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
  13. <summary>
  14. Adds an existing configuration to <paramref name="configurationBuilder"/>.
  15. </summary>
  16. <param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  17. <param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to add.</param>
  18. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  19. </member>
  20. <member name="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
  21. <summary>
  22. Chained implementation of <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
  23. </summary>
  24. </member>
  25. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.ChainedConfigurationSource)">
  26. <summary>
  27. Initialize a new instance from the source configuration.
  28. </summary>
  29. <param name="source">The source configuration.</param>
  30. </member>
  31. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.TryGet(System.String,System.String@)">
  32. <summary>
  33. Tries to get a configuration value for the specified key.
  34. </summary>
  35. <param name="key">The key.</param>
  36. <param name="value">The value.</param>
  37. <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
  38. </member>
  39. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.Set(System.String,System.String)">
  40. <summary>
  41. Sets a configuration value for the specified key.
  42. </summary>
  43. <param name="key">The key.</param>
  44. <param name="value">The value.</param>
  45. </member>
  46. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.GetReloadToken">
  47. <summary>
  48. Returns a change token if this provider supports change tracking, null otherwise.
  49. </summary>
  50. <returns></returns>
  51. </member>
  52. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.Load">
  53. <summary>
  54. Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
  55. </summary>
  56. </member>
  57. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  58. <summary>
  59. Returns the immediate descendant configuration keys for a given parent path based on this
  60. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>'s data and the set of keys returned by all the preceding
  61. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  62. </summary>
  63. <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
  64. <param name="parentPath">The parent path.</param>
  65. <returns>The child keys.</returns>
  66. </member>
  67. <member name="T:Microsoft.Extensions.Configuration.ChainedConfigurationSource">
  68. <summary>
  69. Represents a chained IConfiguration as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  70. </summary>
  71. </member>
  72. <member name="P:Microsoft.Extensions.Configuration.ChainedConfigurationSource.Configuration">
  73. <summary>
  74. The chained configuration.
  75. </summary>
  76. </member>
  77. <member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  78. <summary>
  79. Builds the <see cref="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider"/> for this source.
  80. </summary>
  81. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  82. <returns>A <see cref="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider"/></returns>
  83. </member>
  84. <member name="T:Microsoft.Extensions.Configuration.ConfigurationBuilder">
  85. <summary>
  86. Used to build key/value based configuration settings for use in an application.
  87. </summary>
  88. </member>
  89. <member name="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources">
  90. <summary>
  91. Returns the sources used to obtain configuration values.
  92. </summary>
  93. </member>
  94. <member name="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Properties">
  95. <summary>
  96. Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
  97. and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  98. </summary>
  99. </member>
  100. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
  101. <summary>
  102. Adds a new configuration source.
  103. </summary>
  104. <param name="source">The configuration source to add.</param>
  105. <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  106. </member>
  107. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Build">
  108. <summary>
  109. Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of providers registered in
  110. <see cref="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources"/>.
  111. </summary>
  112. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered providers.</returns>
  113. </member>
  114. <member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyComparer">
  115. <summary>
  116. IComparer implementation used to order configuration keys.
  117. </summary>
  118. </member>
  119. <member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.Instance">
  120. <summary>
  121. The default instance.
  122. </summary>
  123. </member>
  124. <member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.Compare(System.String,System.String)">
  125. <summary>
  126. Compares two strings.
  127. </summary>
  128. <param name="x">First string.</param>
  129. <param name="y">Second string.</param>
  130. <returns></returns>
  131. </member>
  132. <member name="T:Microsoft.Extensions.Configuration.ConfigurationProvider">
  133. <summary>
  134. Base helper class for implementing an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
  135. </summary>
  136. </member>
  137. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.#ctor">
  138. <summary>
  139. Initializes a new <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
  140. </summary>
  141. </member>
  142. <member name="P:Microsoft.Extensions.Configuration.ConfigurationProvider.Data">
  143. <summary>
  144. The configuration key value pairs for this provider.
  145. </summary>
  146. </member>
  147. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.TryGet(System.String,System.String@)">
  148. <summary>
  149. Attempts to find a value with the given key, returns true if one is found, false otherwise.
  150. </summary>
  151. <param name="key">The key to lookup.</param>
  152. <param name="value">The value found at key if one is found.</param>
  153. <returns>True if key has a value, false otherwise.</returns>
  154. </member>
  155. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.Set(System.String,System.String)">
  156. <summary>
  157. Sets a value for a given key.
  158. </summary>
  159. <param name="key">The configuration key to set.</param>
  160. <param name="value">The value to set.</param>
  161. </member>
  162. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.Load">
  163. <summary>
  164. Loads (or reloads) the data for this provider.
  165. </summary>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  168. <summary>
  169. Returns the list of keys that this provider has.
  170. </summary>
  171. <param name="earlierKeys">The earlier keys that other providers contain.</param>
  172. <param name="parentPath">The path for the parent IConfiguration.</param>
  173. <returns>The list of keys for this provider.</returns>
  174. </member>
  175. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.GetReloadToken">
  176. <summary>
  177. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to listen when this provider is reloaded.
  178. </summary>
  179. <returns></returns>
  180. </member>
  181. <member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.OnReload">
  182. <summary>
  183. Triggers the reload change token and creates a new one.
  184. </summary>
  185. </member>
  186. <member name="T:Microsoft.Extensions.Configuration.ConfigurationReloadToken">
  187. <summary>
  188. Implements <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>
  189. </summary>
  190. </member>
  191. <member name="P:Microsoft.Extensions.Configuration.ConfigurationReloadToken.ActiveChangeCallbacks">
  192. <summary>
  193. Indicates if this token will proactively raise callbacks. Callbacks are still guaranteed to be invoked, eventually.
  194. </summary>
  195. </member>
  196. <member name="P:Microsoft.Extensions.Configuration.ConfigurationReloadToken.HasChanged">
  197. <summary>
  198. Gets a value that indicates if a change has occurred.
  199. </summary>
  200. </member>
  201. <member name="M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  202. <summary>
  203. Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"/>
  204. MUST be set before the callback is invoked.
  205. </summary>
  206. <param name="callback">The callback to invoke.</param>
  207. <param name="state">State to be passed into the callback.</param>
  208. <returns></returns>
  209. </member>
  210. <member name="M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.OnReload">
  211. <summary>
  212. Used to trigger the change token when a reload occurs.
  213. </summary>
  214. </member>
  215. <member name="T:Microsoft.Extensions.Configuration.ConfigurationRoot">
  216. <summary>
  217. The root node for a configuration.
  218. </summary>
  219. </member>
  220. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Configuration.IConfigurationProvider})">
  221. <summary>
  222. Initializes a Configuration root with a list of providers.
  223. </summary>
  224. <param name="providers">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.</param>
  225. </member>
  226. <member name="P:Microsoft.Extensions.Configuration.ConfigurationRoot.Providers">
  227. <summary>
  228. The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
  229. </summary>
  230. </member>
  231. <member name="P:Microsoft.Extensions.Configuration.ConfigurationRoot.Item(System.String)">
  232. <summary>
  233. Gets or sets the value corresponding to a configuration key.
  234. </summary>
  235. <param name="key">The configuration key.</param>
  236. <returns>The configuration value.</returns>
  237. </member>
  238. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetChildren">
  239. <summary>
  240. Gets the immediate children sub-sections.
  241. </summary>
  242. <returns></returns>
  243. </member>
  244. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetReloadToken">
  245. <summary>
  246. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
  247. </summary>
  248. <returns></returns>
  249. </member>
  250. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetSection(System.String)">
  251. <summary>
  252. Gets a configuration sub-section with the specified key.
  253. </summary>
  254. <param name="key">The key of the configuration section.</param>
  255. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  256. <remarks>
  257. This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
  258. an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
  259. </remarks>
  260. </member>
  261. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.Reload">
  262. <summary>
  263. Force the configuration values to be reloaded from the underlying sources.
  264. </summary>
  265. </member>
  266. <member name="T:Microsoft.Extensions.Configuration.ConfigurationSection">
  267. <summary>
  268. Represents a section of application configuration values.
  269. </summary>
  270. </member>
  271. <member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.#ctor(Microsoft.Extensions.Configuration.ConfigurationRoot,System.String)">
  272. <summary>
  273. Initializes a new instance.
  274. </summary>
  275. <param name="root">The configuration root.</param>
  276. <param name="path">The path to this section.</param>
  277. </member>
  278. <member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Path">
  279. <summary>
  280. Gets the full path to this section from the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
  281. </summary>
  282. </member>
  283. <member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Key">
  284. <summary>
  285. Gets the key this section occupies in its parent.
  286. </summary>
  287. </member>
  288. <member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Value">
  289. <summary>
  290. Gets or sets the section value.
  291. </summary>
  292. </member>
  293. <member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Item(System.String)">
  294. <summary>
  295. Gets or sets the value corresponding to a configuration key.
  296. </summary>
  297. <param name="key">The configuration key.</param>
  298. <returns>The configuration value.</returns>
  299. </member>
  300. <member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetSection(System.String)">
  301. <summary>
  302. Gets a configuration sub-section with the specified key.
  303. </summary>
  304. <param name="key">The key of the configuration section.</param>
  305. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  306. <remarks>
  307. This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
  308. an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
  309. </remarks>
  310. </member>
  311. <member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetChildren">
  312. <summary>
  313. Gets the immediate descendant configuration sub-sections.
  314. </summary>
  315. <returns>The configuration sub-sections.</returns>
  316. </member>
  317. <member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetReloadToken">
  318. <summary>
  319. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
  320. </summary>
  321. <returns></returns>
  322. </member>
  323. <member name="T:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions">
  324. <summary>
  325. IConfigurationBuilder extension methods for the MemoryConfigurationProvider.
  326. </summary>
  327. </member>
  328. <member name="M:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions.AddInMemoryCollection(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  329. <summary>
  330. Adds the memory configuration provider to <paramref name="configurationBuilder"/>.
  331. </summary>
  332. <param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  333. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  334. </member>
  335. <member name="M:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions.AddInMemoryCollection(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
  336. <summary>
  337. Adds the memory configuration provider to <paramref name="configurationBuilder"/>.
  338. </summary>
  339. <param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  340. <param name="initialData">The data to add to memory configuration provider.</param>
  341. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  342. </member>
  343. <member name="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider">
  344. <summary>
  345. In-memory implementation of <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
  346. </summary>
  347. </member>
  348. <member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource)">
  349. <summary>
  350. Initialize a new instance from the source.
  351. </summary>
  352. <param name="source">The source settings.</param>
  353. </member>
  354. <member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.Add(System.String,System.String)">
  355. <summary>
  356. Add a new key and value pair.
  357. </summary>
  358. <param name="key">The configuration key.</param>
  359. <param name="value">The configuration value.</param>
  360. </member>
  361. <member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.GetEnumerator">
  362. <summary>
  363. Returns an enumerator that iterates through the collection.
  364. </summary>
  365. <returns>An enumerator that can be used to iterate through the collection.</returns>
  366. </member>
  367. <member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.System#Collections#IEnumerable#GetEnumerator">
  368. <summary>
  369. Returns an enumerator that iterates through the collection.
  370. </summary>
  371. <returns>An enumerator that can be used to iterate through the collection.</returns>
  372. </member>
  373. <member name="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource">
  374. <summary>
  375. Represents in-memory data as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  376. </summary>
  377. </member>
  378. <member name="P:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.InitialData">
  379. <summary>
  380. The initial key value configuration pairs.
  381. </summary>
  382. </member>
  383. <member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  384. <summary>
  385. Builds the <see cref="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider"/> for this source.
  386. </summary>
  387. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  388. <returns>A <see cref="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider"/></returns>
  389. </member>
  390. <member name="P:Microsoft.Extensions.Configuration.Resources.Error_NoSources">
  391. <summary>
  392. A configuration source is not registered. Please register one before setting a value.
  393. </summary>
  394. </member>
  395. <member name="M:Microsoft.Extensions.Configuration.Resources.FormatError_NoSources">
  396. <summary>
  397. A configuration source is not registered. Please register one before setting a value.
  398. </summary>
  399. </member>
  400. </members>
  401. </doc>