Export (0) Print
Expand All

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

Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, location, server, and security context 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,
	string userName,
	string password
)
public static Configuration OpenWebConfiguration (
	String path, 
	String site, 
	String locationSubPath, 
	String server, 
	String userName, 
	String password
)
public static function OpenWebConfiguration (
	path : String, 
	site : String, 
	locationSubPath : String, 
	server : String, 
	userName : String, 
	password : String
) : Configuration
Not applicable.

Parameters

path

The virtual path to the configuration file.

site

The name of the application Web site, as displayed in Internet Information Services (IIS) configuration.

locationSubPath

The specific resource to which the configuration applies.

server

The network name of the server the Web application resides on.

userName

The full user name (Domain\User) to use when opening the file.

password

The password for the user name.

Return Value

A Configuration object.

Exception typeCondition

ArgumentException

The server or userName and password parameters were invalid.

ConfigurationErrorsException

Could not load a valid configuration file.

This method is used to access a configuration file using impersonation.

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

You might need to run the ASP.NET IIS Registration Tool (Aspnet_regiis.exe) with the -config+ option to enable access to the configuration files 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, string, string).
// it gets he appSettings section of a Web application 
// running on a remote server. 
// If the server is remote your application must have the
// required access rights to the configuration file. 
static void OpenWebConfiguration5()
{
    // Get the current user.
    string user =
        System.Security.Principal.WindowsIdentity.GetCurrent().Name;
    
    // Assign the actual password.
    string password = "userPassword";

    // Get the configuration object for a Web application
    // running on a remote server.
    System.Configuration.Configuration config =
        WebConfigurationManager.OpenWebConfiguration(
        "/configTest", "Default Web Site", null, "myServer",
        user, password) 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 user: {0}]", user);
    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