WebConfigurationManager.OpenMappedWebConfiguration Method

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Opens the Web-application configuration file as a Configuration object using the specified file mapping to allow read or write operations.

Overloads

OpenMappedWebConfiguration(WebConfigurationFileMap, String)	Opens the specified Web-application configuration file as a Configuration object using the specified file mapping and virtual path to allow read or write operations.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)	Opens the specified Web application configuration file as a Configuration object using the specified file mapping, virtual path, and site name to allow read or write operations.
OpenMappedWebConfiguration(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.

Examples

The following example shows how to map a virtual directory hierarchy to a physical one. The example shown here is used in the overloaded members.


        // Utility to map virtual directories to physical ones.
        // In the current physical directory maps
        // a physical sub-directory with its virtual directory.
        // A web.config file is created for the
        // default and the virtual directory at the appropriate level.
        // You must create a physical directory called config at the
        // level where your app is running.
        static WebConfigurationFileMap CreateFileMap()
        {

            WebConfigurationFileMap fileMap =
                   new WebConfigurationFileMap();

            // Get he physical directory where this app runs.
            // We'll use it to map the virtual directories
            // defined next.
            string physDir = Environment.CurrentDirectory;

            // Create a VirtualDirectoryMapping object to use
            // as the root directory for the virtual directory
            // named config.
            // Note: you must assure that you have a physical subdirectory
            // named config in the curremt physical directory where this
            // application runs.
            VirtualDirectoryMapping vDirMap =
                new VirtualDirectoryMapping(physDir + "\\config", true);

            // Add vDirMap to the VirtualDirectories collection
            // assigning to it the virtual directory name.
            fileMap.VirtualDirectories.Add("/config", vDirMap);

            // Create a VirtualDirectoryMapping object to use
            // as the default directory for all the virtual
            // directories.
            VirtualDirectoryMapping vDirMapBase =
                new VirtualDirectoryMapping(physDir, true, "web.config");

            // Add it to the virtual directory mapping collection.
            fileMap.VirtualDirectories.Add("/", vDirMapBase);

# if DEBUG
            // Test at debug time.
            foreach (string key in fileMap.VirtualDirectories.AllKeys)
            {
                Console.WriteLine("Virtual directory: {0} Physical path: {1}",
                fileMap.VirtualDirectories[key].VirtualDirectory,
                fileMap.VirtualDirectories[key].PhysicalDirectory);
            }
# endif

            // Return the mapping.
            return fileMap;
        }

   ' Utility to map virtual directories to physical ones.
   ' In the current physical directory maps 
   ' a physical sub-directory with its virtual directory.
   ' A web.config file is created for the
    ' default and the virtual directory at the appropriate level.
    'You must create a physical directory called config at the
    'level where your app is running.
   Shared Function CreateFileMap() As WebConfigurationFileMap
      
      Dim fileMap As New WebConfigurationFileMap()
      
      ' Get he physical directory where this app runs.
      ' We'll use it to map the virtual directories
      ' defined next. 
      Dim physDir As String = Environment.CurrentDirectory
      
      ' Create a VirtualDirectoryMapping object to use
      ' as the root directory for the virtual directory
      ' named config. 
      ' Note: you must assure that you have a physical subdirectory
      ' named config in the curremt physical directory where this
      ' application runs.
        Dim vDirMap As New VirtualDirectoryMapping(physDir + _
        "\config", True)
      
      ' Add vDirMap to the VirtualDirectories collection 
      ' assigning to it the virtual directory name.
      fileMap.VirtualDirectories.Add("/config", vDirMap)
      
      ' Create a VirtualDirectoryMapping object to use
      ' as the default directory for all the virtual 
      ' directories.
        Dim vDirMapBase As New VirtualDirectoryMapping(physDir, _
        True, "web.config")
      
      ' Add it to the virtual directory mapping collection.
      fileMap.VirtualDirectories.Add("/", vDirMapBase)
      
    
#If DEBUG Then
      Dim key As String
      For Each key In  fileMap.VirtualDirectories.AllKeys
            Console.WriteLine("Virtual directory: {0} Physical path: {1}", _
            fileMap.VirtualDirectories(key).VirtualDirectory, _
            fileMap.VirtualDirectories(key).PhysicalDirectory)
      Next key
#End If

      ' Return the mapping.
      Return fileMap

    End Function 'CreateFileMap

Remarks

You use the mapping mechanism when you need to map your virtual directory hierarchy to a physical directory.

OpenMappedWebConfiguration(WebConfigurationFileMap, String)

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

public:
 static System::Configuration::Configuration ^ OpenMappedWebConfiguration(System::Web::Configuration::WebConfigurationFileMap ^ fileMap, System::String ^ path);

public static System.Configuration.Configuration OpenMappedWebConfiguration (System.Web.Configuration.WebConfigurationFileMap fileMap, string path);

static member OpenMappedWebConfiguration : System.Web.Configuration.WebConfigurationFileMap * string -> System.Configuration.Configuration

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

Parameters

fileMap: WebConfigurationFileMap

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

path: String

The virtual path to the configuration file.

Returns

Configuration

A Configuration object.

Exceptions

ConfigurationErrorsException

A valid configuration file could not be loaded.

Examples

The following example shows how to use the OpenMappedWebConfiguration method.


// Show how to use the OpenMappedWebConfiguration(
// WebConfigurationFileMap, string)
static void OpenMappedWebConfiguration1()
{

    // Create the configuration directories mapping.
    WebConfigurationFileMap fileMap =
        CreateFileMap();

    try
    {

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

        // Define a nique key for the creation of
        // an appSettings element entry.
        int appStgCnt = config.AppSettings.Settings.Count;
        string asName = "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);
        foreach (string key in config.AppSettings.Settings.AllKeys)
        {
            Console.WriteLine("[{0}] = [{1}]", key,
                config.AppSettings.Settings[key].Value);
        }
    }
    catch (InvalidOperationException err)
    {
        Console.WriteLine(err.ToString());
    }

    Console.WriteLine();
}

' Show how to use the OpenMappedWebConfiguration(
' WebConfigurationFileMap, string)
Shared Sub OpenMappedWebConfiguration1()
   
   ' 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")
      
      ' 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

The preceding example uses the following custom method to generate a ConfigurationFileMap object.


        // Utility to map virtual directories to physical ones.
        // In the current physical directory maps
        // a physical sub-directory with its virtual directory.
        // A web.config file is created for the
        // default and the virtual directory at the appropriate level.
        // You must create a physical directory called config at the
        // level where your app is running.
        static WebConfigurationFileMap CreateFileMap()
        {

            WebConfigurationFileMap fileMap =
                   new WebConfigurationFileMap();

            // Get he physical directory where this app runs.
            // We'll use it to map the virtual directories
            // defined next.
            string physDir = Environment.CurrentDirectory;

            // Create a VirtualDirectoryMapping object to use
            // as the root directory for the virtual directory
            // named config.
            // Note: you must assure that you have a physical subdirectory
            // named config in the curremt physical directory where this
            // application runs.
            VirtualDirectoryMapping vDirMap =
                new VirtualDirectoryMapping(physDir + "\\config", true);

            // Add vDirMap to the VirtualDirectories collection
            // assigning to it the virtual directory name.
            fileMap.VirtualDirectories.Add("/config", vDirMap);

            // Create a VirtualDirectoryMapping object to use
            // as the default directory for all the virtual
            // directories.
            VirtualDirectoryMapping vDirMapBase =
                new VirtualDirectoryMapping(physDir, true, "web.config");

            // Add it to the virtual directory mapping collection.
            fileMap.VirtualDirectories.Add("/", vDirMapBase);

# if DEBUG
            // Test at debug time.
            foreach (string key in fileMap.VirtualDirectories.AllKeys)
            {
                Console.WriteLine("Virtual directory: {0} Physical path: {1}",
                fileMap.VirtualDirectories[key].VirtualDirectory,
                fileMap.VirtualDirectories[key].PhysicalDirectory);
            }
# endif

            // Return the mapping.
            return fileMap;
        }

   ' Utility to map virtual directories to physical ones.
   ' In the current physical directory maps 
   ' a physical sub-directory with its virtual directory.
   ' A web.config file is created for the
    ' default and the virtual directory at the appropriate level.
    'You must create a physical directory called config at the
    'level where your app is running.
   Shared Function CreateFileMap() As WebConfigurationFileMap
      
      Dim fileMap As New WebConfigurationFileMap()
      
      ' Get he physical directory where this app runs.
      ' We'll use it to map the virtual directories
      ' defined next. 
      Dim physDir As String = Environment.CurrentDirectory
      
      ' Create a VirtualDirectoryMapping object to use
      ' as the root directory for the virtual directory
      ' named config. 
      ' Note: you must assure that you have a physical subdirectory
      ' named config in the curremt physical directory where this
      ' application runs.
        Dim vDirMap As New VirtualDirectoryMapping(physDir + _
        "\config", True)
      
      ' Add vDirMap to the VirtualDirectories collection 
      ' assigning to it the virtual directory name.
      fileMap.VirtualDirectories.Add("/config", vDirMap)
      
      ' Create a VirtualDirectoryMapping object to use
      ' as the default directory for all the virtual 
      ' directories.
        Dim vDirMapBase As New VirtualDirectoryMapping(physDir, _
        True, "web.config")
      
      ' Add it to the virtual directory mapping collection.
      fileMap.VirtualDirectories.Add("/", vDirMapBase)
      
    
#If DEBUG Then
      Dim key As String
      For Each key In  fileMap.VirtualDirectories.AllKeys
            Console.WriteLine("Virtual directory: {0} Physical path: {1}", _
            fileMap.VirtualDirectories(key).VirtualDirectory, _
            fileMap.VirtualDirectories(key).PhysicalDirectory)
      Next key
#End If

      ' Return the mapping.
      Return fileMap

    End Function 'CreateFileMap

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

Remarks

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.

Applies to

OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)

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

public:
 static System::Configuration::Configuration ^ OpenMappedWebConfiguration(System::Web::Configuration::WebConfigurationFileMap ^ fileMap, System::String ^ path, System::String ^ site);

public static System.Configuration.Configuration OpenMappedWebConfiguration (System.Web.Configuration.WebConfigurationFileMap fileMap, string path, string site);

static member OpenMappedWebConfiguration : System.Web.Configuration.WebConfigurationFileMap * string * string -> System.Configuration.Configuration

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

Parameters

fileMap: WebConfigurationFileMap

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

path: String

The virtual path to the configuration file.

site: String

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

Returns

Configuration

A Configuration object.

Exceptions

ConfigurationErrorsException

A valid configuration file could not be loaded.

Examples

The following example shows how to use the OpenMappedWebConfiguration method.


// Show how to use the OpenMappedWebConfiguration(
// WebConfigurationFileMap, string, string).
static void OpenMappedWebConfiguration2()
{

    // Create the configuration directories mapping.
    WebConfigurationFileMap fileMap =
        CreateFileMap();

    try
    {

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

        // Define a nique key for the creation of
        // an appSettings element entry.
        int appStgCnt = config.AppSettings.Settings.Count;
        string asName = "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);
        foreach (string key in config.AppSettings.Settings.AllKeys)
        {
            Console.WriteLine("[{0}] = [{1}]", key,
                config.AppSettings.Settings[key].Value);
        }
    }
    catch (InvalidOperationException err)
    {
        Console.WriteLine(err.ToString());
    }

    Console.WriteLine();
}

' Show how to use the OpenMappedWebConfiguration(
' WebConfigurationFileMap, string, string).
Shared Sub OpenMappedWebConfiguration2()
   
   ' 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")
      
      ' 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

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

Remarks

Applies to

OpenMappedWebConfiguration(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.

public:
 static System::Configuration::Configuration ^ OpenMappedWebConfiguration(System::Web::Configuration::WebConfigurationFileMap ^ fileMap, System::String ^ path, System::String ^ site, System::String ^ locationSubPath);

public static System.Configuration.Configuration OpenMappedWebConfiguration (System.Web.Configuration.WebConfigurationFileMap fileMap, string path, string site, string locationSubPath);

static member OpenMappedWebConfiguration : System.Web.Configuration.WebConfigurationFileMap * string * string * string -> System.Configuration.Configuration

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

Parameters

fileMap: WebConfigurationFileMap

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

path: String

The virtual path to the configuration file.

site: String

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

locationSubPath: String

The specific resource to which the configuration applies.

Returns

Configuration

A Configuration object.

Exceptions

ConfigurationErrorsException

A valid configuration file could not be loaded.

Examples

The following example shows how to use the OpenMappedWebConfiguration method.


// Show how to use the OpenMappedWebConfiguration(
// WebConfigurationFileMap, string, string, string).
static void OpenMappedWebConfiguration3()
{

    // Create the configuration directories mapping.
    WebConfigurationFileMap fileMap =
        CreateFileMap();

    try
    {

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

        // Define a unique key for the creation of
        // an appSettings element entry.
        int appStgCnt = config.AppSettings.Settings.Count;
        string asName = "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);
        foreach (string key in config.AppSettings.Settings.AllKeys)
        {
            Console.WriteLine("[{0}] = [{1}]", key,
                config.AppSettings.Settings[key].Value);
        }
    }
    catch (InvalidOperationException err)
    {
        Console.WriteLine(err.ToString());
    }

    Console.WriteLine();
}

' 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

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

Remarks

Applies to

Share via

WebConfigurationManager.OpenMappedWebConfiguration Method

Definition

Overloads

Examples

Remarks

OpenMappedWebConfiguration(WebConfigurationFileMap, String)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String)

Parameters

Returns

Exceptions

Examples

Remarks

See also

Applies to

Additional resources