ParallelEnumerable.WithCancellation<TSource> Method

Reference

Definition

Namespace:: System.Linq

Assemblies:: System.Core.dll, System.Linq.Parallel.dll

Assemblies:: netstandard.dll, System.Linq.Parallel.dll

Assembly:: System.Linq.Parallel.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Source:: ParallelEnumerable.cs

Source:: ParallelEnumerable.cs

Source:: ParallelEnumerable.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the CancellationToken to associate with the query.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ParallelQuery<TSource> ^ WithCancellation(System::Linq::ParallelQuery<TSource> ^ source, System::Threading::CancellationToken cancellationToken);

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

static member WithCancellation : System.Linq.ParallelQuery<'Source> * System.Threading.CancellationToken -> System.Linq.ParallelQuery<'Source>

<Extension()>
Public Function WithCancellation(Of TSource) (source As ParallelQuery(Of TSource), cancellationToken As CancellationToken) As ParallelQuery(Of TSource)

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

ParallelQuery<TSource>

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

Exceptions

ObjectDisposedException

The CancellationTokenSource associated with the cancellationToken has been disposed.

ArgumentNullException

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

InvalidOperationException

WithCancellation<TSource>(ParallelQuery<TSource>, CancellationToken) is used multiple times in the query.

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

Share via