Exception.GetBaseException Method

July 28, 2014

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

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

public virtual Exception GetBaseException()

Return Value

Type: System.Exception
The first exception thrown in a chain of exceptions. If the InnerException property of the current exception is a null reference (Nothing in Visual Basic), 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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft