CancellationToken.ThrowIfCancellationRequested Method

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Source:

CancellationToken.cs

Throws a OperationCanceledException if this token has had cancellation requested.

public:
 void ThrowIfCancellationRequested();

public void ThrowIfCancellationRequested ();

member this.ThrowIfCancellationRequested : unit -> unit

Public Sub ThrowIfCancellationRequested ()

Exceptions

OperationCanceledException

The token has had cancellation requested.

Remarks

This method provides functionality equivalent to:

C#

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

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

See also

• Cancellation
• Task Cancellation
• How to: Cancel a Task and Its Children