Export (0) Print
Expand All

Task.Wait Method (CancellationToken)

Waits for the Task to complete execution. The wait terminates if a cancellation token is canceled before the task completes.

Namespace:  System.Threading.Tasks
Assemblies:   System.Threading.Tasks (in System.Threading.Tasks.dll)
  mscorlib (in mscorlib.dll)

Public Sub Wait ( _
	cancellationToken As CancellationToken _


Type: System.Threading.CancellationToken

A cancellation token to observe while waiting for the task to complete.


The cancellationToken was canceled.


The task has been disposed.


The task was canceled. The AggregateException.InnerExceptions collection contains a TaskCanceledException object.


An exception was thrown during the execution of the task. The AggregateException.InnerExceptions collection contains information about the exception or exceptions.

The Wait(CancellationToken) method creates a cancelable wait; that is, it causes the current thread to wait until one of the following occurs:

  • The task completes.

  • The cancellation token is canceled. In this case, the call to the Wait(CancellationToken) method throws an OperationCanceledException.


Canceling the cancellationToken cancellation token has no effect on the running task unless it has also been passed the cancellation token and is prepared to handle cancellation. Passing the cancellationToken object to this method simply allows the wait to be canceled.

The following example illustrates the simple use of a cancellation token to cancel waiting for a task's completion. A task is launched, calls the CancellationTokenSource.Cancel method to cancel any of the token source's cancellation tokens, and then delays for five seconds. Note that the task itself has not been passed the cancellation token and is not cancelable. The application thread calls the task's Task.Wait method to wait for the task to complete, but the wait is canceled once the cancellation token is cancelled and an OperationCanceledException is thrown. The exception handler reports the exception and then sleeps for six seconds. As the output from the example shows, that delay allows the task to complete in the TaskStatus.RanToCompletion state.

Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim ts As New CancellationTokenSource()

      Dim t = Task.Run( Sub()
                           Console.WriteLine("Calling Cancel...")
                           Console.WriteLine("Task ended delay...")
                        End Sub)
         Console.WriteLine("About to wait for the task to complete...")
      Catch e As OperationCanceledException
         Console.WriteLine("{0}: The wait has been canceled. Task status: {1:G}",
                           e.GetType().Name, t.Status)
         Console.WriteLine("After sleeping, the task status:  {0:G}", t.Status)
      End Try
   End Sub 
End Module 
' The example displays output like the following: 
'    About to wait for the task to complete... 
'    Calling Cancel... 
'    OperationCanceledException: The wait has been canceled. Task status: Running 
'    Task ended delay... 
'    After sleeping, the task status:  RanToCompletion

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
© 2015 Microsoft