TaskCompletionSource<TResult>.TrySetCanceled 方法

定义

命名空间:

System.Threading.Tasks

程序集:

System.Runtime.dll

尝试将基础 Task<TResult> 转换为 Canceled 状态。

重载

TrySetCanceled()	尝试将基础 Task<TResult> 转换为 Canceled 状态。
TrySetCanceled(CancellationToken)	尝试将基础 Task<TResult> 转换为 Canceled 状态并启用要存储在取消的任务中的取消标记。

TrySetCanceled()

Source:

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。

注解

如果 Task<TResult> 已处于三种最终状态之一： RanToCompletion、 Faulted或 Canceled，则此操作将返回 false。

如果基础 Task<TResult> 已释放，此方法也会返回 false。

另请参阅

• 将 TPL 和其他异步模式结合使用
• 如何：在任务中包装 EAP 模式

TrySetCanceled(CancellationToken)

Source:

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

如果基础Task<TResult>对象已被释放，此方法也会返回 false 。