Microsoft.Extensions.Configuration.FileExtensions.xml
|
<?xml version="1.0" encoding="utf-8"?>
<doc> <assembly> <name>Microsoft.Extensions.Configuration.FileExtensions</name> </assembly> <members> <member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions"> <summary>Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider" />.</summary> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)"> <summary>Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider" /> to be used for file-based providers.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param> <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)"> <summary>Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider" /> to be used for file-based providers.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param> <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)"> <summary>Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> to add to.</param> <param name="basePath">The absolute path of file-based providers.</param> <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})"> <summary>Sets a default action to be invoked for file-based providers when an error occurs.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> to add to.</param> <param name="handler">The Action to be invoked on a file load exception.</param> <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)"> <summary>Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider" /> to be used for file-based providers.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> to add to.</param> <param name="fileProvider">The default file provider instance.</param> <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns> </member> <member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"> <summary>Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider" />.</summary> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)"> <summary>Initializes a new instance with the specified source.</summary> <param name="source">The source settings.</param> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose"> <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose(System.Boolean)"> <summary>Dispose the provider.</summary> <param name="disposing"> <see langword="true" /> if invoked from <see cref="M:System.IDisposable.Dispose" />.</param> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load"> <summary>Loads the contents of the file at <see cref="T:System.IO.Path" />.</summary> <exception cref="T:System.IO.FileNotFoundException">If Optional is <see langword="false" /> on the source and a file does not exist at specified Path.</exception> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)"> <summary>Loads this provider's data from a stream.</summary> <param name="stream">The stream to read.</param> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.ToString"> <summary>Generates a string representing this provider name and relevant details.</summary> <returns>The configuration name.</returns> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source"> <summary>The source settings for this provider.</summary> </member> <member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource"> <summary>Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource" />.</summary> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.#ctor" /> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)"> <summary>Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> for this source.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param> <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /></returns> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)"> <summary>Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.</summary> <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param> </member> <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider"> <summary>If no file provider has been set, for absolute Path, this will creates a physical file provider for the nearest existing directory.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider"> <summary>Used to access the contents of the file.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException"> <summary>Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional"> <summary>Determines if loading the file is optional.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path"> <summary>The path to the file.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay"> <summary>Number of milliseconds that reload will wait before calling Load. This helps avoid triggering reload before a file is completely written. Default is 250.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange"> <summary>Determines whether the source will be loaded if the underlying file changes.</summary> </member> <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext"> <summary>Contains information about a file load exception.</summary> </member> <member name="M:Microsoft.Extensions.Configuration.FileLoadExceptionContext.#ctor" /> <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception"> <summary>The exception that occurred in Load.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore"> <summary>If true, the exception will not be rethrown.</summary> </member> <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider"> <summary>The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider" /> that caused the exception.</summary> </member> </members> </doc> |