FileConfigurationProvider Class

Definition

Provides the base class for file-based ConfigurationProvider providers.

C#
public abstract class FileConfigurationProvider : Microsoft.Extensions.Configuration.ConfigurationProvider, IDisposable
Inheritance
FileConfigurationProvider
Derived
Implements

Remarks

For more information and examples, see File configuration provider.

Constructors

FileConfigurationProvider(FileConfigurationSource)

Initializes a new instance with the specified source.

Properties

Data

Gets or sets the configuration key-value pairs for this provider.

(Inherited from ConfigurationProvider)
Source

Gets the source settings for this provider.

Methods

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)

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)