Export (0) Print
Expand All

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)

public static Configuration OpenWebConfiguration (
	string path
)
public static Configuration OpenWebConfiguration (
	String path
)
public static function OpenWebConfiguration (
	path : String
) : Configuration
Not applicable.

Parameters

path

The virtual path to the configuration file. If a null reference (Nothing in Visual Basic), the root Web.config file is opened.

Return Value

A Configuration object.

Exception typeCondition

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.

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 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft