AsyncCompletedEventArgs::Error Property

.NET Framework (current version)

Gets a value indicating which error occurred during an asynchronous operation.

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

Syntax

public:
property Exception^ Error {
	Exception^ get();
}

Property Value

Type: System::Exception^

An Exception instance, if an error occurred during an asynchronous operation; otherwise null.

If an exception is raised during an asynchronous operation, the class will assign the exception to the Error property. The client application's event-handler delegate should check the Error property before accessing any properties in a class derived from AsyncCompletedEventArgs; otherwise, the property will raise a TargetInvocationException with its InnerException property holding a reference to Error.

The value of the Error property is null if the operation was canceled.

Notes to Inheritors:

If you provide read-only properties in a derived class, be sure to call the RaiseExceptionIfNecessary method in your property implementation. This prevents clients from accessing properties that are potentially not valid due to a failure in the asynchronous operation.

Examples

The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. This code example is part of a larger example provided for the System.ComponentModel::AsyncOperationManager class.

C++

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

C++

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

Version Information

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