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.
Assembly: System.Web (in System.Web.dll)
Public Shared Function OpenWebConfiguration ( path As String, site As String, locationSubPath 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.
| 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, string, string). ' It gets he appSettings section of a Web application ' runnig on the local server. Shared Sub OpenWebConfiguration3() ' Get the configuration object for a Web application ' running on the local server. Dim config As System.Configuration.Configuration = _ WebConfigurationManager.OpenWebConfiguration( _ "/configTest", "Default Web Site", Nothing) ' 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 app at: /configTest") Console.WriteLine(" site: Default Web Site") Console.WriteLine(" and locationSubPath: null]") 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 'OpenWebConfiguration3
Available since 2.0