AggregateException Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents one or more errors that occur during application execution.

Inheritance Hierarchy

System.Object
  System.Exception
    System.AggregateException

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

Syntax

'Declaration
<DebuggerDisplayAttribute("Count = {InnerExceptions.Count}")> _
Public Class AggregateException _
    Inherits Exception
[DebuggerDisplayAttribute("Count = {InnerExceptions.Count}")]
public class AggregateException : Exception

The AggregateException type exposes the following members.

Constructors

  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(array<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.
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, array<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

Properties

  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the 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 StackTrace Gets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)

Top

Methods

  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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method Flatten Flattens AggregateException instances into a single, new instance.
Public method GetBaseException Returns the AggregateException object 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 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 object.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string representation of the current AggregateException. (Overrides Exception.ToString().)

Top

Remarks

AggregateException is used to consolidate multiple failures into a single, throwable exception object. It is used extensively in parallel programming.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference