This topic has not yet been rated - Rate this topic

CancellationToken.ThrowIfCancellationRequested Method

.NET Framework 4.5

Throws a OperationCanceledException if this token has had cancellation requested.

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

public void ThrowIfCancellationRequested()

Exceptions

Exception	Condition
OperationCanceledException	The token has had cancellation requested.
ObjectDisposedException	The associated CancellationTokenSource has been disposed.

Remarks

This method provides functionality equivalent to:

    if (token.IsCancellationRequested) 
        throw new OperationCanceledException(token);

    If token.IsCancellationRequested Then
        Throw New OperationCanceledException(token)
    End If

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

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.

Reference

CancellationToken Structure

System.Threading Namespace

Other Resources

Cancellation in Managed Threads

Task Cancellation

Cancellation Tokens

How to: Cancel a Task and Its Children

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)