AggregateException Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
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
Public Class AggregateException _
Inherits Exception
public class AggregateException : Exception
The AggregateException type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
AggregateException()()() | Initializes a new instance of the AggregateException class with a system-supplied message that describes the error. |
|
AggregateException(IEnumerable<(Of <(Exception>)>)) | Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception. |
|
AggregateException(array<Exception>[]()[]) | Initializes a new instance of the AggregateException class with references to the inner exceptions that are the cause of this exception. |
|
AggregateException(String) | Initializes a new instance of the AggregateException class with a specified message that describes the error. |
|
AggregateException(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. |
|
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. |
|
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 | |
|---|---|---|
.gif "Public property") |
Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
|
HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
|
HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
|
InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
|
InnerExceptions | Gets a read-only collection of the Exception instances that caused the current exception. |
|
Message | Gets a message that describes the current exception. (Inherited from Exception.) |
|
Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
|
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 | |
|---|---|---|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "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.) |
|
Flatten | Flattens AggregateException instances into a single, new instance. |
|
GetBaseException | Returns the AggregateException object that is the root cause of this exception. (Overrides Exception..::.GetBaseException()()().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
|
Handle | Invokes a handler on each Exception contained by this AggregateException object. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
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
Windows Phone OS
Supported in: 8.1, 8.0
Thread Safety
All public and protected members of AggregateException are thread-safe and may be used concurrently from multiple threads.