Task.Wait Method (CancellationToken) (System.Threading.Tasks)

Wait Method (CancellationToken)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Task..::.Wait Method (CancellationToken)

Waits for the Task to complete execution.

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

Syntax

Visual Basic

Public Sub Wait ( _
    cancellationToken As CancellationToken _
)

public void Wait(
    CancellationToken cancellationToken
)

Visual C++

public:
void Wait(
    CancellationToken cancellationToken
)

member Wait : 
        cancellationToken:CancellationToken -> unit

Parameters

cancellationToken: Type: System.Threading..::.CancellationToken
A CancellationToken()()() to observe while waiting for the task to complete.

Exceptions

Exception	Condition
OperationCanceledException	The cancellationToken was canceled.
ObjectDisposedException	The Task has been disposed.
AggregateException	The Task was canceled -or- an exception was thrown during the execution of the Task. If the task was canceled, the AggregateException contains an OperationCanceledException in its InnerExceptions collection.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Task Class

Wait Overload

System.Threading.Tasks Namespace

Other Resources

Task Parallel Library

Task Parallelism (Task Parallel Library)

How to: Wait on One or More Tasks to Complete