WebConfigurationManager.AppSettings Property

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

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.

Gets the Web site's application settings.

public:
 static property System::Collections::Specialized::NameValueCollection ^ AppSettings { System::Collections::Specialized::NameValueCollection ^ get(); };

public static System.Collections.Specialized.NameValueCollection AppSettings { get; }

static member AppSettings : System.Collections.Specialized.NameValueCollection

Public Shared ReadOnly Property AppSettings As NameValueCollection

Property Value

NameValueCollection

A NameValueCollection object that contains the AppSettingsSection object for the current Web application's default configuration.

Exceptions

ConfigurationErrorsException

A valid NameValueCollection object could not be retrieved with the application settings data.

Examples

The following example shows how to access configuration information with the AppSettings method.


// Show the use of the AppSettings property
// to get the application settings. 
static void GetAppSettings()
{

    // Get the appSettings key,value pairs collection.
    NameValueCollection appSettings =
        WebConfigurationManager.AppSettings
        as NameValueCollection;

    // Get the collection enumerator.
    IEnumerator appSettingsEnum =
        appSettings.GetEnumerator();

    // Loop through the collection and 
    // display the appSettings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display appSettings]");
    while (appSettingsEnum.MoveNext())
    {
        string key = appSettings.AllKeys[i].ToString();
        Console.WriteLine("Key: {0} Value: {1}",
        key, appSettings[key]);
        i += 1;
    }

    Console.WriteLine();
}

' Show the use of AppSettings property
' to get the application settings.
Shared Sub GetAppSettings()
   
   ' Get the appSettings key,value pairs collection.
     Dim appSettings As NameValueCollection = _
     WebConfigurationManager.AppSettings
   
   ' Get the collection enumerator.
     Dim appSettingsEnum As IEnumerator = _
     appSettings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the appSettings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display appSettings]")
   While appSettingsEnum.MoveNext()
      Dim key As String = appSettings.AllKeys(i)
         Console.WriteLine("Key: {0} Value: {1}", _
         key, appSettings(key))
      i += 1
   End While
   
   Console.WriteLine()
End Sub

Remarks

An AppSettingsSection object contains the configuration file's <appSettings> section.

Applies to