CancellationToken.ThrowIfCancellationRequested Method

Definition

Throws a OperationCanceledException if this token has had cancellation requested.

C#
public void ThrowIfCancellationRequested();

Exceptions

The token has had cancellation requested.

Remarks

This method provides functionality equivalent to:

C#

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

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also