IniConfigurationSource Class

Definition

Represents an INI file as an IConfigurationSource.

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

Used to access the contents of the file.

(Inherited from FileConfigurationSource)
OnLoadException

Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.

(Inherited from FileConfigurationSource)
Optional

Determines if loading the file is optional.

(Inherited from FileConfigurationSource)
Path

The path to the file.

(Inherited from FileConfigurationSource)
ReloadDelay

Number of milliseconds that reload will wait before calling Load. This helps avoid triggering reload before a file is completely written. Default is 250.

(Inherited from FileConfigurationSource)
ReloadOnChange

Determines 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()

If no file provider has been set, for absolute Path, this will creates a physical file provider for the nearest existing directory.

(Inherited from FileConfigurationSource)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also