Export (0) Print
Expand All

AppSettingsReader Class

Provides a method for reading values of a particular type from the configuration.

System.Object
  System.Configuration.AppSettingsReader

Namespace:  System.Configuration
Assembly:  System (in System.dll)

public class AppSettingsReader

The AppSettingsReader type exposes the following members.

  NameDescription
Public methodAppSettingsReaderInitializes a new instance of the AppSettingsReader class.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueGets the value for a specified key from the AppSettings property and returns an object of the specified type containing the value from the configuration.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following example creates a configuration file that contains the <appSettings> section, and then uses the AppSettingsReader to read the settings just generated.

using System;
using System.Configuration;

class Program
{
    static void Main(string[] args)
    {
        var reader = new AppSettingsReader();

        var stringSetting = reader.GetValue("String setting", typeof(string));
        Console.WriteLine("String setting: " + stringSetting);

        var dateTimeSetting = reader.GetValue("DateTime setting", typeof(DateTime));
        Console.WriteLine("DateTime setting: " + dateTimeSetting);

        try
        {
            var missingSetting = reader.GetValue("Int setting", typeof(Int32));
        }
        catch (InvalidOperationException e)
        {
            Console.WriteLine("Missing key error: " + e.Message);
        }

        Console.WriteLine("Press any key to continue");
        Console.ReadKey();
    }
}

The following example demonstrates a configuration file used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appSettings>
        <add key="String setting" value="String retrieved from App.Config"/>
        <add key="Date setting" value="Thursday, December 01, 2005 12:53:56 PM"/>
    </appSettings>
</configuration>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft