Retrieve appSettings Values from Web.config in ASP.NET (C# & VB.NET)

Looking to retrieve appSettings values in ASP.NET from Web.config? This guide will help you quickly access configuration values using both C# and VB.NET, explaining the differences between appSettings and connectionStrings for clear usage in your ASP.NET applications. Read on for more ASP.NET configuration tips and resources.

Retrieve appSettings Values in ASP.NET from Web.config

The <appSettings> section in Web.config allows developers to store configuration values, such as API keys and default paths, for easy access throughout an ASP.NET application. Unlike the <connectionStrings> section, which is generally reserved for secure information, <appSettings> holds non-sensitive key-value pairs for general settings.

By following these steps, you can efficiently retrieve appSettings values in ASP.NET for various uses.

Defining appSettings Values in Web.config

To define appSettings values in Web.config, simply add the key-value pairs inside the <appSettings> section:

<appSettings>
    <add key="myDbConnection" value="Data Source=myServer;Integrated Security=true;Initial Catalog=myDatabase" />
</appSettings>

Retrieve appSettings Values in ASP.NET with C#

In C#, you can retrieve appSettings values by adding a reference to System.Configuration and using ConfigurationManager.AppSettings:

using System.Configuration;

protected void Page_Load(object sender, EventArgs e)
{
    string connectionString = ConfigurationManager.AppSettings["myDbConnection"];
}

How to Retrieve appSettings Values in ASP.NET with VB.NET

For VB.NET users, retrieving appSettings values is straightforward:

Imports System.Configuration

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    Dim connectionString As String = ConfigurationManager.AppSettings("myDbConnection")
End Sub

When to Use appSettings vs. connectionStrings in ASP.NET

The appSettings section is perfect for storing general configuration values, such as debugging flags or non-sensitive API keys. For database credentials or other sensitive information, it’s safer to use the connectionStrings section. Check the Microsoft documentation for detailed guidance on configuration settings.

Use Cases for appSettings in ASP.NET

• Feature Toggles: Enable or disable features by adjusting appSettings values.
• Environment-Specific Configurations: Set environment-dependent values like API endpoints and feature flags.
• Default Application Settings: Store reusable defaults, such as file paths or API versions.

Conclusion

Using ConfigurationManager.AppSettings lets you access appSettings values quickly and manage configuration settings in one place. For more ASP.NET tips on configuration, view our ASP.NET tutorials.