RunWorkerCompletedEventArgsとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

RunWorkerCompletedEventArgs クラス

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

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

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

Visual Basic (宣言)

Public Class RunWorkerCompletedEventArgs
    Inherits AsyncCompletedEventArgs

Visual Basic (使用法)

Dim instance As RunWorkerCompletedEventArgs

public class RunWorkerCompletedEventArgs :
 AsyncCompletedEventArgs

C++

public ref class RunWorkerCompletedEventArgs
 : public AsyncCompletedEventArgs

public class RunWorkerCompletedEventArgs extends
 AsyncCompletedEventArgs

JScript

public class RunWorkerCompletedEventArgs extends
 AsyncCompletedEventArgs

解説

イベントベースの非同期パターンの概要を実装するクラスを使用している場合、そのクラスは MethodNameCompleted イベントを提供します。MethodName は、メソッド名の最初の部分を表すプレースホルダです。BackgroundWorker.OnRunWorkerCompleted は、このようなメソッドの名前の例です。RunWorkerCompletedEventArgs デリゲートのインスタンスをイベントに追加すると、対応するイベントハンドラの RunWorkerCompletedEventArgs パラメータに非同期操作の結果に関する情報を受け取ります。

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

メモ

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

使用例

RunWorkerCompletedEventArgs の使用方法を次のコード例に示します。このコード例は、BackgroundWorker クラスのトピックで取り上げているコード例の一部です。

Visual Basic

' This event handler deals with the results of the
' background operation.
Private Sub backgroundWorker1_RunWorkerCompleted(
 _
ByVal sender As Object,
 ByVal e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

    ' First, handle the case where an exception was thrown.
    If Not (e.Error Is Nothing)
 Then
        MessageBox.Show(e.Error.Message)
    ElseIf e.Cancelled Then
        ' Next, handle the case where the user canceled the 
        ' operation.
        ' Note that due to a race condition in 
        ' the DoWork event handler, the Cancelled
        ' flag may not have been set, even though
        ' CancelAsync was called.
        resultLabel.Text = "Canceled"
    Else
        ' Finally, handle the case where the operation succeeded.
        resultLabel.Text = e.Result.ToString()
    End If

    ' Enable the UpDown control.
    Me.numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

    ' Disable the Cancel button.
    cancelAsyncButton.Enabled = False
End Sub 'backgroundWorker1_RunWorkerCompleted

// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    {
        MessageBox.Show(e.Error.Message);
    }
    else if (e.Cancelled)
    {
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
    }
    else
    {
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();
    }

    // Enable the UpDown control.
    this.numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}

C++

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted( Object^ /*sender*/,
 RunWorkerCompletedEventArgs^ e )
{
   // First, handle the case where an exception was thrown.
   if ( e->Error != nullptr )
   {
      MessageBox::Show( e->Error->Message );
   }
   else
   if ( e->Cancelled )
   {
      // Next, handle the case where the user cancelled 
      // the operation.
      // Note that due to a race condition in 
      // the DoWork event handler, the Cancelled
      // flag may not have been set, even though
      // CancelAsync was called.
      resultLabel->Text = "Cancelled";
   }
   else
   {
      // Finally, handle the case where the operation 
      // succeeded.
      resultLabel->Text = e->Result->ToString();
   }

   // Enable the UpDown control.
   this->numericUpDown1->Enabled = true;

   // Enable the Start button.
   startAsyncButton->Enabled = true;

   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}

// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(Object
 sender,
    RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.get_Error() != null) {
    
        MessageBox.Show(e.get_Error().get_Message());
    }
    else {
    
        if (e.get_Cancelled()) {
        
            // Next, handle the case where the user cancelled 
            // the operation.
            // Note that due to a race condition in 
            // the DoWork event handler, the Cancelled
            // flag may not have been set, even though
            // CancelAsync was called.
            resultLabel.set_Text("Cancelled");
        }
        else {
        
            // Finally, handle the case where the operation 
            // succeeded.
            resultLabel.set_Text(e.get_Result().ToString());
        }
    }

    // Enable the UpDown control.
    this.numericUpDown1.set_Enabled(true);

    // Enable the Start button.
    startAsyncButton.set_Enabled(true);

    // Disable the Cancel button.
    cancelAsyncButton.set_Enabled(false);
} //backgroundWorker1_RunWorkerCompleted

継承階層

System.Object
   System.EventArgs
     System.ComponentModel.AsyncCompletedEventArgs
      System.ComponentModel.RunWorkerCompletedEventArgs

スレッドセーフ

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RunWorkerCompletedEventArgs メンバ
System.ComponentModel 名前空間
BackgroundWorker クラス
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする

RunWorkerCompletedEventArgs コンストラクタ

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim result As Object
Dim error As Exception
Dim cancelled As Boolean

Dim instance As New RunWorkerCompletedEventArgs(result,
 error, cancelled)

public RunWorkerCompletedEventArgs (
    Object result,
    Exception error,
    bool cancelled
)

C++

public:
RunWorkerCompletedEventArgs (
    Object^ result, 
    Exception^ error, 
    bool cancelled
)

public RunWorkerCompletedEventArgs (
    Object result, 
    Exception error, 
    boolean cancelled
)

JScript

public function RunWorkerCompletedEventArgs
 (
    result : Object, 
    error : Exception, 
    cancelled : boolean
)

パラメータ

result: 非同期操作の結果。

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

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RunWorkerCompletedEventArgs クラス
RunWorkerCompletedEventArgs メンバ
System.ComponentModel 名前空間
BackgroundWorker クラス
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする

RunWorkerCompletedEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Cancelled	非同期操作がキャンセルされたかどうかを示す値を取得します。 ( AsyncCompletedEventArgs から継承されます。)
	Error	非同期操作中に発生したエラーを示す値を取得します。 ( AsyncCompletedEventArgs から継承されます。)
	Result	非同期操作の結果を表す値を取得します。
	UserState	ユーザーの状態を表す値を取得します。

参照

その他の技術情報

方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする

RunWorkerCompletedEventArgs メソッド

パブリックメソッドパブリックメソッド

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

	名前	説明
	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 から継承されます。)

参照

その他の技術情報

方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする

RunWorkerCompletedEventArgs メンバ

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

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

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

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

パブリックプロパティ

	名前	説明
	Cancelled	非同期操作がキャンセルされたかどうかを示す値を取得します。(AsyncCompletedEventArgs から継承されます。)
	Error	非同期操作中に発生したエラーを示す値を取得します。(AsyncCompletedEventArgs から継承されます。)
	Result	非同期操作の結果を表す値を取得します。
	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 から継承されます。)