Microsoft.Extensions.Configuration.FileExtensions.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  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 a default action to be invoked for file-based providers when an error occurs.
  46. </summary>
  47. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  48. <returns>The The Action to be invoked on a file load exception, if set.</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.OwnsFileProvider">
  110. <summary>
  111. Set to true when <see cref="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider"/> was not provided by user and can be safely disposed.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
  115. <summary>
  116. The path to the file.
  117. </summary>
  118. </member>
  119. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
  120. <summary>
  121. Determines if loading the file is optional.
  122. </summary>
  123. </member>
  124. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
  125. <summary>
  126. Determines whether the source will be loaded if the underlying file changes.
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
  130. <summary>
  131. Number of milliseconds that reload will wait before calling Load. This helps
  132. avoid triggering reload before a file is completely written. Default is 250.
  133. </summary>
  134. </member>
  135. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
  136. <summary>
  137. Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
  138. </summary>
  139. </member>
  140. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  141. <summary>
  142. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  143. </summary>
  144. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  145. <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  146. </member>
  147. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  148. <summary>
  149. Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
  150. </summary>
  151. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  152. </member>
  153. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
  154. <summary>
  155. If no file provider has been set, for absolute Path, this will creates a physical file provider
  156. for the nearest existing directory.
  157. </summary>
  158. </member>
  159. <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
  160. <summary>
  161. Contains information about a file load exception.
  162. </summary>
  163. </member>
  164. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
  165. <summary>
  166. The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
  167. </summary>
  168. </member>
  169. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
  170. <summary>
  171. The exception that occurred in Load.
  172. </summary>
  173. </member>
  174. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
  175. <summary>
  176. If true, the exception will not be rethrown.
  177. </summary>
  178. </member>
  179. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  180. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  181. <param name="argument">The reference type argument to validate as non-null.</param>
  182. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  183. </member>
  184. <member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
  185. <summary>
  186. Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
  187. if the specified string is <see langword="null"/> or whitespace respectively.
  188. </summary>
  189. <param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
  190. <param name="paramName">The name of the parameter being checked.</param>
  191. <returns>The original value of <paramref name="argument"/>.</returns>
  192. </member>
  193. <member name="P:System.SR.Error_ExpectedPhysicalPath">
  194. <summary>The expected physical path was '{0}'.</summary>
  195. </member>
  196. <member name="P:System.SR.Error_FileNotFound">
  197. <summary>The configuration file '{0}' was not found and is not optional.</summary>
  198. </member>
  199. <member name="P:System.SR.Error_FailedToLoad">
  200. <summary>Failed to load configuration from file '{0}'.</summary>
  201. </member>
  202. </members>
  203. </doc>