System.Configuration.ConfigurationException Class

Summary

The exception that is thrown when an error occurs in a configuration setting.

C# Syntax:

[Serializable] public class ConfigurationException : SystemException

System.Configuration Namespace

System.Configuration.ConfigurationException Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the ConfigurationException class.
ctor #2	Overloaded: .ctor(string message) Initializes a new instance of the ConfigurationException class with the specified error message.
ctor #4	Overloaded: .ctor(string message, Exception inner) Initializes a new instance of the ConfigurationException class with the specified error message and Exception.InnerException property.
ctor #5	Overloaded: .ctor(string message, XmlNode node) Initializes a new instance of the ConfigurationException with the specified error message and the name of the configuration section containing the error.
ctor #6	Overloaded: .ctor(string message, Exception inner, XmlNode node) Initializes a new instance of the ConfigurationException class with the specified error message and Exception.InnerException and the name of the configuration section node that contains the error.
ctor #7	Overloaded: .ctor(string message, string filename, int line) Initializes a new instance of the ConfigurationException class with the specified error message, the name of the configuration file that contains the error, and the line number in the file.
ctor #8	Overloaded: .ctor(string message, Exception inner, string filename, int line) Initializes a new instance of the ConfigurationException with the specified error message and Exception.InnerException, the name of the file containing the error, and the line number of the error in the file.

Public Properties

BareMessage	Read-only Gets the base error message without file name and line number information.
Filename	Read-only Gets the name of the configuration file where the error occurred.
HelpLink (inherited from System.Exception)	Read-write See base class member description: System.Exception.HelpLink Gets or sets a link to the help file associated with this exception.
InnerException (inherited from System.Exception)	Read-only See base class member description: System.Exception.InnerException Gets the Exception instance that caused the current exception.
Line	Read-only Gets the number of the line where the error occurred.
Message	Read-only Overridden: Gets a string containing the concatenated file name and line number of the error.
Source (inherited from System.Exception)	Read-write See base class member description: System.Exception.Source Gets or sets the name of the application or the object that causes the error.
StackTrace (inherited from System.Exception)	Read-only See base class member description: System.Exception.StackTrace Gets a string representation of the frames on the call stack at the time the current exception was thrown.
TargetSite (inherited from System.Exception)	Read-only See base class member description: System.Exception.TargetSite Gets the method that throws the current exception.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetBaseException (inherited from System.Exception)	See base class member description: System.Exception.GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetObjectData	Overridden: Populates the SerializationInfo object with the data needed to serialize the ConfigurationException object.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
GetXmlNodeFilename	Returns the name of the file that contains the configuration section node that contains the error.
GetXmlNodeLineNumber	Returns the line number of the configuration section node that contains the error.
ToString (inherited from System.Exception)	See base class member description: System.Exception.ToString Creates and returns a string representation of the current exception.

Protected Constructors

ctor #3

Overloaded: .ctor(SerializationInfo info, StreamingContext context)

Protected Properties

HResult (inherited from System.Exception)

Read-write See base class member description: System.Exception.HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Exception
• System.SystemException
• System.Configuration.ConfigurationException

System.Configuration.ConfigurationException Member Details

Summary

Initializes a new instance of the ConfigurationException class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public ConfigurationException();

Return to top

Summary

Initializes a new instance of the ConfigurationException class with the specified error message.

C# Syntax:

public ConfigurationException(    string message );

message

The message to display to the client when the exception is thrown.

Return to top

Summary

Initializes a new instance of the ConfigurationException class with the specified SerializationInfo and StreamingContext.

C# Syntax:

protected ConfigurationException(    SerializationInfo info,    StreamingContext context );

info

A SerializationInfo containing the information required to serialize the new ConfigurationException.

context

A StreamingContext containing the source and destination of the serialized stream associated with the new ConfigurationException.

Return to top

Summary

Initializes a new instance of the ConfigurationException class with the specified error message and Exception.InnerException property.

C# Syntax:

public ConfigurationException(    string message,    Exception inner );

message

The message to display to the client when the exception is thrown.

inner

The Exception.InnerException, if any, that threw the current exception.

Return to top

Summary

Initializes a new instance of the ConfigurationException with the specified error message and the name of the configuration section containing the error.

C# Syntax:

public ConfigurationException(    string message,    XmlNode node );

message

The message to display to the client when the exception is thrown.

node

The XmlNode that contains the error.

A constructor that accepts an XmlNode argument should always be used when reporting errors thrown by configuration section handlers.

Return to top

Summary

Initializes a new instance of the ConfigurationException class with the specified error message and Exception.InnerException and the name of the configuration section node that contains the error.

C# Syntax:

public ConfigurationException(    string message,    Exception inner,    XmlNode node );

message

The message to display to the client when the exception is thrown.

inner

The Exception.InnerException, if any, that threw the current exception.

node

The XmlNode that contains the error.

A constructor that accepts an XmlNode argument should always be used when reporting errors from configuration section handlers.

Return to top

Summary

Initializes a new instance of the ConfigurationException class with the specified error message, the name of the configuration file that contains the error, and the line number in the file.

C# Syntax:

public ConfigurationException(    string message,    string filename,    int line );

message

The message to display to the client when the exception is thrown.

filename

The name of the configuration file that contains the error.

line

The number of the line that contains the error.

Return to top

Summary

Initializes a new instance of the ConfigurationException with the specified error message and Exception.InnerException, the name of the file containing the error, and the line number of the error in the file.

C# Syntax:

public ConfigurationException(    string message,    Exception inner,    string filename,    int line );

message

The message to display to the client when the exception is thrown.

inner

The Exception.InnerException, if any, that threw the current exception.

filename

The name of the configuration file that contains the error.

line

The number of the line that contains the error.

Return to top

Summary

Gets the base error message without file name and line number information.

C# Syntax:

public string BareMessage {get;}

To get the error message with file name and line number information, use the ConfigurationException.Message property.

Return to top

Summary

Gets the name of the configuration file where the error occurred.

C# Syntax:

public string Filename {get;}

Return to top

Inherited
See base class member description: System.Exception.HelpLink

Summary

Gets or sets a link to the help file associated with this exception.

C# Syntax:

public virtual string HelpLink {get; set;}

The return value, which represents a help file, is a URN or URL. For example, the HelpLink value could be:

"file:///C:/Applications/Bazzal/help.html#ErrorNum42"

Return to top

Inherited
See base class member description: System.Exception.HResult

Summary

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

C# Syntax:

protected int HResult {get; set;}

HRESULT is a 32-bit value, divided into three different fields: a severity code, a facility code, and an error code. The severity code indicates whether the return value represents information, warning, or error. The facility code identifies the area of the system responsible for the error. The error code is a unique number that is assigned to represent the exception. Each exception is mapped to a distinct HRESULT. When managed code throws an exception, the runtime passes the HRESULT to the COM client. When unmanaged code returns an error, the HRESULT is converted to an exception, which is then thrown by the runtime.

Return to top

Inherited
See base class member description: System.Exception.InnerException

Summary

Gets the Exception instance that caused the current exception.

C# Syntax:

public Exception InnerException {get;}

When an exception X is thrown as a direct result of a previous exception Y, the InnerException property of X should contain a reference to Y.

Use the InnerException property to obtain the set of exceptions that led to the current exception.

You can create a new exception that catches an earlier exception. The code that handles the second exception can make use of the additional information from the earlier exception to handle the error more appropriately.

Suppose that there is a function that reads a file and formats the data from that file. In this example, as the code tries to read the file, an IOException is thrown. The function catches the IOException and throws a FileNotFoundException. The IOException could be saved in the Exception.InnerException property of the FileNotFoundException, enabling the code that catches the FileNotFoundException to examine what causes the initial error.

The Exception.InnerException property, which holds a reference to the inner exception, is set upon initialization of the exception object.

The following example demonstrates throwing and catching an exception that references an inner exception.

using System;
public class MyAppException:ApplicationException 
{
   public MyAppException (String message) : base (message) 
   {}
   public MyAppException (String message, Exception inner) : base(message,inner) {}	
   }
public class ExceptExample 
{
   public void ThrowInner () 
   {
   throw new MyAppException("ExceptExample inner exception");
   }
   public void CatchInner() 
   {
      try 
      {
      this.ThrowInner();
      }
         catch (Exception e) 
         {
         throw new MyAppException("Error caused by trying ThrowInner.",e);
         }
      }
   }
public class Test 
{
   public static void Main() 
   {
   ExceptExample testInstance = new ExceptExample();
      try 
      {
      testInstance.CatchInner();
      }
         catch(Exception e) 
         {
         Console.WriteLine ("In Main catch block. Caught: {0}", e.Message);
         Console.WriteLine ("Inner Exception is {0}",e.InnerException);
         }
      }
}

    

This code has the following output:

In Main catch block. Caught: Error caused by trying ThrowInner. Inner Exception is MyAppException: ExceptExample inner exception at ExceptExample.ThrowInner() at ExceptExample.CatchInner()

Return to top

Summary

Gets the number of the line where the error occurred.

C# Syntax:

public int Line {get;}

Return to top

Summary

Gets a string containing the concatenated file name and line number of the error.

C# Syntax:

public override string Message {get;}

To get the base error message without file name and line number information, use the ConfigurationException.BareMessage property.

Return to top

Inherited
See base class member description: System.Exception.Source

Summary

Gets or sets the name of the application or the object that causes the error.

C# Syntax:

public virtual string Source {get; set;}

If Exception.Source is not set, the name of the assembly where the exception originated is returned.

Return to top

Inherited
See base class member description: System.Exception.StackTrace

Summary

Gets a string representation of the frames on the call stack at the time the current exception was thrown.

C# Syntax:

public virtual string StackTrace {get;}

The execution stack keeps track of all the methods that are in execution at a given instant. A trace of the method calls is called a stack trace. The stack trace listing provides a means to follow the call sequence to the line number in the method where the exception occurs.

StackTrace may not report as many method calls as expected, due to code transformations, such as inlining, that occur during optimization.

Notes to inheritors: The StackTrace property is overridden in classes that require control over the stack trace content or format.

By default, the stack trace is captured immediately before an exception object is thrown. Use Environment.StackTrace to get stack trace information when no exception is being thrown.

Return to top

Inherited
See base class member description: System.Exception.TargetSite

Summary

Gets the method that throws the current exception.

C# Syntax:

public MethodBase TargetSite {get;}

If the method that throws this exception is not available and the stack trace is not a null reference (not set or empty), Exception.TargetSite obtains the method from the stack trace. If the stack trace is a null reference , Exception.TargetSite also returns a null reference.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~ConfigurationException();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Exception.GetBaseException

Summary

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

C# Syntax:

public virtual Exception GetBaseException();

Return Value:

The first exception thrown in a chain of exceptions. If the Exception.InnerException property of the current exception is a null reference (not set or empty), this property returns the current exception.

A chain of exceptions consists of a set of exceptions such that each exception in the chain was thrown as a direct result of the exception referenced in its InnerException property. For a given chain, there can be exactly one exception that is the root cause of all other exceptions in the chain. This exception is called the base exception and its InnerException property always contains a null reference.

For all exceptions in a chain of exceptions, the GetBaseException method must return the same object (the base exception).

Use the GetBaseException method when you want to find the root cause of an exception but do not need information about exceptions that may have occurred between the current exception and the first exception.

Notes to inheritors: The GetBaseException method is overridden in classes that require control over the exception content or format.

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Populates the SerializationInfo object with the data needed to serialize the ConfigurationException object.

C# Syntax:

public override void GetObjectData(    SerializationInfo info,    StreamingContext context );

info

A SerializationInfo containing the information required to serialize the new configuration exception .

context

A StreamingContext containing the source and destination of the serialized stream associated with the new configuration exception.

Implements:

ISerializable.GetObjectData

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the name of the file that contains the configuration section node that contains the error.

C# Syntax:

public static string GetXmlNodeFilename(    XmlNode node );

node

The name of the configuration section node that contains the error.

Return Value:

The name of the configuration file.

Return to top

Summary

Returns the line number of the configuration section node that contains the error.

C# Syntax:

public static int GetXmlNodeLineNumber(    XmlNode node );

node

The name of the configuration section node that contains the error.

Return Value:

The line number that contains the error.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Exception.ToString

Summary

Creates and returns a string representation of the current exception.

C# Syntax:

public override string ToString();

Return Value:

A string representation of the current exception.

ToString returns a representation of the current exception that is intended to be understood by humans. Where the exception contains culture-sensitive data, the string representation returned by ToString is required to take into account the current system culture. Although there are no exact requirements for the format of the returned string, it should attempt to reflect the value of the object as perceived by the user.

The default implementation of Exception.ToString obtains the name of the class that threw the current exception, the message, the result of calling ToString on the inner exception, and the result of calling Environment.StackTrace. If any of these members is a null reference (not set or empty), its value is not included in the returned string.

If there is no error message or if it is an empty string (""), then no error message is returned. The name of the inner exception and the stack trace are returned only if they are not a null reference.

This method overrides Object.ToString.

Notes to inheritors: It is recommended, but not required, that ToString be overridden to return information about members declared in the derived class. For example, the ArgumentException class implements ToString so that it returns the value of the ParamName property, if that value is not a null reference.

The following example causes an exception and displays the result of calling ToString on that exception.

using System;

public class MyClass {}
public class ArgExceptionExample 
   {
   public static void Main()
      {
      MyClass my = new MyClass();
      string s = "sometext";
      try 
         {
         int i = s.CompareTo(my);
         }
            catch (Exception e) 
            {
            Console.WriteLine("Error: {0}",e.ToString());
            }
      }
}

    

This code has the following output:

Error: System.ArgumentException: Object must be of type String. at System.String.CompareTo(Object value) at ArgExceptionExample.Main()

Return to top

Top of page