TaskCompletionSource<TResult>.TrySetCanceled 方法

定義

命名空間:

System.Threading.Tasks

組件:

System.Threading.Tasks.dll

組件:

System.Runtime.dll

組件:

mscorlib.dll

組件:

netstandard.dll

嘗試將基礎 Task<TResult> 轉換為 Canceled 狀態。

多載

TrySetCanceled()	嘗試將基礎 Task<TResult> 轉換為 Canceled 狀態。
TrySetCanceled(CancellationToken)	嘗試將基礎 Task<TResult> 轉換為 Canceled 狀態，並使取消語彙基元儲存於已取消的工作。

TrySetCanceled()

嘗試將基礎 Task<TResult> 轉換為 Canceled 狀態。

public:
 bool TrySetCanceled();

public bool TrySetCanceled ();

member this.TrySetCanceled : unit -> bool

Public Function TrySetCanceled () As Boolean

傳回

Boolean

如果作業成功，則為 true；如果作業不成功或物件已經處置，則為 false。

例外狀況

ObjectDisposedException

已處置 Task。

備註

如果 Task<TResult> 已經處於三個最終狀態之一，則此作業會傳回 false： RanToCompletion 、 Faulted 或 Canceled 。

如果已經處置基礎 Task<TResult> ，這個方法也會傳回 false。

另請參閱

• 使用具有其他非同步模式的 TPL
• 作法：將 EAP 模式包裝在工作中

TrySetCanceled(CancellationToken)

嘗試將基礎 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> 物件已經處於下列三個最終狀態之一，此方法會傳回 false。

• TaskStatus.Canceled

• TaskStatus.Faulted

• TaskStatus.RanToCompletion

如果已處置基礎 Task<TResult> 物件，這個方法也會傳 false 回 。