ParallelEnumerable.WithMergeOptions(TSource) Method (System.Linq)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
ParallelEnumerable.WithMergeOptions<TSource> Method

Sets the merge options for this query, which specify how the query will buffer output.

Namespace:  System.Linq
Assembly:  System.Core (in System.Core.dll)
Syntax
Visual Basic
<ExtensionAttribute> _
Public Shared Function WithMergeOptions(Of TSource) ( _
	source As ParallelQuery(Of TSource), _
	mergeOptions As ParallelMergeOptions _
) As ParallelQuery(Of TSource)
C#
public static ParallelQuery<TSource> WithMergeOptions<TSource>(
	this ParallelQuery<TSource> source,
	ParallelMergeOptions mergeOptions
)
Visual C++
[ExtensionAttribute]
public:
generic<typename TSource>
static ParallelQuery<TSource>^ WithMergeOptions(
	ParallelQuery<TSource>^ source, 
	ParallelMergeOptions mergeOptions
)
F#
static member WithMergeOptions : 
        source:ParallelQuery<'TSource> * 
        mergeOptions:ParallelMergeOptions -> 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.
mergeOptions
Type: System.Linq.ParallelMergeOptions
The merge options to set for this query.

Return Value

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

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).
Exceptions
Exception Condition
ArgumentNullException

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

mergeOptions is not a valid ParallelMergeOptions value.
InvalidOperationException

WithMergeOptions is used multiple times in the query.
Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

ParallelEnumerable Class
System.Linq Namespace

Other Resources

Parallel LINQ (PLINQ)
Merge Options in PLINQ
How to: Specify Merge Options in PLINQ