IniConfigurationSource Class

Definition

Namespace:

Microsoft.Extensions.Configuration.Ini

Assembly:

Microsoft.Extensions.Configuration.Ini.dll

Package:

Microsoft.Extensions.Configuration.Ini v9.0.0-rc.2.24473.5

Source:

IniConfigurationSource.cs

Represents an INI file as an IConfigurationSource. Files are simple line structures (INI Files on Wikipedia)

public ref class IniConfigurationSource : Microsoft::Extensions::Configuration::FileConfigurationSource

public class IniConfigurationSource : Microsoft.Extensions.Configuration.FileConfigurationSource

type IniConfigurationSource = class
    inherit FileConfigurationSource

Public Class IniConfigurationSource
Inherits FileConfigurationSource

Inheritance

Object

FileConfigurationSource

IniConfigurationSource

Examples

[Section:Header]
key1=value1
key2 = " value2 "
; comment
# comment
/ comment

Remarks

INI files are simple line structures.

Constructors

IniConfigurationSource()

Initializes a new instance of IniConfigurationSource.

Properties

FileProvider	Gets or sets the provider used to access the contents of the file. (Inherited from FileConfigurationSource)
OnLoadException	Gets or sets the action that's called if an uncaught exception occurs in FileConfigurationProvider.Load. (Inherited from FileConfigurationSource)
Optional	Gets or sets a value that indicates whether loading the file is optional. (Inherited from FileConfigurationSource)
Path	Gets or sets the path to the file. (Inherited from FileConfigurationSource)
ReloadDelay	Gets or sets the number of milliseconds that reload will wait before calling Load. (Inherited from FileConfigurationSource)
ReloadOnChange	Gets or sets a value that indicates whether the source will be loaded if the underlying file changes. (Inherited from FileConfigurationSource)

Methods

Build(IConfigurationBuilder)	Builds the IniConfigurationProvider for this source.
EnsureDefaults(IConfigurationBuilder)	Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler. (Inherited from FileConfigurationSource)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ResolveFileProvider()	Creates a physical file provider for the nearest existing directory if no file provider has been set, for absolute Path. (Inherited from FileConfigurationSource)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• INI Files on Wikipedia