AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs Class

定義

MethodNameCompleted イベントのデータを提供します。Provides data for the MethodNameCompleted event.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
継承
AsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgs
派生

次のコード例に示しますを使用して、AsyncOperation非同期操作の有効期間を追跡します。The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. このコード例が示されている例の一部、System.ComponentModel.AsyncOperationManagerクラス。This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

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;
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 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;
        }
    }
}
' 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

注釈

実装するクラスを使用している場合、 - イベント ベースの非同期パターンの概要、クラスが提供するMethodName Completedイベント。If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. インスタンスを追加する場合、System.ComponentModel.AsyncCompletedEventHandlerデリゲート、イベントでの非同期操作の結果に関する情報が表示されます、AsyncCompletedEventArgs対応するイベント ハンドラー メソッドのパラメーター。If you add an instance of the System.ComponentModel.AsyncCompletedEventHandler delegate to the event, you will receive information about the outcome of asynchronous operations in the AsyncCompletedEventArgs parameter of the corresponding event-handler method.

クライアント アプリケーションのイベント ハンドラー デリゲートを確認できます、Cancelledプロパティのかどうか、非同期タスクが取り消されました。The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

クライアント アプリケーションのイベント ハンドラー デリゲートを確認できます、Error非同期タスクの実行中に例外が発生したかどうかを決定するプロパティ。The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

クラスは、複数の非同期メソッド、または同じの非同期メソッドに複数の呼び出しをサポートする場合、タスクが発生したを判断する、 MethodName Completedイベントの値をチェックして、UserStateプロパティ。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. コードは、対応する非同期タスクの開始し、完了と、タスク Id と呼ばれるこれらのトークンを追跡する必要があります。Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

注意 (継承者)

イベント ベースの非同期パターンに従うクラスは、保留中の非同期操作の状態についてクライアントに通知するイベントを発生させることができます。Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. クラスを提供する場合、 MethodName Completed使用することができます、イベント、AsyncCompletedEventArgs非同期操作の結果についてクライアントに通知します。If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

クライアントと通信するよりも非同期操作の結果についての詳細については、AsyncCompletedEventArgs対応しています。You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. この場合、派生クラスから、AsyncCompletedEventArgsクラスし、その他のプライベート インスタンス変数と対応する読み取り専用のパブリック プロパティを提供します。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. 呼び出す、RaiseExceptionIfNecessary()メソッド、プロパティの値を返す場合は、操作が取り消されたか、エラーが発生する前にします。Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

コンストラクター

AsyncCompletedEventArgs() AsyncCompletedEventArgs() AsyncCompletedEventArgs() AsyncCompletedEventArgs()

AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the AsyncCompletedEventArgs class.

AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object)

AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。Initializes a new instance of the AsyncCompletedEventArgs class.

プロパティ

Cancelled Cancelled Cancelled Cancelled

非同期操作がキャンセルされたかどうかを示す値を取得します。Gets a value indicating whether an asynchronous operation has been canceled.

Error Error Error Error

非同期操作中に発生したエラーを示す値を取得します。Gets a value indicating which error occurred during an asynchronous operation.

UserState UserState UserState UserState

非同期タスクの一意の識別子を取得します。Gets the unique identifier for the asynchronous task.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() RaiseExceptionIfNecessary()

非同期操作が失敗した場合は、ユーザー指定の例外を発生させます。Raises a user-supplied exception if an asynchronous operation failed.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください