TaskCompletionSource<TResult>.TrySetCanceled メソッド

定義

名前空間:

System.Threading.Tasks

アセンブリ:

System.Runtime.dll

基になる Task<TResult> の Canceled 状態への遷移を試みます。

オーバーロード

TrySetCanceled()	基になる Task<TResult> の Canceled 状態への遷移を試みます。
TrySetCanceled(CancellationToken)	基になる Task<TResult> の Canceled 状態への遷移を試みるとともに、キャンセル トークンをキャンセルされたタスクに格納できるようにします。

TrySetCanceled()

ソース:

TaskCompletionSource_T.cs

基になる Task<TResult> の Canceled 状態への遷移を試みます。

public:
 bool TrySetCanceled();

public bool TrySetCanceled ();

member this.TrySetCanceled : unit -> bool

Public Function TrySetCanceled () As Boolean

戻り値

Boolean

操作が正常に終了した場合は true、操作が失敗した場合またはオブジェクトが既に破棄されている場合は false。

例外

ObjectDisposedException

Task が破棄されました。

注釈

が、、または Canceledのいずれかの最後のTask<TResult>状態RanToCompletionFaultedにある場合、この操作は false を返します。

基になる Task<TResult> が既に破棄されている場合も、このメソッドは false を返します。

こちらもご覧ください

• TPL と他の非同期パターンの使用
• 方法:タスクに EAP パターンをラップする

TrySetCanceled(CancellationToken)

ソース:

TaskCompletionSource_T.cs

基になる Task<TResult> の Canceled 状態への遷移を試みるとともに、キャンセル トークンをキャンセルされたタスクに格納できるようにします。

public:
 bool TrySetCanceled(System::Threading::CancellationToken cancellationToken);

public bool TrySetCanceled (System.Threading.CancellationToken cancellationToken);

member this.TrySetCanceled : System.Threading.CancellationToken -> bool

Public Function TrySetCanceled (cancellationToken As CancellationToken) As Boolean

パラメーター

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Boolean

操作が正常に終了した場合は true。それ以外の場合は false。

注釈

基になる Task<TResult> オブジェクトが次の 3 つの最終状態のいずれかに既にある場合、メソッドは false を返します。

• TaskStatus.Canceled

• TaskStatus.Faulted

• TaskStatus.RanToCompletion

基になるTask<TResult>オブジェクトが既に破棄されている場合も、このメソッドは を返falseします。