ParallelEnumerable.WithCancellation<TSource> Method

Definition

Sets the CancellationToken to associate with the query.

C#
public static System.Linq.ParallelQuery<TSource> WithCancellation<TSource>(this System.Linq.ParallelQuery<TSource> source, System.Threading.CancellationToken cancellationToken);

Type Parameters

TSource

The type of elements of source.

Parameters

source
ParallelQuery<TSource>

A ParallelQuery on which to set the option.

cancellationToken
CancellationToken

A cancellation token.

Returns

A ParallelQuery representing the same query as source, but with the registered cancellation token.

Exceptions

The CancellationTokenSource associated with the cancellationToken has been disposed.

source is a null reference (Nothing in Visual Basic).

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
.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 2.0, 2.1
UWP 10.0

See also