FileConfigurationProvider Class

Definition

Namespace:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.FileExtensions.dll

Package:

Microsoft.Extensions.Configuration.FileExtensions v10.0.0

Source:

FileConfigurationProvider.cs

Provides the base class for file-based ConfigurationProvider providers.

public ref class FileConfigurationProvider abstract : Microsoft::Extensions::Configuration::ConfigurationProvider, IDisposable

public abstract class FileConfigurationProvider : Microsoft.Extensions.Configuration.ConfigurationProvider, IDisposable

type FileConfigurationProvider = class
    inherit ConfigurationProvider
    interface IDisposable

Public MustInherit Class FileConfigurationProvider
Inherits ConfigurationProvider
Implements IDisposable

Inheritance

Object

ConfigurationProvider

FileConfigurationProvider

Derived

Microsoft.Extensions.Configuration.Ini.IniConfigurationProvider

Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider

Microsoft.Extensions.Configuration.Xml.XmlConfigurationProvider

Implements

IDisposable

Remarks

For more information and examples, see File configuration provider.

Constructors

Name	Description
FileConfigurationProvider(FileConfigurationSource)	Initializes a new instance with the specified source.

Properties

Name	Description
Data	Gets or sets the configuration key-value pairs for this provider. (Inherited from ConfigurationProvider)
Source	Gets the source settings for this provider.

Methods

Name	Description
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)	Disposes the provider.
GetChildKeys(IEnumerable<String>, String)	Returns the list of keys that this provider has. (Inherited from ConfigurationProvider)
GetReloadToken()	Returns a IChangeToken that can be used to listen when this provider is reloaded. (Inherited from ConfigurationProvider)
Load()	Loads the contents of the file at Path.
Load(Stream)	Loads this provider's data from a stream.
OnReload()	Triggers the reload change token and creates a new one. (Inherited from ConfigurationProvider)
Set(String, String)	Sets a value for a given key. (Inherited from ConfigurationProvider)
ToString()	Generates a string representing this provider name and relevant details.
TryGet(String, String)	Attempts to find a value with the given key. (Inherited from ConfigurationProvider)