This documentation is archived and is not being maintained.

WebConfigurationManager.OpenWebConfiguration Method (String, String, String)

Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, and location to allow read or write operations.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public static Configuration OpenWebConfiguration(
	string path,
	string site,
	string locationSubPath
)

Parameters

path
Type: System.String
The virtual path to the configuration file.
site
Type: System.String
The name of the application Web site, as displayed in Internet Information Services (IIS) configuration.
locationSubPath
Type: System.String
The specific resource to which the configuration applies.

ExceptionCondition
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, string, string).
        // It gets he appSettings section of a Web application 
        // runnig on the local server. 
        static void OpenWebConfiguration3()
        {
            // Get the configuration object for a Web application
            // running on the local server. 
            System.Configuration.Configuration config =
                WebConfigurationManager.OpenWebConfiguration(
                "/configTest", "Default Web Site", null)
                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: /configTest");
            Console.WriteLine(" site: Default Web Site");
            Console.WriteLine(" and locationSubPath: null]");

            foreach (string key in appSettings.AllKeys)
            {
                Console.WriteLine("Name: {0} Value: {1}",
                key, appSettings[key].Value);
            }

            Console.WriteLine();
        }



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: