Microsoft.Extensions.Configuration.Abstractions.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
  8. <summary>
  9. Provides the data about current item of the configuration.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
  13. <summary>
  14. Gets the path of the current item.
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
  18. <summary>
  19. Gets the key of the current item.
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
  23. <summary>
  24. Gets the value of the current item.
  25. </summary>
  26. </member>
  27. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
  28. <summary>
  29. Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
  30. </summary>
  31. </member>
  32. <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
  33. <summary>
  34. Extension methods for configuration classes./>.
  35. </summary>
  36. </member>
  37. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
  38. <summary>
  39. Adds a new configuration source.
  40. </summary>
  41. <param name="builder">The builder to add to.</param>
  42. <param name="configureSource">Configures the source secrets.</param>
  43. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  44. </member>
  45. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  46. <summary>
  47. Shorthand for GetSection("ConnectionStrings")[name].
  48. </summary>
  49. <param name="configuration">The configuration to enumerate.</param>
  50. <param name="name">The connection string key.</param>
  51. <returns>The connection string.</returns>
  52. </member>
  53. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
  54. <summary>
  55. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  56. </summary>
  57. <param name="configuration">The configuration to enumerate.</param>
  58. <returns>An enumeration of key value pairs.</returns>
  59. </member>
  60. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
  61. <summary>
  62. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  63. </summary>
  64. <param name="configuration">The configuration to enumerate.</param>
  65. <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
  66. <returns>An enumeration of key value pairs.</returns>
  67. </member>
  68. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
  69. <summary>
  70. Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children
  71. </summary>
  72. <param name="section">The section to enumerate.</param>
  73. <returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
  74. </member>
  75. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  76. <summary>
  77. Gets a configuration sub-section with the specified key.
  78. </summary>
  79. <param name="configuration">The configuration to enumerate.</param>
  80. <param name="key">The key of the configuration section.</param>
  81. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  82. <remarks>
  83. If no matching sub-section is found with the specified key, an exception is raised.
  84. </remarks>
  85. <exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
  86. </member>
  87. <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
  88. <summary>
  89. Utility methods and constants for manipulating Configuration paths
  90. </summary>
  91. </member>
  92. <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
  93. <summary>
  94. The delimiter ":" used to separate individual keys in a path.
  95. </summary>
  96. </member>
  97. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
  98. <summary>
  99. Combines path segments into one path.
  100. </summary>
  101. <param name="pathSegments">The path segments to combine.</param>
  102. <returns>The combined path.</returns>
  103. </member>
  104. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
  105. <summary>
  106. Combines path segments into one path.
  107. </summary>
  108. <param name="pathSegments">The path segments to combine.</param>
  109. <returns>The combined path.</returns>
  110. </member>
  111. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
  112. <summary>
  113. Extracts the last path segment from the path.
  114. </summary>
  115. <param name="path">The path.</param>
  116. <returns>The last path segment of the path.</returns>
  117. </member>
  118. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
  119. <summary>
  120. Extracts the path corresponding to the parent node for a given path.
  121. </summary>
  122. <param name="path">The path.</param>
  123. <returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
  124. </member>
  125. <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
  126. <summary>
  127. Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
  128. </summary>
  129. </member>
  130. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
  131. <summary>
  132. Generates a human-readable view of the configuration showing where each value came from.
  133. </summary>
  134. <returns> The debug view. </returns>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
  137. <summary>
  138. Generates a human-readable view of the configuration showing where each value came from.
  139. </summary>
  140. <param name="root">Configuration root</param>
  141. <param name="processValue">
  142. Function for processing the value e.g. hiding secrets
  143. Parameters:
  144. ConfigurationDebugViewContext: Context of the current configuration item
  145. returns: A string value is used to assign as the Value of the configuration section
  146. </param>
  147. <returns> The debug view. </returns>
  148. </member>
  149. <member name="T:Microsoft.Extensions.Configuration.IConfiguration">
  150. <summary>
  151. Represents a set of key/value application configuration properties.
  152. </summary>
  153. </member>
  154. <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
  155. <summary>
  156. Gets or sets a configuration value.
  157. </summary>
  158. <param name="key">The configuration key.</param>
  159. <returns>The configuration value.</returns>
  160. </member>
  161. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
  162. <summary>
  163. Gets a configuration sub-section with the specified key.
  164. </summary>
  165. <param name="key">The key of the configuration section.</param>
  166. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  167. <remarks>
  168. This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
  169. an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
  170. </remarks>
  171. </member>
  172. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
  173. <summary>
  174. Gets the immediate descendant configuration sub-sections.
  175. </summary>
  176. <returns>The configuration sub-sections.</returns>
  177. </member>
  178. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
  179. <summary>
  180. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
  181. </summary>
  182. <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>
  183. </member>
  184. <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
  185. <summary>
  186. Represents a type used to build application configuration.
  187. </summary>
  188. </member>
  189. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
  190. <summary>
  191. Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
  192. and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
  193. </summary>
  194. </member>
  195. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
  196. <summary>
  197. Gets the sources used to obtain configuration values
  198. </summary>
  199. </member>
  200. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
  201. <summary>
  202. Adds a new configuration source.
  203. </summary>
  204. <param name="source">The configuration source to add.</param>
  205. <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  206. </member>
  207. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
  208. <summary>
  209. Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
  210. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
  211. </summary>
  212. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
  213. </member>
  214. <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
  215. <summary>
  216. Provides configuration key/values for an application.
  217. </summary>
  218. </member>
  219. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
  220. <summary>
  221. Tries to get a configuration value for the specified key.
  222. </summary>
  223. <param name="key">The key.</param>
  224. <param name="value">The value.</param>
  225. <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
  226. </member>
  227. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
  228. <summary>
  229. Sets a configuration value for the specified key.
  230. </summary>
  231. <param name="key">The key.</param>
  232. <param name="value">The value.</param>
  233. </member>
  234. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
  235. <summary>
  236. Returns a change token if this provider supports change tracking, null otherwise.
  237. </summary>
  238. <returns>The change token.</returns>
  239. </member>
  240. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
  241. <summary>
  242. Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
  243. </summary>
  244. </member>
  245. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  246. <summary>
  247. Returns the immediate descendant configuration keys for a given parent path based on this
  248. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s data and the set of keys returned by all the preceding
  249. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  250. </summary>
  251. <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
  252. <param name="parentPath">The parent path.</param>
  253. <returns>The child keys.</returns>
  254. </member>
  255. <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
  256. <summary>
  257. Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
  258. </summary>
  259. </member>
  260. <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
  261. <summary>
  262. Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  263. </summary>
  264. </member>
  265. <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
  266. <summary>
  267. The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
  268. </summary>
  269. </member>
  270. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
  271. <summary>
  272. Represents a section of application configuration values.
  273. </summary>
  274. </member>
  275. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
  276. <summary>
  277. Gets the key this section occupies in its parent.
  278. </summary>
  279. </member>
  280. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
  281. <summary>
  282. Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  283. </summary>
  284. </member>
  285. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
  286. <summary>
  287. Gets or sets the section value.
  288. </summary>
  289. </member>
  290. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
  291. <summary>
  292. Represents a source of configuration key/values for an application.
  293. </summary>
  294. </member>
  295. <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  296. <summary>
  297. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  298. </summary>
  299. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  300. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  301. </member>
  302. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  303. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  304. <param name="argument">The reference type argument to validate as non-null.</param>
  305. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  306. </member>
  307. <member name="P:System.SR.InvalidSectionName">
  308. <summary>Section '{0}' not found in configuration.</summary>
  309. </member>
  310. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  311. <summary>
  312. Attribute used to indicate a source generator should create a function for marshalling
  313. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  314. </summary>
  315. <remarks>
  316. This attribute is meaningless if the source generator associated with it is not enabled.
  317. The current built-in source generator only supports C# and only supplies an implementation when
  318. applied to static, partial, non-generic methods.
  319. </remarks>
  320. </member>
  321. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  322. <summary>
  323. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  324. </summary>
  325. <param name="libraryName">Name of the library containing the import.</param>
  326. </member>
  327. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  328. <summary>
  329. Gets the name of the library containing the import.
  330. </summary>
  331. </member>
  332. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  333. <summary>
  334. Gets or sets the name of the entry point to be called.
  335. </summary>
  336. </member>
  337. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  338. <summary>
  339. Gets or sets how to marshal string arguments to the method.
  340. </summary>
  341. <remarks>
  342. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  343. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  344. </remarks>
  345. </member>
  346. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  347. <summary>
  348. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  349. </summary>
  350. <remarks>
  351. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  352. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  353. </remarks>
  354. </member>
  355. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  356. <summary>
  357. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  358. on other platforms) before returning from the attributed method.
  359. </summary>
  360. </member>
  361. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  362. <summary>
  363. Specifies how strings should be marshalled for generated p/invokes
  364. </summary>
  365. </member>
  366. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  367. <summary>
  368. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  369. </summary>
  370. </member>
  371. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  372. <summary>
  373. Use the platform-provided UTF-8 marshaller.
  374. </summary>
  375. </member>
  376. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  377. <summary>
  378. Use the platform-provided UTF-16 marshaller.
  379. </summary>
  380. </member>
  381. </members>
  382. </doc>