Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

WebConfigurationManager.OpenWebConfiguration Method (String, String, String, String)

Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, location, and server 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,
	string server
)

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.
server
Type: System.String
The network name of the server the Web application resides on.

ExceptionCondition
ArgumentException

The server parameter was invalid.

ConfigurationErrorsException

A valid configuration file could not be loaded.

To obtain the Configuration object for a remote resource, your code must have administrative privileges on the remote computer.

The following example shows how to access configuration information with the OpenWebConfiguration method.



        // Show how to use OpenWebConfiguration(string, string, 
        // string, string).
        // It gets he appSettings section of a Web application 
        // running on the specified server. 
        // If the server is remote your application must have the
        // required access rights to the configuration file. 
        static void OpenWebConfiguration4()
        {
            // Get the configuration object for a Web application
            // running on the specified server.
            // Null for the subPath signifies no subdir. 
            System.Configuration.Configuration config =
                   WebConfigurationManager.OpenWebConfiguration(
                    "/configTest", "Default Web Site", null, "myServer")
                   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 Web app on server: myServer]");
            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.

Community Additions

ADD
Show:
© 2015 Microsoft