Export (0) Print
Expand All

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)

'Declaration
<SerializableAttribute> _
Public Class AggregateException _
	Inherits Exception

The AggregateException type exposes the following members.

  NameDescription
Public methodAggregateExceptionInitializes a new instance of the AggregateException class with a system-supplied message that describes the error.
Public methodAggregateException(IEnumerable(Of Exception))Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception.
Public methodAggregateException(Exception())Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception.
Public methodAggregateException(String)Initializes a new instance of the AggregateException class with a specified message that describes the error.
Protected methodAggregateException(SerializationInfo, StreamingContext)Initializes a new instance of the AggregateException class with serialized data.
Public methodAggregateException(String, IEnumerable(Of 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 methodAggregateException(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 methodAggregateException(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

  NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyInnerExceptionsGets a read-only collection of the Exception instances that caused the current exception.
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlattenFlattens an AggregateException instances into a single, new instance.
Public methodGetBaseExceptionReturns the AggregateException that is the root cause of this exception. (Overrides Exception.GetBaseException.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetObjectDataInitializes a new instance of the AggregateException class with serialized data. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Public methodHandleInvokes a handler on each Exception contained by this AggregateException.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current AggregateException. (Overrides Exception.ToString.)
Top

  NameDescription
Protected eventSerializeObjectStateOccurs 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 additional information, see the Aggregating Exceptions entry in the .NET Matters blog. 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.

Community Additions

ADD
Show:
© 2014 Microsoft