Edit

AppSettingsReader.GetValue(String, Type) Method

  • Reference

Definition

Namespace:
System.Configuration
Assembly:
System.Configuration.ConfigurationManager.dll
Assembly:
System.dll
Package:
System.Configuration.ConfigurationManager v6.0.0
Package:
System.Configuration.ConfigurationManager v7.0.0
Package:
System.Configuration.ConfigurationManager v8.0.0
Package:
System.Configuration.ConfigurationManager v9.0.0-preview.2.24128.5
Source:
AppSettingsReader.cs
Source:
AppSettingsReader.cs
Source:
AppSettingsReader.cs

Gets the value for a specified key from the AppSettings property and returns an object of the specified type containing the value from the configuration.

public:
 System::Object ^ GetValue(System::String ^ key, Type ^ type);
public object GetValue (string key, Type type);
member this.GetValue : string * Type -> obj
Public Function GetValue (key As String, type As Type) As Object

Parameters

key
String

The key for which to get the value.

type
Type

The type of the object to return.

Returns

Object

The value of the specified key.

Exceptions

ArgumentNullException

key is null.

-or-

type is null.

InvalidOperationException

key does not exist in the <appSettings> configuration section.

-or-

The value in the <appSettings> configuration section for key is not of type type.

Examples

The following example shows how to use the GetValue method to retrieve the value for each key in the <appSettings> section of the configuration file.

static void DisplayAppSettings()
{
    try
    {
        var reader = new AppSettingsReader();

        NameValueCollection appSettings = ConfigurationManager.AppSettings;

        for (int i = 0; i < appSettings.Count; i++)
        {
            string key = appSettings.GetKey(i);
            string value = (string)reader.GetValue(key, typeof(string));
            Console.WriteLine("Key : {0} Value: {1}", key, value);
        }
    }
    catch (ConfigurationErrorsException e)
    {
        Console.WriteLine("[DisplayAppSettings: {0}]", e.ToString());
    }
}

Private Shared Sub DisplayAppSettings()

    Try
        Dim reader As New AppSettingsReader()

        Dim appSettings As NameValueCollection = ConfigurationManager.AppSettings

        For i As Integer = 0 To appSettings.Count - 1
            Dim key As String = appSettings.GetKey(i)
            Dim value As String = reader.GetValue(key, GetType(String))
            Console.WriteLine("Key : {0} Value: {1}", key, value)
        Next i

    Catch e As ConfigurationErrorsException
        Console.WriteLine("[DisplayAppSettings: {0}]", e.ToString())
    End Try

End Sub

Applies to

See also