Task.Delay Method (TimeSpan, CancellationToken)

.NET Framework 4.5

Creates a task that will complete after a time delay.

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

'Declaration
Public Shared Function Delay ( _
	delay As TimeSpan, _
	cancellationToken As CancellationToken _
) As Task

Parameters

delay
Type: System.TimeSpan

The time span to wait before completing the returned task

cancellationToken
Type: System.Threading.CancellationToken

The cancellation token that will be checked prior to completing the returned task

Return Value

Type: System.Threading.Tasks.Task
A task that represents the time delay

ExceptionCondition
ArgumentOutOfRangeException

delay represents a negative time interval or is greater than TimeSpan.MaxValue.

TaskCanceledException

The task has been canceled.

ObjectDisposedException

The provided cancellationToken has already been disposed.

If the cancellation token is signaled before the specified time delay, then the task is completed in TaskStatus.Canceled state. Otherwise, the task is completed in TaskStatus.RanToCompletion state once the specified time delay has expired.

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft