Redigera

Dela via

ParallelEnumerable.WithCancellation<TSource> Method

  • Reference

Definition

Namespace:
System.Linq
Assembly:
System.Linq.Parallel.dll
Assembly:
System.Core.dll
Assembly:
netstandard.dll
Source:
ParallelEnumerable.cs
Source:
ParallelEnumerable.cs
Source:
ParallelEnumerable.cs

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

See also