BackgroundWorker.CancelAsync メソッド

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

BackgroundWorker.CancelAsync メソッド

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

保留中のバックグラウンド操作のキャンセルを要求します。

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

Visual Basic (宣言)

Public Sub CancelAsync

Visual Basic (使用法)

Dim instance As BackgroundWorker

instance.CancelAsync

C#

public void CancelAsync ()

C++

public:
void CancelAsync ()

J#

public void CancelAsync ()

JScript

public function CancelAsync ()

例外

例外の種類	条件
InvalidOperationException	WorkerSupportsCancellation が false です。

解説

CancelAsync は、保留中のバックグラウンド操作を終了する要求を送信し、CancellationPending プロパティに true を設定します。

CancelAsync を呼び出すと、ワーカー メソッドは実行を中止し、終了できます。ワーカー コードでは、CancellationPending プロパティを定期的にチェックし、このプロパティが true に設定されているかどうかを確認する必要があります。

注意
DoWork イベント ハンドラ内のコードは、キャンセル要求が行われているときに処理を終了できること、また、ポーリング ループは、CancellationPending に true を設定し損ねる場合があることに注意してください。この場合、キャンセル要求が行われていても、RunWorkerCompleted イベント ハンドラの System.ComponentModel.RunWorkerCompletedEventArgs の Cancelled フラグは true に設定されません。この状況は競合状態と呼ばれ、マルチスレッドのプログラミングにおける一般的な懸念事項です。マルチスレッド デザインに関する問題の詳細については、「マネージ スレッド処理の実施」を参照してください。

使用例

CancelAsync メソッドを使用して、非同期 ("バックグラウンド") 操作をキャンセルするコード例を次に示します。このコード例は、BackgroundWorker クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

Private Sub cancelAsyncButton_Click( _
ByVal sender As System.Object, _
ByVal e As System.EventArgs) _
Handles cancelAsyncButton.Click
    
    ' Cancel the asynchronous operation.
    Me.backgroundWorker1.CancelAsync()

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

C#

private void cancelAsyncButton_Click(System.Object
 sender, 
    System.EventArgs e)
{   
    // Cancel the asynchronous operation.
    this.backgroundWorker1.CancelAsync();

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

C++

void cancelAsyncButton_Click( System::Object^ /*sender*/, System::EventArgs^
 /*e*/ )
{  
   // Cancel the asynchronous operation.
   this->backgroundWorker1->CancelAsync();
   
   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}

J#

private void cancelAsyncButton_Click(Object
 sender, System.EventArgs e)
{   
    // Cancel the asynchronous operation.
    this.backgroundWorker1.CancelAsync();

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

プラットフォーム

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

参照

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