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.
Assembly: System.Web (in System.Web.dll)
Public Shared Function OpenWebConfiguration ( path As String, site As String, locationSubPath As String, server As String ) As Configuration
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.
| Exception | Condition |
|---|---|
| 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. Shared Sub OpenWebConfiguration4() ' Get the configuration object for a Web application ' running on the specified server. ' Null for the subPath signifies no subdir. Dim config As System.Configuration.Configuration = WebConfigurationManager.OpenWebConfiguration("/configTest", "Default Web Site", Nothing, "myServer") ' Get the appSettings. Dim appSettings As KeyValueConfigurationCollection = config.AppSettings.Settings ' Loop through the collection and ' display the appSettings key, value pairs. Console.WriteLine("[appSettings for Web app on server: myServer]") Dim key As String For Each key In appSettings.AllKeys Console.WriteLine("Name: {0} Value: {1}", key, appSettings(key).Value) Next key Console.WriteLine() End Sub 'OpenWebConfiguration4
Available since 2.0