ConfigurationErrorsException Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

ConfigurationErrorsException.cs

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

C#

public class ConfigurationErrorsException : System.Configuration.ConfigurationException

Inheritance

Object

Exception

SystemException

ConfigurationException

ConfigurationErrorsException

Examples

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

C#

using System;
using System.Configuration;
using System.Collections.Specialized;
using System.Collections;

namespace Samples.AspNet
{

    // Define a custom section.
    public sealed class CustomSection :
       ConfigurationSection
    {
        public CustomSection()
        {
        }

        [ConfigurationProperty("fileName", DefaultValue = "default.txt",
                    IsRequired = true, IsKey = false)]
        [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
            MinLength = 1, MaxLength = 60)]
        public string FileName
        {
            get
            {
                return (string)this["fileName"];
            }
            set
            {
                this["fileName"] = value;
            }
        }

        [ConfigurationProperty("maxUsers", DefaultValue = (long)10,
            IsRequired = false)]
        [LongValidator(MinValue = 1, MaxValue = 100,
            ExcludeRange = false)]
        public long MaxUsers
        {
            get
            {
                return (long)this["maxUsers"];
            }
            set
            {
                this["maxUsers"] = value;
            }
        }
    }

    // Create the custom section and write it to
    // the configuration file.
    class UsingConfigurationErrorsException
    {
        // Create a custom section.
        static UsingConfigurationErrorsException()
        {
            // Get the application configuration file.
            System.Configuration.Configuration config =
                    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"] == null)
            {
                CustomSection custSection = new CustomSection();
                config.Sections.Add("CustomSection", custSection);
                custSection =
                    config.GetSection("CustomSection") as CustomSection;
                custSection.SectionInformation.ForceSave = true;
                config.Save(ConfigurationSaveMode.Full);
            }
        }
        
        // Modify a custom section and cause configuration 
        // error exceptions.
        static void ModifyCustomSection()
        {

            try
            {
                // Get the application configuration file.
                System.Configuration.Configuration config =
                        ConfigurationManager.OpenExeConfiguration(
                        ConfigurationUserLevel.None);

                CustomSection custSection =
                   config.Sections["CustomSection"] as CustomSection;

                // Change the section properties.
                custSection.FileName = "newName.txt";
                
                // Cause an exception.
                custSection.MaxUsers = custSection.MaxUsers + 100;

                if (!custSection.ElementInformation.IsLocked)
                    config.Save();
                else
                    Console.WriteLine(
                        "Section was locked, could not update.");
            }
            catch (ConfigurationErrorsException err)
            {

                string msg = err.Message;
                Console.WriteLine("Message: {0}", msg);

                string fileName = err.Filename;
                Console.WriteLine("Filename: {0}", fileName);

                int lineNumber = err.Line;
                Console.WriteLine("Line: {0}", lineNumber.ToString());

                string bmsg = err.BareMessage;
                Console.WriteLine("BareMessage: {0}", bmsg);

                string source = err.Source;
                Console.WriteLine("Source: {0}", source);

                string st = err.StackTrace;
                Console.WriteLine("StackTrace: {0}", st);
            }
        }

        static void Main(string[] args)
        {
            ModifyCustomSection();
        }
    }
}

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

XML

<?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>  

Remarks

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

Constructors

ConfigurationErrorsException()	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(SerializationInfo, StreamingContext)	Obsolete. Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, Exception, String, Int32)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, Exception, XmlNode)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, Exception, XmlReader)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, Exception)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, String, Int32)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, XmlNode)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String, XmlReader)	Initializes a new instance of the ConfigurationErrorsException class.
ConfigurationErrorsException(String)	Initializes a new instance of the ConfigurationErrorsException class.

Properties

BareMessage	Gets a description of why this configuration exception was thrown.
Errors	Gets a collection of errors that detail the reasons this ConfigurationErrorsException exception was thrown.
Filename	Gets the path to the configuration file that caused this configuration exception to be thrown.
Line	Gets the line number within the configuration file at which this configuration exception was thrown.
Message	Gets an extended description of why this configuration exception was thrown.

Methods

GetFilename(XmlNode)	Gets the path to the configuration file from which the internal XmlNode object was loaded when this configuration exception was thrown.
GetFilename(XmlReader)	Gets the path to the configuration file that the internal XmlReader was reading when this configuration exception was thrown.
GetLineNumber(XmlNode)	Gets the line number within the configuration file that the internal XmlNode object represented when this configuration exception was thrown.
GetLineNumber(XmlReader)	Gets the line number within the configuration file that the internal XmlReader object was processing when this configuration exception was thrown.
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. Sets the SerializationInfo object with the file name and line number at which this configuration exception occurred.

Applies to