ConfigurationBinder.GetValue Method

Definition

Namespace:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.Binder.dll

Package:

Microsoft.Extensions.Configuration.Binder v9.0.0

Overloads

GetValue(IConfiguration, Type, String)	Extracts the value with the specified key and converts it to the specified type.
GetValue(IConfiguration, Type, String, Object)	Extracts the value with the specified key and converts it to the specified type.
GetValue<T>(IConfiguration, String)	Extracts the value with the specified key and converts it to type T.
GetValue<T>(IConfiguration, String, T)	Extracts the value with the specified key and converts it to type T.

GetValue(IConfiguration, Type, String)

Source:

ConfigurationBinder.cs

Extracts the value with the specified key and converts it to the specified type.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Object ^ GetValue(Microsoft::Extensions::Configuration::IConfiguration ^ configuration, Type ^ type, System::String ^ key);

public static object? GetValue (this Microsoft.Extensions.Configuration.IConfiguration configuration, Type type, string key);

static member GetValue : Microsoft.Extensions.Configuration.IConfiguration * Type * string -> obj

<Extension()>
Public Function GetValue (configuration As IConfiguration, type As Type, key As String) As Object

Parameters

configuration

IConfiguration

The configuration.

type

Type

The type to convert the value to.

key

String

The key of the configuration section's value to convert.

Returns

Object

The converted value.

GetValue(IConfiguration, Type, String, Object)

Source:

ConfigurationBinder.cs

Extracts the value with the specified key and converts it to the specified type.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Object ^ GetValue(Microsoft::Extensions::Configuration::IConfiguration ^ configuration, Type ^ type, System::String ^ key, System::Object ^ defaultValue);

public static object? GetValue (this Microsoft.Extensions.Configuration.IConfiguration configuration, Type type, string key, object? defaultValue);

static member GetValue : Microsoft.Extensions.Configuration.IConfiguration * Type * string * obj -> obj

<Extension()>
Public Function GetValue (configuration As IConfiguration, type As Type, key As String, defaultValue As Object) As Object

Parameters

configuration

IConfiguration

The configuration.

type

Type

The type to convert the value to.

key

String

The key of the configuration section's value to convert.

defaultValue

Object

The default value to use if no value is found.

Returns

Object

The converted value.

GetValue<T>(IConfiguration, String)

Source:

ConfigurationBinder.cs

Extracts the value with the specified key and converts it to type T.

public:
generic <typename T>
[System::Runtime::CompilerServices::Extension]
 static T GetValue(Microsoft::Extensions::Configuration::IConfiguration ^ configuration, System::String ^ key);

public static T? GetValue<T> (this Microsoft.Extensions.Configuration.IConfiguration configuration, string key);

static member GetValue : Microsoft.Extensions.Configuration.IConfiguration * string -> 'T

<Extension()>
Public Function GetValue(Of T) (configuration As IConfiguration, key As String) As T

Type Parameters

T

The type to convert the value to.

Parameters

configuration

IConfiguration

The configuration.

key

String

The key of the configuration section's value to convert.

Returns

T

The converted value.

GetValue<T>(IConfiguration, String, T)

Source:

ConfigurationBinder.cs

Extracts the value with the specified key and converts it to type T.

public:
generic <typename T>
[System::Runtime::CompilerServices::Extension]
 static T GetValue(Microsoft::Extensions::Configuration::IConfiguration ^ configuration, System::String ^ key, T defaultValue);

public static T? GetValue<T> (this Microsoft.Extensions.Configuration.IConfiguration configuration, string key, T defaultValue);

static member GetValue : Microsoft.Extensions.Configuration.IConfiguration * string * 'T -> 'T

<Extension()>
Public Function GetValue(Of T) (configuration As IConfiguration, key As String, defaultValue As T) As T

Type Parameters

T

The type to convert the value to.

Parameters

configuration

IConfiguration

The configuration.

key

String

The key of the configuration section's value to convert.

defaultValue

T

The default value to use if no value is found.

Returns

T

The converted value.