Microsoft.Extensions.Configuration.FileExtensions.xml 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  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 <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</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.Load">
  67. <summary>
  68. Loads the contents of the file at <see cref="T:System.IO.Path"/>.
  69. </summary>
  70. <exception cref="T:System.IO.FileNotFoundException">If Optional is <c>false</c> on the source and a
  71. file does not exist at specified Path.</exception>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">
  74. <summary>
  75. Loads this provider's data from a stream.
  76. </summary>
  77. <param name="stream">The stream to read.</param>
  78. </member>
  79. <member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">
  80. <summary>
  81. Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  82. </summary>
  83. </member>
  84. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">
  85. <summary>
  86. Used to access the contents of the file.
  87. </summary>
  88. </member>
  89. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
  90. <summary>
  91. The path to the file.
  92. </summary>
  93. </member>
  94. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
  95. <summary>
  96. Determines if loading the file is optional.
  97. </summary>
  98. </member>
  99. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
  100. <summary>
  101. Determines whether the source will be loaded if the underlying file changes.
  102. </summary>
  103. </member>
  104. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
  105. <summary>
  106. Number of milliseconds that reload will wait before calling Load. This helps
  107. avoid triggering reload before a file is completely written. Default is 250.
  108. </summary>
  109. </member>
  110. <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
  111. <summary>
  112. Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
  113. </summary>
  114. </member>
  115. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  116. <summary>
  117. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  118. </summary>
  119. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  120. <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  121. </member>
  122. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  123. <summary>
  124. Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
  125. </summary>
  126. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  127. </member>
  128. <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
  129. <summary>
  130. If no file provider has been set, for absolute Path, this will creates a physical file provider
  131. for the nearest existing directory.
  132. </summary>
  133. </member>
  134. <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
  135. <summary>
  136. Contains information about a file load exception.
  137. </summary>
  138. </member>
  139. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
  140. <summary>
  141. The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
  142. </summary>
  143. </member>
  144. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
  145. <summary>
  146. The exception that occured in Load.
  147. </summary>
  148. </member>
  149. <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
  150. <summary>
  151. If true, the exception will not be rethrown.
  152. </summary>
  153. </member>
  154. <member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_ExpectedPhysicalPath">
  155. <summary>
  156. The expected physical path was '{0}'.
  157. </summary>
  158. </member>
  159. <member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_ExpectedPhysicalPath(System.Object)">
  160. <summary>
  161. The expected physical path was '{0}'.
  162. </summary>
  163. </member>
  164. <member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_FileNotFound">
  165. <summary>
  166. The configuration file '{0}' was not found and is not optional.
  167. </summary>
  168. </member>
  169. <member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_FileNotFound(System.Object)">
  170. <summary>
  171. The configuration file '{0}' was not found and is not optional.
  172. </summary>
  173. </member>
  174. </members>
  175. </doc>