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 удален.

Комментарии

Эта операция возвращает значение false, Task<TResult> если объект уже находится в одном из трех конечных состояний: RanToCompletion, Faultedили Canceled.

Этот метод также возвращает значение false, если базовый Task<TResult> объект уже удален.

См. также раздел

• Использование библиотеки параллельных задач с другими асинхронными моделями
• Практическое руководство. Создание задачи-оболочки для шаблонов 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.

Комментарии

Метод возвращает значение false, если базовый Task<TResult> объект уже находится в одном из следующих трех конечных состояний.

• TaskStatus.Canceled

• TaskStatus.Faulted

• TaskStatus.RanToCompletion

Этот метод также возвращает значение false , если базовый Task<TResult> объект уже удален.