TaskCompletionSource<TResult>.TrySetCanceled 方法

定義

命名空間:

System.Threading.Tasks

組件:

netstandard.dll, System.Runtime.dll

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

多載

名稱	Description
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 若手術成功;若操作失敗或物件已被處理，則為假。

例外狀況

ObjectDisposedException

他 Task 被處置了。

備註

若 已 Task<TResult> 處於三個最終狀態之一： RanToCompletion、 Faulted、 或 Canceled，則此操作將回傳為假。

若標的 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> 物件已處於以下三種最終狀態之一，則該方法會回傳 false。

• TaskStatus.Canceled

• TaskStatus.Faulted

• TaskStatus.RanToCompletion

若底層false物件已被處置，此方法也會回傳Task<TResult>。