Provides data for the MethodNameCompleted event.
Assembly: System (in System.dll)
<[%$TOPIC/2tde67e9_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/2tde67e9_en-us_VS_110_2_0_0_0_1%].LinkDemand, SharedState := True)> _
Public Class AsyncCompletedEventArgs _
Inherits [%$TOPIC/2tde67e9_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/2tde67e9_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/2tde67e9_en-us_VS_110_2_0_1_0_1%].LinkDemand, SharedState = true)]
public class AsyncCompletedEventArgs : [%$TOPIC/2tde67e9_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/2tde67e9_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/2tde67e9_en-us_VS_110_2_0_2_0_1%]::LinkDemand, SharedState = true)]
public ref class AsyncCompletedEventArgs : public [%$TOPIC/2tde67e9_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/2tde67e9_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/2tde67e9_en-us_VS_110_2_0_3_0_1%].LinkDemand, SharedState = true)>]
type AsyncCompletedEventArgs =
class
inherit [%$TOPIC/2tde67e9_en-us_VS_110_2_0_3_0_2%]
end
The AsyncCompletedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AsyncCompletedEventArgs | Obsolete. Initializes a new instance of the AsyncCompletedEventArgs class. |
![]() | AsyncCompletedEventArgs(Exception, Boolean, Object) | Initializes a new instance of the AsyncCompletedEventArgs class. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RaiseExceptionIfNecessary | Raises a user-supplied exception if an asynchronous operation failed. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. If you add an instance of the System.ComponentModelAsyncCompletedEventHandler delegate to the event, you will receive information about the outcome of asynchronous operations in the AsyncCompletedEventArgs parameter of the corresponding event-handler method.
The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.
The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.
If the class supports multiple asynchronous methods, or multiple calls to the same asynchronous method, you can determine which task raised the MethodNameCompleted event by checking the value of the UserState property. Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.
Note |
|---|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.
You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. In this case, you can derive your own class from the AsyncCompletedEventArgs class and provide additional private instance variables and corresponding read-only public properties. Call the RaiseExceptionIfNecessary method before returning the property value, in case the operation was canceled or an error occurred.
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.ComponentModelAsyncOperationManager class.
Imports System
Imports System.Collections
Imports System.Collections.Specialized
Imports System.ComponentModel
Imports System.Drawing
Imports System.Globalization
Imports System.Threading
Imports System.Windows.Forms
...
' This event handler updates the ListView control when the
' PrimeNumberCalculator raises the CalculatePrimeCompleted
' event. The ListView item is updated with the appropriate
' outcome of the calculation: Canceled, Error, or result.
Private Sub primeNumberCalculator1_CalculatePrimeCompleted( _
ByVal sender As Object, _
ByVal e As CalculatePrimeCompletedEventArgs) _
Handles primeNumberCalculator1.CalculatePrimeCompleted
Dim taskId As Guid = CType(e.UserState, Guid)
If e.Cancelled Then
Dim result As String = "Canceled"
Dim lvi As ListViewItem = UpdateListViewItem( _
taskId, _
result)
If (lvi IsNot Nothing) Then
lvi.BackColor = Color.Pink
lvi.Tag = Nothing
End If
ElseIf e.Error IsNot Nothing Then
Dim result As String = "Error"
Dim lvi As ListViewItem = UpdateListViewItem( _
taskId, result)
If (lvi IsNot Nothing) Then
lvi.BackColor = Color.Red
lvi.ForeColor = Color.White
lvi.Tag = Nothing
End If
Else
Dim result As Boolean = e.IsPrime
Dim lvi As ListViewItem = UpdateListViewItem( _
taskId, _
result, _
e.FirstDivisor)
If (lvi IsNot Nothing) Then
lvi.BackColor = Color.LightGray
lvi.Tag = Nothing
End If
End If
End Sub
using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Threading;
using System.Windows.Forms;
...
// This event handler updates the ListView control when the
// PrimeNumberCalculator raises the CalculatePrimeCompleted
// event. The ListView item is updated with the appropriate
// outcome of the calculation: Canceled, Error, or result.
private void primeNumberCalculator1_CalculatePrimeCompleted(
object sender,
CalculatePrimeCompletedEventArgs e)
{
Guid taskId = (Guid)e.UserState;
if (e.Cancelled)
{
string result = "Canceled";
ListViewItem lvi = UpdateListViewItem(taskId, result);
if (lvi != null)
{
lvi.BackColor = Color.Pink;
lvi.Tag = null;
}
}
else if (e.Error != null)
{
string result = "Error";
ListViewItem lvi = UpdateListViewItem(taskId, result);
if (lvi != null)
{
lvi.BackColor = Color.Red;
lvi.ForeColor = Color.White;
lvi.Tag = null;
}
}
else
{
bool result = e.IsPrime;
ListViewItem lvi = UpdateListViewItem(
taskId,
result,
e.FirstDivisor);
if (lvi != null)
{
lvi.BackColor = Color.LightGray;
lvi.Tag = null;
}
}
}
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
SystemEventArgs
System.ComponentModelAsyncCompletedEventArgs
System.ActivitiesInvokeCompletedEventArgs
System.ComponentModelRunWorkerCompletedEventArgs
System.Deployment.ApplicationCheckForUpdateCompletedEventArgs
System.Deployment.ApplicationDownloadApplicationCompletedEventArgs
System.Deployment.ApplicationDownloadFileGroupCompletedEventArgs
System.Deployment.ApplicationGetManifestCompletedEventArgs
System.Device.LocationResolveAddressCompletedEventArgs
System.NetDownloadDataCompletedEventArgs
System.NetDownloadStringCompletedEventArgs
System.Net.NetworkInformationPingCompletedEventArgs
System.NetOpenReadCompletedEventArgs
System.NetOpenWriteCompletedEventArgs
System.Net.PeerToPeer.CollaborationCreateContactCompletedEventArgs
System.Net.PeerToPeer.CollaborationInviteCompletedEventArgs
System.Net.PeerToPeer.CollaborationRefreshDataCompletedEventArgs
System.Net.PeerToPeer.CollaborationSubscribeCompletedEventArgs
System.Net.PeerToPeerResolveCompletedEventArgs
System.NetUploadDataCompletedEventArgs
System.NetUploadFileCompletedEventArgs
System.NetUploadStringCompletedEventArgs
System.NetUploadValuesCompletedEventArgs
System.ServiceModelClientBaseTChannelInvokeAsyncCompletedEventArgs
System.ServiceModel.DiscoveryFindCompletedEventArgs
System.ServiceModel.DiscoveryResolveCompletedEventArgs
System.Speech.RecognitionEmulateRecognizeCompletedEventArgs
System.Speech.RecognitionLoadGrammarCompletedEventArgs
System.Speech.RecognitionRecognizeCompletedEventArgs
System.Speech.SynthesisPromptEventArgs
System.Web.Services.ProtocolsInvokeCompletedEventArgs
System.Windows.DocumentsGetPageCompletedEventArgs
System.Windows.DocumentsGetPageNumberCompletedEventArgs
System.Windows.DocumentsGetPageRootCompletedEventArgs
System.Windows.Documents.SerializationWritingCompletedEventArgs
System.Windows.Xps.SerializationXpsSerializationCompletedEventArgs
.gif)
.png)
Note