CancellationTokenSource.CancelAsync Método

Definição

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Origem:

CancellationTokenSource.cs

Comunica uma solicitação de cancelamento de forma assíncrona.

public:
 System::Threading::Tasks::Task ^ CancelAsync();

public System.Threading.Tasks.Task CancelAsync ();

member this.CancelAsync : unit -> System.Threading.Tasks.Task

Public Function CancelAsync () As Task

Retornos

Task

Uma tarefa que será concluída após a conclusão das operações canceláveis e dos retornos de chamada registrados com o associado CancellationToken .

Exceções

ObjectDisposedException

O CancellationTokenSource foi descartado.

Comentários

O associado CancellationToken será notificado sobre o cancelamento e fará a transição síncrona para um estado em que IsCancellationRequested retornará true. Quaisquer retornos de chamada ou operações canceláveis registradas com o CancellationToken serão executados de forma assíncrona, com o retornado Task representando sua conclusão eventual.

Os retornos de chamada registrados com o token não devem gerar exceções. No entanto, todas essas exceções geradas serão agregadas em um AggregateException, de modo que um retorno de chamada que gere uma exceção não impedirá que outros retornos de chamada registrados sejam executados.

O ExecutionContext que foi capturado quando cada retorno de chamada foi registrado será restabelecido quando o retorno de chamada for invocado.