Microsoft.Extensions.Configuration.FileExtensions.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.FileExtensions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions">
  8. <summary>
  9. Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)">
  13. <summary>
  14. Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
  15. </summary>
  16. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  17. <param name="fileProvider">The default file provider instance.</param>
  18. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  19. </member>
  20. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  21. <summary>
  22. Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
  23. </summary>
  24. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  25. <returns>The default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/>.</returns>
  26. </member>
  27. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
  28. <summary>
  29. Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.
  30. </summary>
  31. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  32. <param name="basePath">The absolute path of file-based providers.</param>
  33. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  34. </member>
  35. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})">
  36. <summary>
  37. Sets a default action to be invoked for file-based providers when an error occurs.
  38. </summary>
  39. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  40. <param name="handler">The Action to be invoked on a file load exception.</param>
  41. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  42. </member>
  43. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  44. <summary>
  45. Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
  46. </summary>
  47. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  48. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  49. </member>
  50. <member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider">
  51. <summary>
  52. Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
  53. </summary>
  54. </member>
  55. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)">
  56. <summary>
  57. Initializes a new instance with the specified source.
  58. </summary>
  59. <param name="source">The source settings.</param>
  60. </member>
  61. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source">
  62. <summary>
  63. The source settings for this provider.
  64. </summary>
  65. </member>
  66. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.ToString">
  67. <summary>
  68. Generates a string representing this provider name and relevant details.
  69. </summary>
  70. <returns> The configuration name. </returns>
  71. </member>
  72. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load">
  73. <summary>
  74. Loads the contents of the file at <see cref="T:System.IO.Path"/>.
  75. </summary>
  76. <exception cref="T:System.IO.DirectoryNotFoundException">Optional is <c>false</c> on the source and a
  77. directory cannot be found at the specified Path.</exception>
  78. <exception cref="T:System.IO.FileNotFoundException">Optional is <c>false</c> on the source and a
  79. file does not exist at specified Path.</exception>
  80. <exception cref="T:System.IO.InvalidDataException">An exception was thrown by the concrete implementation of the
  81. <see cref="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load"/> method. Use the source <see cref="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException"/> callback
  82. if you need more control over the exception.</exception>
  83. </member>
  84. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">
  85. <summary>
  86. Loads this provider's data from a stream.
  87. </summary>
  88. <param name="stream">The stream to read.</param>
  89. </member>
  90. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose">
  91. <inheritdoc />
  92. </member>
  93. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose(System.Boolean)">
  94. <summary>
  95. Dispose the provider.
  96. </summary>
  97. <param name="disposing"><c>true</c> if invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
  98. </member>
  99. <member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">
  100. <summary>
  101. Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  102. </summary>
  103. </member>
  104. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">
  105. <summary>
  106. Used to access the contents of the file.
  107. </summary>
  108. </member>
  109. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
  110. <summary>
  111. The path to the file.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
  115. <summary>
  116. Determines if loading the file is optional.
  117. </summary>
  118. </member>
  119. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
  120. <summary>
  121. Determines whether the source will be loaded if the underlying file changes.
  122. </summary>
  123. </member>
  124. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
  125. <summary>
  126. Number of milliseconds that reload will wait before calling Load. This helps
  127. avoid triggering reload before a file is completely written. Default is 250.
  128. </summary>
  129. </member>
  130. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
  131. <summary>
  132. Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
  133. </summary>
  134. </member>
  135. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  136. <summary>
  137. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  138. </summary>
  139. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  140. <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  141. </member>
  142. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  143. <summary>
  144. Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
  145. </summary>
  146. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  147. </member>
  148. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
  149. <summary>
  150. If no file provider has been set, for absolute Path, this will creates a physical file provider
  151. for the nearest existing directory.
  152. </summary>
  153. </member>
  154. <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
  155. <summary>
  156. Contains information about a file load exception.
  157. </summary>
  158. </member>
  159. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
  160. <summary>
  161. The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
  162. </summary>
  163. </member>
  164. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
  165. <summary>
  166. The exception that occurred in Load.
  167. </summary>
  168. </member>
  169. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
  170. <summary>
  171. If true, the exception will not be rethrown.
  172. </summary>
  173. </member>
  174. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  175. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  176. <param name="argument">The reference type argument to validate as non-null.</param>
  177. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  178. </member>
  179. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  180. <summary>
  181. Attribute used to indicate a source generator should create a function for marshalling
  182. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  183. </summary>
  184. <remarks>
  185. This attribute is meaningless if the source generator associated with it is not enabled.
  186. The current built-in source generator only supports C# and only supplies an implementation when
  187. applied to static, partial, non-generic methods.
  188. </remarks>
  189. </member>
  190. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  191. <summary>
  192. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  193. </summary>
  194. <param name="libraryName">Name of the library containing the import.</param>
  195. </member>
  196. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  197. <summary>
  198. Gets the name of the library containing the import.
  199. </summary>
  200. </member>
  201. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  202. <summary>
  203. Gets or sets the name of the entry point to be called.
  204. </summary>
  205. </member>
  206. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  207. <summary>
  208. Gets or sets how to marshal string arguments to the method.
  209. </summary>
  210. <remarks>
  211. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  212. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  213. </remarks>
  214. </member>
  215. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  216. <summary>
  217. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  218. </summary>
  219. <remarks>
  220. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  221. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  222. </remarks>
  223. </member>
  224. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  225. <summary>
  226. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  227. on other platforms) before returning from the attributed method.
  228. </summary>
  229. </member>
  230. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  231. <summary>
  232. Specifies how strings should be marshalled for generated p/invokes
  233. </summary>
  234. </member>
  235. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  236. <summary>
  237. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  238. </summary>
  239. </member>
  240. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  241. <summary>
  242. Use the platform-provided UTF-8 marshaller.
  243. </summary>
  244. </member>
  245. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  246. <summary>
  247. Use the platform-provided UTF-16 marshaller.
  248. </summary>
  249. </member>
  250. <member name="P:System.SR.Error_ExpectedPhysicalPath">
  251. <summary>The expected physical path was '{0}'.</summary>
  252. </member>
  253. <member name="P:System.SR.Error_FileNotFound">
  254. <summary>The configuration file '{0}' was not found and is not optional.</summary>
  255. </member>
  256. <member name="P:System.SR.Error_FailedToLoad">
  257. <summary>Failed to load configuration from file '{0}'.</summary>
  258. </member>
  259. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  260. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  261. </member>
  262. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  263. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  264. </member>
  265. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  266. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  267. </member>
  268. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  269. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  270. </member>
  271. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  272. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  273. </member>
  274. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  275. <summary>Initializes the attribute with the specified return value condition.</summary>
  276. <param name="returnValue">
  277. The return value condition. If the method returns this value, the associated parameter may be null.
  278. </param>
  279. </member>
  280. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  281. <summary>Gets the return value condition.</summary>
  282. </member>
  283. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  284. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  285. </member>
  286. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  287. <summary>Initializes the attribute with the specified return value condition.</summary>
  288. <param name="returnValue">
  289. The return value condition. If the method returns this value, the associated parameter will not be null.
  290. </param>
  291. </member>
  292. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  293. <summary>Gets the return value condition.</summary>
  294. </member>
  295. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  296. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  297. </member>
  298. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  299. <summary>Initializes the attribute with the associated parameter name.</summary>
  300. <param name="parameterName">
  301. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  302. </param>
  303. </member>
  304. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  305. <summary>Gets the associated parameter name.</summary>
  306. </member>
  307. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  308. <summary>Applied to a method that will never return under any circumstance.</summary>
  309. </member>
  310. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  311. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  312. </member>
  313. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  314. <summary>Initializes the attribute with the specified parameter value.</summary>
  315. <param name="parameterValue">
  316. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  317. the associated parameter matches this value.
  318. </param>
  319. </member>
  320. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  321. <summary>Gets the condition parameter value.</summary>
  322. </member>
  323. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  324. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  325. </member>
  326. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  327. <summary>Initializes the attribute with a field or property member.</summary>
  328. <param name="member">
  329. The field or property member that is promised to be not-null.
  330. </param>
  331. </member>
  332. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  333. <summary>Initializes the attribute with the list of field and property members.</summary>
  334. <param name="members">
  335. The list of field and property members that are promised to be not-null.
  336. </param>
  337. </member>
  338. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  339. <summary>Gets field or property member names.</summary>
  340. </member>
  341. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  342. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  343. </member>
  344. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  345. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  346. <param name="returnValue">
  347. The return value condition. If the method returns this value, the associated parameter will not be null.
  348. </param>
  349. <param name="member">
  350. The field or property member that is promised to be not-null.
  351. </param>
  352. </member>
  353. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  354. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  355. <param name="returnValue">
  356. The return value condition. If the method returns this value, the associated parameter will not be null.
  357. </param>
  358. <param name="members">
  359. The list of field and property members that are promised to be not-null.
  360. </param>
  361. </member>
  362. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  363. <summary>Gets the return value condition.</summary>
  364. </member>
  365. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  366. <summary>Gets field or property member names.</summary>
  367. </member>
  368. </members>
  369. </doc>