Click here to Skip to main content
Click here to Skip to main content

Configuration Settings File for providing application configuration data

, 26 Mar 2004
Rate this:
Please Sign up or sign in to vote.
This article talks about the 'Application Configuration' File in .NET and provides sample code to read from the config file.

Introduction

.NET gives an easy way to store configuration information in an Application Configuration File. In the simple implementation, you can store information as Key-Value pairs.

For example, consider a case where you have to use a data source in your application. If you hardcore the data source information in your code, you will have a bad time when you have to change this data source. You have to change your source code and re-compile it. This won't work every time you give your product to different customers or when you run your application in different machines!

In earlier days, programmers used to store this information in special files called .ini files or in system registry. The application can read the information from the .ini file or registry and no need to re-compile the code when the values are changed in .ini file or registry.

But this is a pain most of the time. It is not fun opening the registry, locate your entries and make appropriate changes. It is quite possible that you may mess up with some important entries in the registry and make your system not run any more. In fact, in secured systems, administrator may deny access to the registry and users will not have the choice to edit the registry at all.

.NET gives you a simple and easy solution for this problem - the Application Configuration File. Each application can have a configuration file, which is actually an XML file. You can use any text editor (including Notepad) to open the configuration file and change the values. The application will load the values from this configuration file and you do not have to change your source code every time you change your data source or any other information stored in the configuration file.

app.config for Windows applications

Windows applications in VS.NET use the name app.config by default for the configuration file. This will not be automatically created when you create a Windows application. If you need a configuration file for your application, open your project in VS.NET, go to the 'Solution Explorer' and right click on the project name. Choose Add > Add new item from the menu and select 'Application Configuration file' from the list of choices. This will create an app.config file for you in the application root.

By default, the app.config file will have the following content:

<?xml version="1.0" encoding="utf-8" ?> 

<configuration> 

</configuration>

To store values in the configuration file, you can create XML elements in the format:

<add key="MyKey" value="MyValue" />

See the sample config entries below:

<?xml version="1.0" encoding=    "utf-8" ?>

<configuration>

<appSettings>

    <add key="DatabasePath" value="c:\\projects\data\spider.mdb" />

    <add key="SupportEmail" value="webmaster-1@dotnetspider.com" />

</appSettings>

</configuration>

And to read from this config file, just use the following code in your application:

string dbPath = 
  System.Configuration.ConfigurationSettings.AppSettings["DatabasePath"];
string email = 
  System.Configuration.ConfigurationSettings.AppSettings["SupportEmail"];

ConfigurationSettings is the class used to access the contents of the configuration file. Since this class is part of the namespace System.Configuration, we have to use the fully qualified name System.Configuration.ConfigurationSettings. As a shortcut, you can use the using directive on top of the file like below:

using System.Configuration;

If you have the above directive on top of the file, then you can directly use the class ConfigurationSettings.

string dbPath = ConfigurationSettings.AppSettings["DatabasePath"];
string email = ConfigurationSettings.AppSettings["SupportEmail"];

In VB.NET, you have to use "( ... )" instead of the "[ ... ]", as shown below:

Dim dbPath as String = ConfigurationSettings.AppSettings("DatabasePath")
Dim email as String = ConfigurationSettings.AppSettings("SupportEmail")

Note: When you compile your application, VS.NET will automatically create a file called <your application name>.exe.config in your bin\debug folder. The contents of the app.config will be automatically copied to this new config file when you compile the application. When you deliver the application to the end user, you have to deliver the exe and this new config file called <your application name>.exe.config and NOT the app.config. Users can modify the data in <your application name>.exe.config file and application will read the data from the config file, when restarted.

web.config for Windows applications

The web applications use the same concept, but they use a config file with the name web.config. There are couple of things to note in this case.

  • web.config is created automatically by VS.NET when you create any web project.
  • When you compile the web application, web.config is NOT renamed or copied to the BIN folder.
  • web.config has several default entries in it to support web/IIS configuration & security.
  • You can add the <appSettings> section in the web.config and add your key/value pairs in that section.
  • You can have separate web.config files for each directory in your web application, in addition to the one in the root. For each web page, by default, system will look for a web.config in the same folder as the page and if not found, then looks in the parent folder.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

T Manjaly
Web Developer
India India
Tony is a seasoned .NET developer who recently switched his focus to Windows 8 and SEO. You may visit his technology websites: www.dotnetspider.com and www.techulator.com.
Follow on   Twitter   Google+

Comments and Discussions

 
GeneralMy vote of 3 PinmemberPaul Sincai30-May-14 2:45 
GeneralMy vote of 4 Pinmemberemory reid6-Apr-13 3:46 
GeneralMy vote of 5 Pinmembermichael wondimu16-Aug-12 23:54 
QuestionAppication Configuration - connection string Pinmemberpuchie25-Jul-11 18:03 
GeneralMultiple projects and one settings config file Pinmemberelitefox23-Jan-11 15:56 
GeneralSolves my problem Pinmembermayuri12315-Apr-08 20:53 
GeneralRe: Offshore Software Development PinmemberPete O'Hanlon7-Sep-07 4:50 
GeneralApp Config PinmemberStixoffire224-Aug-06 11:06 
GeneralRe: App Config Pinmembermarklsdev9-Oct-06 3:10 
That's because XML does not allow for those characters or for newlines unless you use a CDATA block.
GeneralA great article Pinmemberplaster23-Feb-06 23:08 
GeneralRe: A great article Pinmemberllcoollasa1-Apr-09 23:23 
GeneralRe: A great article PinmemberSreerenj21-Jul-09 6:07 
QuestionCan config file store HTML value? Pinmemberyancyn1-Feb-06 21:25 
AnswerRe: Can config file store HTML value? [modified] Pinmembermr_mark_hewitt18-Jul-06 3:08 
GeneralBlock Modify PinmemberVitoto7-May-05 10:12 
GeneralFound the problem PinsussMumita19-Apr-05 0:08 
Generalhelp PinsussMumita15-Apr-05 3:03 
GeneralRe: help PinsussAnonymous15-Apr-05 4:48 
GeneralRe: help PinsussMumita15-Apr-05 5:58 
GeneralRe: help PinsussMumita15-Apr-05 6:00 
GeneralMany Thanks PinmemberDon Cassas11-Mar-05 6:29 
GeneralThanks ! PinmemberLim Bio Liong5-Dec-04 0:46 
GeneralMissing info PinmemberSteven Campbell28-Mar-04 14:22 
GeneralRe: Missing info PinmemberT Manjaly28-Mar-04 14:30 
GeneralRe: Missing info Pinmember0siris29-Mar-04 4:25 
GeneralRe: Missing info PinmemberT Manjaly29-Mar-04 4:37 
GeneralRe: Missing info PinsussJeff Azcue1-Apr-04 7:44 
GeneralRe: Missing info PinmemberSreerenj21-Jul-09 6:20 
GeneralMany thanks Pinmemberelp?28-Mar-04 7:51 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.141220.1 | Last Updated 27 Mar 2004
Article Copyright 2004 by T Manjaly
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid