0 out of 1 rated this helpful - Rate this topic

AggregateException Class

Represents one or more errors that occur during application execution.

System.Object
  System.Exception
    System.AggregateException

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
public class AggregateException : Exception

The AggregateException type exposes the following members.

  Name Description
Public method AggregateException() Initializes a new instance of the AggregateException class with a system-supplied message that describes the error.
Public method AggregateException(IEnumerable<Exception>) Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception.
Public method AggregateException(Exception[]) Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception.
Public method AggregateException(String) Initializes a new instance of the AggregateException class with a specified message that describes the error.
Protected method AggregateException(SerializationInfo, StreamingContext) Initializes a new instance of the AggregateException class with serialized data.
Public method AggregateException(String, IEnumerable<Exception>) Initializes a new instance of the AggregateException class with a specified error message and references to the inner exceptions that are the cause of this exception.
Public method AggregateException(String, Exception) Initializes a new instance of the AggregateException class with a specified error message and a reference to the inner exception that is the cause of this exception.
Public method AggregateException(String, Exception[]) Initializes a new instance of the AggregateException class with a specified error message and references to the inner exceptions that are the cause of this exception.
Top
  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property InnerExceptions Gets a read-only collection of the Exception instances that caused the current exception.
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Flatten Flattens an AggregateException instances into a single, new instance.
Public method GetBaseException Returns the AggregateException that is the root cause of this exception. (Overrides Exception.GetBaseException().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Initializes a new instance of the AggregateException class with serialized data. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Public method Handle Invokes a handler on each Exception contained by this AggregateException.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates and returns a string representation of the current AggregateException. (Overrides Exception.ToString().)
Top
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

AggregateException is used to consolidate multiple failures into a single, throwable exception object. It is used extensively in the Task Parallel Library and Parallel LINQ (PLINQ). For an example, see How to: Handle Exceptions Thrown by Tasks and How to: Handle Exceptions in a PLINQ Query.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

All public and protected members of AggregateException are thread-safe and may be used concurrently from multiple threads.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ