1 <?xml version="1.0"?>
\r
4 <name>Microsoft.Extensions.Configuration.FileExtensions</name>
\r
7 <member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions">
\r
9 Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
\r
12 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)">
\r
14 Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
\r
16 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
\r
17 <param name="fileProvider">The default file provider instance.</param>
\r
18 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
20 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
\r
22 Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
\r
24 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
\r
25 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
27 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
\r
29 Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.
\r
31 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
\r
32 <param name="basePath">The absolute path of file-based providers.</param>
\r
33 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
35 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})">
\r
37 Sets a default action to be invoked for file-based providers when an error occurs.
\r
39 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
\r
40 <param name="handler">The Action to be invoked on a file load exception.</param>
\r
41 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
43 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
\r
45 Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
\r
47 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
\r
48 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
50 <member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider">
\r
52 Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
\r
55 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)">
\r
57 Initializes a new instance with the specified source.
\r
59 <param name="source">The source settings.</param>
\r
61 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source">
\r
63 The source settings for this provider.
\r
66 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.ToString">
\r
68 Generates a string representing this provider name and relevant details.
\r
70 <returns> The configuration name. </returns>
\r
72 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load">
\r
74 Loads the contents of the file at <see cref="T:System.IO.Path"/>.
\r
76 <exception cref="T:System.IO.FileNotFoundException">If Optional is <c>false</c> on the source and a
\r
77 file does not exist at specified Path.</exception>
\r
79 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">
\r
81 Loads this provider's data from a stream.
\r
83 <param name="stream">The stream to read.</param>
\r
85 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose">
\r
88 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose(System.Boolean)">
\r
90 Dispose the provider.
\r
92 <param name="disposing"><c>true</c> if invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
\r
94 <member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">
\r
96 Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
\r
99 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">
\r
101 Used to access the contents of the file.
\r
104 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
\r
106 The path to the file.
\r
109 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
\r
111 Determines if loading the file is optional.
\r
114 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
\r
116 Determines whether the source will be loaded if the underlying file changes.
\r
119 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
\r
121 Number of milliseconds that reload will wait before calling Load. This helps
\r
122 avoid triggering reload before a file is completely written. Default is 250.
\r
125 <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
\r
127 Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
\r
130 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
\r
132 Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
\r
134 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
\r
135 <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
\r
137 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
\r
139 Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
\r
141 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
\r
143 <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
\r
145 If no file provider has been set, for absolute Path, this will creates a physical file provider
\r
146 for the nearest existing directory.
\r
149 <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
\r
151 Contains information about a file load exception.
\r
154 <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
\r
156 The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
\r
159 <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
\r
161 The exception that occured in Load.
\r
164 <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
\r
166 If true, the exception will not be rethrown.
\r
169 <member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_ExpectedPhysicalPath">
\r
170 <summary>The expected physical path was '{0}'.</summary>
\r
172 <member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_ExpectedPhysicalPath(System.Object)">
\r
173 <summary>The expected physical path was '{0}'.</summary>
\r
175 <member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_FileNotFound">
\r
176 <summary>The configuration file '{0}' was not found and is not optional.</summary>
\r
178 <member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_FileNotFound(System.Object)">
\r
179 <summary>The configuration file '{0}' was not found and is not optional.</summary>
\r