Export (0) Print
Expand All

ConfigurationManager.OpenExeConfiguration Method (ConfigurationUserLevel)

Opens the configuration file for the current application as a Configuration object.

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

'Declaration
Public Shared Function OpenExeConfiguration ( _
	userLevel As ConfigurationUserLevel _
) As Configuration

Parameters

userLevel
Type: System.Configuration.ConfigurationUserLevel

The ConfigurationUserLevel for which you are opening the configuration.

ExceptionCondition
ConfigurationErrorsException

A configuration file could not be loaded.

Client applications use a global configuration that applies to all users, separate configurations that apply to individual users, and configurations that apply to roaming users. The userLevel parameter determines the location of the configuration file being opened by indicating whether it has no user level (the configuration file is in the same directory as the application) or has a per-user level (the configuration file is in an application settings path determined by the user level).

Specify which configuration to get by passing one of the following values for userLevel:

  • To get the Configuration object that applies to all users, set userLevel to None.

  • To get the local Configuration object that applies to the current user, set userLevel to PerUserRoamingAndLocal.

  • To get the roaming Configuration object that applies to the current user, set userLevel to PerUserRoaming.

    NoteNote

    To get the Configuration object for a resource, your code must have read permissions on all the configuration files from which it inherits settings. To update a configuration file, your code must additionally have write permissions for both the configuration file and the directory in which it exists.

The following code example shows how to use the OpenExeConfiguration method.

' Get the roaming configuration file associated  
' with the application. 
' This function uses the OpenExeConfiguration( 
' ConfigurationUserLevel userLevel) method to  
' get the configuration file. 
' It also creates a custom ConsoleSection and  
' sets its ConsoleEment BackgroundColor and 
' ForegroundColor properties to blue and yellow 
' respectively. Then it uses these properties to 
' set the console colors.   
Public Shared Sub GetRoamingConfiguration()
    ' Define the custom section to add to the 
    ' configuration file. 
    Dim sectionName As String = "consoleSection" 
    Dim currentSection As ConsoleSection = Nothing 

    ' Get the roaming configuration  
    ' that applies to the current user. 
    Dim roamingConfig As Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.PerUserRoaming)

    ' Map the roaming configuration file. This 
    ' enables the application to access  
    ' the configuration file using the 
    ' System.Configuration.Configuration class 
    Dim configFileMap As New ExeConfigurationFileMap()
    configFileMap.ExeConfigFilename = _
        roamingConfig.FilePath

    ' Get the mapped configuration file. 
    Dim config As Configuration = _
        ConfigurationManager.OpenMappedExeConfiguration( _
            configFileMap, ConfigurationUserLevel.None)

    Try
        currentSection = DirectCast( _
            config.GetSection(sectionName),  _
            ConsoleSection)

        ' Synchronize the application configuration 
        ' if needed. The following two steps seem 
        ' to solve some out of synch issues  
        ' between roaming and default 
        ' configuration.
        config.Save(ConfigurationSaveMode.Modified)

        ' Force a reload of the changed section,  
        ' if needed. This makes the new values available  
        ' for reading.
        ConfigurationManager.RefreshSection(sectionName)

        If currentSection Is Nothing Then 
            ' Create a custom configuration section.
            currentSection = New ConsoleSection()

            ' Define where in the configuration file  
            ' hierarchy the associated  
            ' configuration section can be declared. 
            ' The following assignment assures that  
            ' the configuration information can be  
            ' defined in the user.config file in the  
            ' roaming user directory. 
            currentSection.SectionInformation. _
            AllowExeDefinition = _
                ConfigurationAllowExeDefinition. _
                MachineToLocalUser

            ' Allow the configuration section to be  
            ' overridden by lower-level configuration  
            ' files. 
            ' This means that lower-level files can  
            ' contain()the section (use the same name)  
            ' and assign different values to it as  
            ' done by the function  
            ' GetApplicationConfiguration() in this 
            ' example.
            currentSection.SectionInformation. _
                AllowOverride = True 

            ' Store console settings for roaming users.
            currentSection.ConsoleElement. _
            BackgroundColor = ConsoleColor.Blue
            currentSection.ConsoleElement. _
            ForegroundColor = ConsoleColor.Yellow

            ' Add configuration information to  
            ' the configuration file.
            config.Sections.Add(sectionName, _
                currentSection)
            config.Save(ConfigurationSaveMode.Modified)
            ' Force a reload of the changed section. This  
            ' makes the new values available for reading.
            ConfigurationManager.RefreshSection( _
                sectionName)
        End If 
    Catch e As ConfigurationErrorsException
        Console.WriteLine("[Exception error: {0}]", _
                          e.ToString())
    End Try 

    ' Set console properties using values 
    ' stored in the configuration file.
    Console.BackgroundColor = _
        currentSection.ConsoleElement.BackgroundColor
    Console.ForegroundColor = _
        currentSection.ConsoleElement.ForegroundColor
    ' Apply the changes.
    Console.Clear()

    ' Display feedback.
    Console.WriteLine()
    Console.WriteLine( _
        "Using OpenExeConfiguration(userLevel).")
    Console.WriteLine( _
        "Configuration file is: {0}", config.FilePath)
End Sub

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft