AsyncCompletedEventArgs::RaiseExceptionIfNecessary Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Raises a user-supplied exception if an asynchronous operation failed.

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

void RaiseExceptionIfNecessary()

Exception Condition

The Cancelled property is true.


The Error property has been set by the asynchronous operation. The InnerException property holds a reference to Error.

Notes to Inheritors:

If you have derived your own class from the AsyncCompletedEventArgs class, your read-only properties should call the RaiseExceptionIfNecessary method before returning the property value. If the component's asynchronous worker code assigns an exception to the Error property or sets the Cancelled property to true, the property will raise an exception if a client tries to read its value. This prevents clients from accessing properties that are potentially not valid due to a failure in the asynchronous operation.

The following code example demonstrates using RaiseExceptionIfNecessary in derived class properties.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top