Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IniConfigurationExtensions.AddIniFile Method

Definition

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.Ini.dll

Package:: Microsoft.Extensions.Configuration.Ini v11.0.0-preview.5.26302.115

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
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

Source:: IniConfigurationExtensions.cs

Adds a INI configuration source to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddIniFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Action<Microsoft::Extensions::Configuration::Ini::IniConfigurationSource ^> ^ configureSource);

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

static member AddIniFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.Ini.IniConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddIniFile (builder As IConfigurationBuilder, configureSource As Action(Of IniConfigurationSource)) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

configureSource: Action<IniConfigurationSource>

Configures the source.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddIniFile(IConfigurationBuilder, String)

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddIniFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, System::String ^ path);

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

static member AddIniFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddIniFile (builder As IConfigurationBuilder, path As String) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

path: String

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

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddIniFile(IConfigurationBuilder, String, Boolean)

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddIniFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, System::String ^ path, bool optional);

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

static member AddIniFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddIniFile (builder As IConfigurationBuilder, path As String, optional As Boolean) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

path: String

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

optional: Boolean

true if the file is optional; otherwise, false .

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Adds the INI configuration provider at path to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddIniFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, System::String ^ path, bool optional, bool reloadOnChange);

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

static member AddIniFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * bool * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddIniFile (builder As IConfigurationBuilder, path As String, optional As Boolean, reloadOnChange As Boolean) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

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

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

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

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Source:: IniConfigurationExtensions.cs

Adds a INI configuration source to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddIniFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Microsoft::Extensions::FileProviders::IFileProvider ^ provider, System::String ^ path, bool optional, bool reloadOnChange);

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

static member AddIniFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * Microsoft.Extensions.FileProviders.IFileProvider * string * bool * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddIniFile (builder As IConfigurationBuilder, provider As IFileProvider, path As String, optional As Boolean, reloadOnChange As Boolean) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

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

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration.iniconfigurationextensions.addinifile?view=net-11.0-pp