ConfigurationErrorsException Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

The exception that is thrown when a configuration error has occurred.

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

System.Object
  System.Exception
    System.SystemException
      System.Configuration.ConfigurationException
        System.Configuration.ConfigurationErrorsException

<SerializableAttribute>
Public Class ConfigurationErrorsException
	Inherits ConfigurationException

NameDescription
System_CAPS_pubmethodConfigurationErrorsException()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_protmethodConfigurationErrorsException(SerializationInfo, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, Exception)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, Exception, String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of a ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, Exception, XmlNode)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, Exception, XmlReader)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, XmlNode)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

System_CAPS_pubmethodConfigurationErrorsException(String, XmlReader)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ConfigurationErrorsException class.

NameDescription
System_CAPS_pubpropertyBareMessage

Gets a description of why this configuration exception was thrown.(Overrides ConfigurationException.BareMessage.)

System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyErrors

Gets a collection of errors that detail the reasons this ConfigurationErrorsException exception was thrown.

System_CAPS_pubpropertyFilename

Gets the path to the configuration file that caused this configuration exception to be thrown.(Overrides ConfigurationException.Filename.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyLine

Gets the line number within the configuration file at which this configuration exception was thrown.(Overrides ConfigurationException.Line.)

System_CAPS_pubpropertyMessage

Gets an extended description of why this configuration exception was thrown.(Overrides ConfigurationException.Message.)

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodSystem_CAPS_staticGetFilename(XmlNode)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the path to the configuration file from which the internal XmlNode object was loaded when this configuration exception was thrown.

System_CAPS_pubmethodSystem_CAPS_staticGetFilename(XmlReader)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the path to the configuration file that the internal XmlReader was reading when this configuration exception was thrown.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetLineNumber(XmlNode)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the line number within the configuration file that the internal XmlNode object represented when this configuration exception was thrown.

System_CAPS_pubmethodSystem_CAPS_staticGetLineNumber(XmlReader)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the line number within the configuration file that the internal XmlReader object was processing when this configuration exception was thrown.

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the SerializationInfo object with the file name and line number at which this configuration exception occurred.(Overrides ConfigurationException.GetObjectData(SerializationInfo, StreamingContext).)

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Creates and returns a string representation of the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_proteventSerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

The ConfigurationErrorsException exception is thrown when any error occurs while configuration information is being read or written.

The following code example creates a custom section and generates a ConfigurationErrorsException exception when it modifies its properties.

Imports System
Imports System.Configuration
Imports System.Collections.Specialized
Imports System.Collections



' Define a custom section.

NotInheritable Public Class CustomSection
    Inherits ConfigurationSection

    Public Sub New() 

    End Sub 'NewNew


    <ConfigurationProperty("fileName", DefaultValue:="default.txt", IsRequired:=True, IsKey:=False), StringValidator(InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\", MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            Me("fileName") = value
        End Set
    End Property


    <ConfigurationProperty("maxUsers", DefaultValue:=10, IsRequired:=False), LongValidator(MinValue:=1, MaxValue:=100, ExcludeRange:=False)> _
    Public Property MaxUsers() As Long
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As Long)
            Me("maxUsers") = value
        End Set
    End Property
End Class 'CustomSection 


' Create the custom section and write it to
' the configuration file.

Class UsingConfigurationErrorsException

    ' Create a custom section.
    Shared Sub New()

        ' Get the application configuration file.
        Dim config _
        As System.Configuration.Configuration = _
        ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.None)

        ' If the section does not exist in the configuration
        ' file, create it and save it to the file.
        If config.Sections("CustomSection") Is Nothing Then
            Dim custSection As New CustomSection()
            config.Sections.Add("CustomSection", custSection)
            custSection = config.GetSection("CustomSection")
            custSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Full)
        End If

    End Sub 'NewNew


    ' Modify a custom section and cause configuration 
    ' error exceptions.
    Shared Sub ModifyCustomSection() 

        Try
            ' Get the application configuration file.
            Dim config _
            As System.Configuration.Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

            Dim custSection _
            As CustomSection = _
            config.Sections("CustomSection")

            ' Change the section properties.
            custSection.FileName = "newName.txt"

            ' Cause an exception.
            custSection.MaxUsers = _
            custSection.MaxUsers + 100

            If Not custSection.ElementInformation.IsLocked Then
                config.Save()
            Else
                Console.WriteLine( _
                "Section was locked, could not update.")
            End If
        Catch err As ConfigurationErrorsException

            Dim msg As String = err.Message
            Console.WriteLine("Message: {0}", msg)
            Dim fileName As String = err.Filename
            Console.WriteLine("Filename: {0}", _
            fileName)
            Dim lineNumber As Integer = err.Line
            Console.WriteLine("Line: {0}", _
            lineNumber.ToString())
            Dim bmsg As String = err.BareMessage
            Console.WriteLine("BareMessage: {0}", bmsg)
            Dim src As String = err.Source
            Console.WriteLine("Source: {0}", src)
            Dim st As String = err.StackTrace
            Console.WriteLine("StackTrace: {0}", st)
        End Try

    End Sub 'ModifyCustomSection

    Shared Sub Main(ByVal args() As String) 
        ModifyCustomSection()

    End Sub 'Main
End Class 'UsingConfigurationErrorsException 

The following example is a configuration excerpt used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="CustomSection" type="Samples.AspNet.CustomSection, 
      ConfigurationErrorsException, Version=1.0.0.0, Culture=neutral, 
      PublicKeyToken=null" allowDefinition="Everywhere" 
      allowExeDefinition="MachineToApplication" 
      restartOnExternalChanges="true" />
  </configSections>
  <CustomSection fileName="default.txt" maxUsers="10" />
</configuration>

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: