ParallelEnumerable.WithExecutionMode<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

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 execution mode of the query.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ParallelQuery<TSource> ^ WithExecutionMode(System::Linq::ParallelQuery<TSource> ^ source, System::Linq::ParallelExecutionMode executionMode);

public static System.Linq.ParallelQuery<TSource> WithExecutionMode<TSource> (this System.Linq.ParallelQuery<TSource> source, System.Linq.ParallelExecutionMode executionMode);

static member WithExecutionMode : System.Linq.ParallelQuery<'Source> * System.Linq.ParallelExecutionMode -> System.Linq.ParallelQuery<'Source>

<Extension()>
Public Function WithExecutionMode(Of TSource) (source As ParallelQuery(Of TSource), executionMode As ParallelExecutionMode) 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.

executionMode: ParallelExecutionMode

The mode in which to execute the query.

Returns

ParallelQuery<TSource>

ParallelQuery representing the same query as source, but with the registered execution mode.

Exceptions

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.

Remarks

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.

Applies to

Deila með