OpenWebConfiguration Method (String)

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
)

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.

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();
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft