AsyncCompletedEventArgs

.NET Framework クラス ライブラリ リファレンス

AsyncCompletedEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class AsyncCompletedEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As AsyncCompletedEventArgs

C#

public class AsyncCompletedEventArgs : EventArgs

C++

public ref class AsyncCompletedEventArgs :
 public EventArgs

J#

public class AsyncCompletedEventArgs extends
 EventArgs

JScript

public class AsyncCompletedEventArgs extends
 EventArgs

解説

イベントベースの非同期パターンの概要 を実装するクラスを使用する場合、そのクラスは MethodNameCompleted イベントを提供します。System.ComponentModel.AsyncCompletedEventHandler デリゲートのインスタンスをイベントに追加すると、対応するイベント ハンドラ メソッドの AsyncCompletedEventArgs パラメータに非同期操作の結果に関する情報を受け取ります。

クライアント アプリケーションのイベント ハンドラ デリゲートは、Cancelled プロパティをチェックして、非同期タスクがキャンセルされたかどうかを確認できます。

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

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

メモ
このクラスに適用される HostProtectionAttribute 属性の Resources プロパティの値は、SharedState です。HostProtectionAttribute は、デスクトップ アプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

継承時の注意 イベント ベースの非同期パターンに従うクラスは、保留中の非同期操作のステータスについてクライアントに通知を行うイベントを発生させることができます。クラスが MethodNameCompleted イベントを提供する場合は、AsyncCompletedEventArgs を使用して、非同期操作の結果についてクライアントに通知を行うことができます。 非同期操作の結果に関して、AsyncCompletedEventArgs が提供する情報より詳しい情報をクライアントに通知することもできます。この場合は、AsyncCompletedEventArgs クラスから独自のクラスを派生させ、追加のプライベート インスタンス変数と対応する読み取り専用のパブリック プロパティを提供します。操作がキャンセルされた場合やエラーが発生した場合は、プロパティ値を返す前に RaiseExceptionIfNecessary メソッドを呼び出します。

使用例

AsyncOperation を使用して非同期操作の有効期間を追跡するコード例を次に示します。このコード例は、System.ComponentModel.AsyncOperationManager クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

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
<br /><span space="preserve">...</span><br
 />    ' 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 Not (lvi Is
 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 Not (lvi Is
 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 Not (lvi Is
 Nothing) Then
                lvi.BackColor = Color.LightGray
                lvi.Tag = Nothing
            End If
        End If

    End Sub

C#

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;
<br /><span space="preserve">...</span><br /> 
       // 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;
                }
            }
        }

J#

import System.*;
import System.Collections.*;
import System.Collections.Specialized.*;
import System.ComponentModel.*;
import System.Data.*;
import System.Drawing.*;
import System.Threading.*;
import System.Windows.Forms.*;

<br /><span space="preserve">...</span><br /> 
   private void primeNumberCalculator1_CalculatePrimeCompleted(Object
 sender,
        CalculatePrimeCompletedEventArgs e)
    {
        Guid guid = (Guid)e.get_UserState();
        if (e.get_Cancelled()) {
            String result = "Cancelled";
            ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                result);
            if (lvi != null) {
                lvi.set_BackColor(Color.get_Pink());
                lvi.set_Tag(null);
            }
        }
        else {
            if (e.get_Error() != null) {
                String result = "Error";
                ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                    result);
                if (lvi != null) {
                    lvi.set_BackColor(Color.get_Red());
                    lvi.set_ForeColor(Color.get_White());
                    lvi.set_Tag(null);
                }
            }
            else {
                boolean result = e.get_IsPrime();
                ListViewItem lvi = UpdateListViewItem((Guid)e.get_UserState(),
                    result, e.get_FirstDivisor());
                if (lvi != null) {
                    lvi.set_BackColor(Color.get_LightGray());
                    lvi.set_Tag(null);
                }
            }
        }
    } //primeNumberCalculator1_CalculatePrimeCompleted

継承階層

System.Object
   System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
       派生クラス

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
AsyncCompletedEventArgs メンバ
System.ComponentModel 名前空間
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation
その他の技術情報
イベントベースの非同期パターンの実装

AsyncCompletedEventArgs コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    error As Exception, _
    cancelled As Boolean, _
    userState As Object _
)

Visual Basic (使用法)

Dim error As Exception
Dim cancelled As Boolean
Dim userState As Object

Dim instance As New AsyncCompletedEventArgs(error,
 cancelled, userState)

C#

public AsyncCompletedEventArgs (
    Exception error,
    bool cancelled,
    Object userState
)

C++

public:
AsyncCompletedEventArgs (
    Exception^ error, 
    bool cancelled, 
    Object^ userState
)

J#

public AsyncCompletedEventArgs (
    Exception error, 
    boolean cancelled, 
    Object userState
)

JScript

public function AsyncCompletedEventArgs (
    error : Exception, 
    cancelled : boolean, 
    userState : Object
)

パラメータ

error

非同期操作中に発生したエラー。

cancelled

非同期操作がキャンセルされたかどうかを示す値。

userState

RunWorkerAsync メソッドに渡される、オプションのユーザー指定の状態オブジェクト。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
AsyncCompletedEventArgs クラス
AsyncCompletedEventArgs メンバ
System.ComponentModel 名前空間

AsyncCompletedEventArgs プロパティ

パブリック プロパティ

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

参照

関連項目

AsyncCompletedEventArgs クラス
System.ComponentModel 名前空間
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation

その他の技術情報

イベントベースの非同期パターンの実装

AsyncCompletedEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	RaiseExceptionIfNecessary	非同期操作が失敗した場合は、ユーザー指定の例外を発生させます。

参照

関連項目

AsyncCompletedEventArgs クラス
System.ComponentModel 名前空間
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation

その他の技術情報

イベントベースの非同期パターンの実装

AsyncCompletedEventArgs メンバ

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

AsyncCompletedEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	AsyncCompletedEventArgs	AsyncCompletedEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

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

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	RaiseExceptionIfNecessary	非同期操作が失敗した場合は、ユーザー指定の例外を発生させます。

参照

関連項目

AsyncCompletedEventArgs クラス
System.ComponentModel 名前空間
System.ComponentModel.AsyncCompletedEventHandler
System.ComponentModel.AsyncOperationManager
System.ComponentModel.AsyncOperation

その他の技術情報

イベントベースの非同期パターンの実装