Export (0) Print
Expand All

ParallelEnumerable.WithCancellation(TSource) Method

Sets the CancellationToken to associate with the query.

Namespace:  System.Linq
Assembly:  System.Core (in System.Core.dll)

static member WithCancellation : 
        source:ParallelQuery<'TSource> * 
        cancellationToken:CancellationToken -> ParallelQuery<'TSource> 

Type Parameters

TSource

The type of elements of source.

Parameters

source
Type: System.Linq.ParallelQuery(TSource)

A ParallelQuery on which to set the option.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token.

Return Value

Type: System.Linq.ParallelQuery(TSource)
ParallelQuery representing the same query as source, but with the registered cancellation token.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ParallelQuery(TSource). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
ObjectDisposedException

The CancellationTokenSource associated with the cancellationToken has been disposed.

ArgumentNullException

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

InvalidOperationException

WithCancellation is used multiple times in the query.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1
Show:
© 2015 Microsoft