BackgroundWorker.CancellationPending プロパティ

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

BackgroundWorker.CancellationPending プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

アプリケーションがバックグラウンド操作のキャンセルを要求したかどうかを示す値を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 CancellationPending As Boolean

Visual Basic (使用法)

Dim instance As BackgroundWorker
Dim value As Boolean

value = instance.CancellationPending

C#

public bool CancellationPending { get;
 }

C++

public:
property bool CancellationPending {
    bool get ();
}

J#

/** @property */
public boolean get_CancellationPending ()

JScript

public function get CancellationPending
 () : boolean

プロパティ値
アプリケーションがバックグラウンド操作のキャンセルを要求した場合は true。それ以外の場合は false。既定値は false です。

解説

CancellationPending が true の場合、BackgroundWorker に対して CancelAsync メソッドが呼び出されています。

このプロパティは、ワーカー スレッドが使用するためのものです。ワーカー スレッドは、CancellationPending を定期的にチェックし、このプロパティが true に設定されている場合はバックグラウンド操作を中止します。

使用例

CancellationPending プロパティを使用して、キャンセル状態について BackgroundWorker に問い合わせるコード例を次に示します。このコード例は、BackgroundWorker クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' Abort the operation if the user has canceled.
' Note that a call to CancelAsync may have set 
' CancellationPending to true just after the
' last invocation of this method exits, so this 
' code will not have the opportunity to set the 
' DoWorkEventArgs.Cancel flag to true. This means
' that RunWorkerCompletedEventArgs.Cancelled will
' not be set to true in your RunWorkerCompleted
' event handler. This is a race condition.
If worker.CancellationPending Then
    e.Cancel = True
Else
    If n < 2 Then
        result = 1
    Else
        result = ComputeFibonacci(n - 1, worker, e) + _
                 ComputeFibonacci(n - 2, worker, e)
    End If

    ' Report progress as a percentage of the total task.
    Dim percentComplete As Integer
 = _
        CSng(n) / CSng(numberToCompute) * 100
    If percentComplete > highestPercentageReached Then
        highestPercentageReached = percentComplete
        worker.ReportProgress(percentComplete)
    End If

End If

C#

// Abort the operation if the user has canceled.
// Note that a call to CancelAsync may have set 
// CancellationPending to true just after the
// last invocation of this method exits, so this 
// code will not have the opportunity to set the 
// DoWorkEventArgs.Cancel flag to true. This means
// that RunWorkerCompletedEventArgs.Cancelled will
// not be set to true in your RunWorkerCompleted
// event handler. This is a race condition.

if (worker.CancellationPending)
{   
    e.Cancel = true;
}
else
{   
    if (n < 2)
    {   
        result = 1;
    }
    else
    {   
        result = ComputeFibonacci(n - 1, worker, e) + 
                 ComputeFibonacci(n - 2, worker, e);
    }

    // Report progress as a percentage of the total task.
    int percentComplete = 
        (int)((float)n / (float)numberToCompute
 * 100);
    if (percentComplete > highestPercentageReached)
    {
        highestPercentageReached = percentComplete;
        worker.ReportProgress(percentComplete);
    }
}

C++

// Abort the operation if the user has cancelled.
// Note that a call to CancelAsync may have set 
// CancellationPending to true just after the
// last invocation of this method exits, so this 
// code will not have the opportunity to set the 
// DoWorkEventArgs.Cancel flag to true. This means
// that RunWorkerCompletedEventArgs.Cancelled will
// not be set to true in your RunWorkerCompleted
// event handler. This is a race condition.
if ( worker->CancellationPending )
{
   e->Cancel = true;
}
else
{
   if ( n < 2 )
   {
      result = 1;
   }
   else
   {
      result = ComputeFibonacci( n - 1, worker, e ) + ComputeFibonacci( n - 2, worker,
 e );
   }

   // Report progress as a percentage of the total task.
   int percentComplete = (int)((float)n
 / (float)numberToCompute * 100);
   if ( percentComplete > highestPercentageReached )
   {
      highestPercentageReached = percentComplete;
      worker->ReportProgress( percentComplete );
   }
}

J#

// Abort the operation if the user has cancelled.
// Note that a call to CancelAsync may have set 
// CancellationPending to true just after the
// last invocation of this method exits, so this 
// code will not have the opportunity to set the 
// DoWorkEventArgs.Cancel flag to true. This means
// that RunWorkerCompletedEventArgs.Cancelled will
// not be set to true in your RunWorkerCompleted
// event handler. This is a race condition.
if (worker.get_CancellationPending()) {

    e.set_Cancel(true);
}
else {

    if (n < 2) {
    
        result = 1;
    }
    else {
    
        result = ComputeFibonacci(n - 1, worker, e) 
            + ComputeFibonacci(n - 2, worker, e);
    }

    // Report progress as a percentage of the total task.
    int percentComplete=(int)((float)(n)/(float)(numberToCompute)*
 100);

    if (percentComplete > highestPercentageReached) {     
       
        highestPercentageReached = percentComplete;
        worker.ReportProgress(percentComplete);
    }
}

プラットフォーム

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 名前空間
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする