WebConfigurationManager.OpenWebConfiguration Method (String)
Opens the Web-application configuration file as a Configuration object using the specified virtual path to allow read or write operations.
Namespace: System.Web.Configuration
Assembly: System.Web (in System.Web.dll)
Parameters
- path
- Type: System.String
The virtual path to the configuration file. If null, the root Web.config file is opened.
| Exception | Condition |
|---|---|
| ConfigurationErrorsException | A valid configuration file could not be loaded. |
To obtain the Configuration object for a resource, your code must have read privileges on all the configuration files from which it inherits settings. To update a configuration file, your code must additionally have write privileges for both the configuration file and the directory in which it exists.
| Topic | Location |
|---|---|
| How to: Read Application Settings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Access ASP.NET Configuration Settings Programmatically | Configuring ASP .NET Web Applications |
| How to: Lock ASP.NET Configuration Settings | Configuring ASP .NET Web Applications |
| How to: View Inherited and Local Configuration Settings Programmatically | Configuring ASP .NET Web Applications |
| How to: Read Application Settings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Access ASP.NET Configuration Settings Programmatically | Configuring ASP .NET Web Applications |
| How to: Lock ASP.NET Configuration Settings | Configuring ASP .NET Web Applications |
| How to: View Inherited and Local Configuration Settings Programmatically | Configuring ASP .NET Web Applications |
The following example shows how to access configuration information with the OpenWebConfiguration method.
// Show how to use OpenWebConfiguration(string).
// It gets he appSettings section of a Web application
// runnig on the local server.
static void OpenWebConfiguration1()
{
// Get the configuration object for a Web application
// running on the local server.
System.Configuration.Configuration config =
WebConfigurationManager.OpenWebConfiguration("/configTest")
as System.Configuration.Configuration;
// Get the appSettings.
KeyValueConfigurationCollection appSettings =
config.AppSettings.Settings;
// Loop through the collection and
// display the appSettings key, value pairs.
Console.WriteLine("[appSettings for app at: {0}]", "/configTest");
foreach (string key in appSettings.AllKeys)
{
Console.WriteLine("Name: {0} Value: {1}",
key, appSettings[key].Value);
}
Console.WriteLine();
}
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.
