WebConfigurationManager.OpenMappedWebConfiguration Method (WebConfigurationFileMap, String, String, String)

 

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

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

Public Shared Function OpenMappedWebConfiguration (
	fileMap As WebConfigurationFileMap,
	path As String,
	site As String,
	locationSubPath As String
) As Configuration

Parameters

fileMap
Type: System.Web.Configuration.WebConfigurationFileMap

The WebConfigurationFileMap object to use in place of a default Web-application configuration-file mapping.

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 use the OpenMappedWebConfiguration method.

' Show how to use the OpenMappedWebConfiguration(
' WebConfigurationFileMap, string, string, string).
Shared Sub OpenMappedWebConfiguration3()

   ' Create the configuration directories mapping.
   Dim fileMap As WebConfigurationFileMap = CreateFileMap()

   Try

      ' Get the Configuration object for the mapped
      ' virtual directory.
         Dim config As System.Configuration.Configuration = _
         WebConfigurationManager.OpenMappedWebConfiguration( _
         fileMap, "/config", "config", "config")

      ' Define a nique key for the creation of 
      ' an appSettings element entry.
      Dim appStgCnt As Integer = config.AppSettings.Settings.Count
      Dim asName As String = "AppSetting" + appStgCnt.ToString()

      ' Add a new element to the appSettings.
         config.AppSettings.Settings.Add(asName, _
         DateTime.Now.ToLongDateString() + " " + _
         DateTime.Now.ToLongTimeString())

      ' Save to the configuration file.
      config.Save(ConfigurationSaveMode.Modified)

      ' Display new appSettings.
         Console.WriteLine("Count:  [{0}]", _
         config.AppSettings.Settings.Count)
      Dim key As String
      For Each key In  config.AppSettings.Settings.AllKeys
             Console.WriteLine("[{0}] = [{1}]", _
             key, config.AppSettings.Settings(key).Value)
      Next key

   Catch err As InvalidOperationException
      Console.WriteLine(err.ToString())
   End Try

   Console.WriteLine()
End Sub 'OpenMappedWebConfiguration3


Refer to OpenMachineConfiguration for an example that shows how to map a virtual directory hierarchy to a physical one.

.NET Framework
Available since 2.0
Return to top
Show: