Cancel Method (Boolean)
Collapse the table of content
Expand the table of content

CancellationTokenSource.Cancel Method (Boolean)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Communicates a request for cancellation.

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

public void Cancel(
	bool throwOnFirstException
)

Parameters

throwOnFirstException
Type: System.Boolean
Specifies whether exceptions should immediately propagate.

ExceptionCondition
ObjectDisposedException

This CancellationTokenSource has been disposed.

AggregateException

An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true.

Any callbacks or cancelable operations registered with the CancellationToken will be executed.

Cancelable operations and callbacks registered with the token should not throw exceptions.

If throwOnFirstException is true, an exception will immediately propagate out of the call to Cancel, preventing the remaining callbacks and cancelable operations from being processed.

If throwOnFirstException is false, this overload will aggregate any exceptions thrown into an AggregateException, such that one callback throwing an exception will not prevent other registered callbacks from being executed.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft