IniConfigurationExtensions.AddIniFile Method

Definition

Overloads

AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)

Adds a INI configuration source to builder.

AddIniFile(IConfigurationBuilder, String)

Adds the INI configuration provider at path to builder.

AddIniFile(IConfigurationBuilder, String, Boolean)

Adds the INI configuration provider at path to builder.

AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)

Adds the INI configuration provider at path to builder.

AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Adds a INI configuration source to builder.

AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)

Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs

Adds a INI configuration source to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddIniFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.Ini.IniConfigurationSource>? configureSource);

Parameters

configureSource
Action<IniConfigurationSource>

Configures the source.

Returns

The IConfigurationBuilder.

Applies to

.NET 9 (package-provided) and other versions
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)

AddIniFile(IConfigurationBuilder, String)

Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddIniFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path);

Parameters

path
String

The path relative to the base path stored in Properties of builder.

Returns

The IConfigurationBuilder.

Applies to

.NET 9 (package-provided) and other versions
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)

AddIniFile(IConfigurationBuilder, String, Boolean)

Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddIniFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional);

Parameters

path
String

The path relative to the base path stored in Properties of builder.

optional
Boolean

Whether the file is optional.

Returns

The IConfigurationBuilder.

Applies to

.NET 9 (package-provided) and other versions
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)

AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)

Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddIniFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange);

Parameters

path
String

Path relative to the base path stored in Properties of builder.

optional
Boolean

true if the file is optional; otherwise, false.

reloadOnChange
Boolean

Whether the configuration should be reloaded if the file changes; otherwise, false.

Returns

The IConfigurationBuilder.

Applies to

.NET 9 (package-provided) and other versions
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)

AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs
Source:
IniConfigurationExtensions.cs

Adds a INI configuration source to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddIniFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Microsoft.Extensions.FileProviders.IFileProvider? provider, string path, bool optional, bool reloadOnChange);

Parameters

provider
IFileProvider

The IFileProvider to use to access the file.

path
String

Path relative to the base path stored in Properties of builder.

optional
Boolean

true if the file is optional; otherwise, false.

reloadOnChange
Boolean

true if the configuration should be reloaded if the file changes; otherwise, false.

Returns

The IConfigurationBuilder.

Applies to

.NET 9 (package-provided) and other versions
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)