ParallelEnumerable.WithExecutionMode<TSource> Method

Sets the execution mode of the query.

Namespace:  System.Linq
Assemblies:   System.Linq.Parallel (in System.Linq.Parallel.dll)
  System.Core (in System.Core.dll)

public static ParallelQuery<TSource> WithExecutionMode<TSource>(
	this ParallelQuery<TSource> source,
	ParallelExecutionMode executionMode
)

Type Parameters

TSource

The type of elements of source.

Parameters

source
Type: System.Linq.ParallelQuery<TSource>

A ParallelQuery on which to set the option.

executionMode
Type: System.Linq.ParallelExecutionMode

The mode in which to execute the query.

Return Value

Type: System.Linq.ParallelQuery<TSource>
ParallelQuery representing the same query as source, but with the registered execution mode.

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
ArgumentNullException

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

ArgumentException

executionMode is not a valid ParallelExecutionMode value.

InvalidOperationException

WithExecutionMode is used multiple times in the query.

The execution mode specifies whether PLINQ will attempt to fall back to sequential execution if it detects certain query shapes. For more information and examples, see How to: Specify the Execution Mode in PLINQ.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Portable Class Library

Supported in: Portable Class Library
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft