ParallelEnumerable.WithCancellation(Of TSource) Method
.NET Framework 4.5
Sets the CancellationToken to associate with the query.
Assembly: System.Core (in System.Core.dll)
'Declaration <ExtensionAttribute> _ Public Shared 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
- Type: System.Linq.ParallelQuery(Of TSource)
A ParallelQuery on which to set the option.
- cancellationToken
- Type: System.Threading.CancellationToken
A cancellation token.
Return Value
Type: System.Linq.ParallelQuery(Of 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(Of 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).| Exception | Condition |
|---|---|
| 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. |
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
