XmlConfigurationExtensions.AddXmlFile Method

Definition

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.Xml.dll

Package:: Microsoft.Extensions.Configuration.Xml v10.0.0-preview.7.25380.108

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

AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Adds an XML configuration source to `builder`.
AddXmlFile(IConfigurationBuilder, String)	Adds the XML configuration provider at `path` to `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Adds the XML configuration provider at `path` to `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Adds the XML configuration provider at `path` to `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adds an XML configuration source to `builder`.

AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Adds an XML configuration source to builder.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddXmlFile(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Action<Microsoft::Extensions::Configuration::Xml::XmlConfigurationSource ^> ^ configureSource);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")]
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource>? configureSource);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource>? configureSource);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")>]
static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddXmlFile (builder As IConfigurationBuilder, configureSource As Action(Of XmlConfigurationSource)) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

configureSource: Action<XmlConfigurationSource>

Configures the source.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Attributes: RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Applies to

AddXmlFile(IConfigurationBuilder, String)

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Adds the XML configuration provider at path to builder.

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

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")]
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path);

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

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")>]
static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string -> Microsoft.Extensions.Configuration.IConfigurationBuilder

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

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

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

path: String

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

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Attributes: RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Applies to

AddXmlFile(IConfigurationBuilder, String, Boolean)

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Adds the XML configuration provider at path to builder.

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

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")]
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional);

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

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")>]
static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

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

<Extension()>
Public Function AddXmlFile (builder As IConfigurationBuilder, path As String, optional 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.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Attributes: RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Applies to

AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Adds the XML configuration provider at path to builder.

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

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")]
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange);

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

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")>]
static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * bool * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

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

<Extension()>
Public Function AddXmlFile (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.

reloadOnChange: Boolean

Whether the configuration should be reloaded if the file changes.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Attributes: RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Applies to

AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Source:: XmlConfigurationExtensions.cs

Adds an XML configuration source to builder.

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

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")]
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddXmlFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Microsoft.Extensions.FileProviders.IFileProvider? provider, string path, bool optional, bool reloadOnChange);

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

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml which may contain XSLTs in the xml. XSLTs require dynamic code.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.Xml can use EncryptedXml. If you use encrypted XML files, your application might not have the algorithm implementations it needs. To avoid this problem, one option you can use is a DynamicDependency attribute to keep the algorithm implementations in your application.")>]
static member AddXmlFile : Microsoft.Extensions.Configuration.IConfigurationBuilder * Microsoft.Extensions.FileProviders.IFileProvider * string * bool * bool -> Microsoft.Extensions.Configuration.IConfigurationBuilder

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

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