AsyncCompletedEventArgs クラス

リファレンス

定義

名前空間:: System.ComponentModel

アセンブリ:: System.ComponentModel.EventBasedAsync.dll

アセンブリ:: System.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

MethodNameCompleted イベントのデータを提供します。

public ref class AsyncCompletedEventArgs : EventArgs

public class AsyncCompletedEventArgs : EventArgs

type AsyncCompletedEventArgs = class
    inherit EventArgs

Public Class AsyncCompletedEventArgs
Inherits EventArgs

継承: Object

EventArgs
AsyncCompletedEventArgs

派生: System.Activities.InvokeCompletedEventArgs

System.ComponentModel.RunWorkerCompletedEventArgs

System.Deployment.Application.CheckForUpdateCompletedEventArgs

System.Deployment.Application.DownloadApplicationCompletedEventArgs

System.Deployment.Application.DownloadFileGroupCompletedEventArgs

その他…

例

次のコード例では、非同期操作の有効期間を追跡するための使用 AsyncOperation 例を示します。このコード例は、System.ComponentModel.AsyncOperationManager クラスのために提供されている大規模な例の一部です。

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.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。デリゲートの System.ComponentModel.AsyncCompletedEventHandler インスタンスをイベントに追加すると、対応するイベントハンドラーメソッドのパラメーターで AsyncCompletedEventArgs 非同期操作の結果に関する情報を受け取ります。

クライアントアプリケーションのイベントハンドラーデリゲートは、プロパティを Cancelled 確認して、非同期タスクが取り消されたかどうかを判断できます。

クライアントアプリケーションのイベントハンドラーデリゲートは、非同期タスクの実行中に例外が発生したかどうかを確認するためにプロパティを確認 Error できます。

クラスが複数の非同期メソッド、または同じ非同期メソッドの複数の呼び出しをサポートしている場合は、プロパティの値を確認することで 、MethodNameCompleted イベントを発生させたタスクを UserState 特定できます。コードでは、対応する非同期タスクの開始と完了時に、タスク ID と呼ばれるこれらのトークンを追跡する必要があります。

注意 (継承者)

イベントベースの非同期パターンに従うクラスは、保留中の非同期操作の状態についてクライアントに警告するイベントを発生させることができます。クラスが MethodNameCompleted イベントを提供する場合は、非同期操作の AsyncCompletedEventArgs 結果をクライアントに通知するために使用できます。

対応するよりも、非同期操作の結果に関するより多くの情報をクライアントに AsyncCompletedEventArgs 伝えたい場合があります。この場合は、クラスから独自のクラスを派生させ、追加の AsyncCompletedEventArgs プライベートインスタンス変数と対応する読み取り専用パブリックプロパティを指定できます。操作が RaiseExceptionIfNecessary() 取り消されたか、エラーが発生した場合に、プロパティ値を返す前にメソッドを呼び出します。

コンストラクター

AsyncCompletedEventArgs()	互換性のために残されています。 AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。
AsyncCompletedEventArgs(Exception, Boolean, Object)	AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。

プロパティ

Cancelled	非同期操作がキャンセルされたかどうかを示す値を取得します。
Error	非同期操作中に発生したエラーを示す値を取得します。
UserState	非同期タスクの一意の識別子を取得します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
RaiseExceptionIfNecessary()	非同期操作が失敗した場合は、ユーザー指定の例外を発生させます。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象