Partitioner.Create<TSource> Method (IEnumerable<TSource>, EnumerablePartitionerOptions)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Creates an orderable partitioner from a IEnumerable<T> instance.

Namespace:   System.Collections.Concurrent
Assembly:  mscorlib (in mscorlib.dll)

public static OrderablePartitioner<TSource> Create<TSource>(
	IEnumerable<TSource> source,
	EnumerablePartitionerOptions partitionerOptions
)

Parameters

source
Type: System.Collections.Generic.IEnumerable<TSource>

The enumerable to be partitioned.

partitionerOptions
Type: System.Collections.Concurrent.EnumerablePartitionerOptions

Options to control the buffering behavior of the partitioner.

Return Value

Type: System.Collections.Concurrent.OrderablePartitioner<TSource>

An orderable partitioner based on the input array.

Type Parameters

TSource

Type of the elements in source enumerable.

Exception Condition
ArgumentOutOfRangeException

The partitionerOptions argument specifies an invalid value for EnumerablePartitionerOptions.

The ordering used in the created partitioner is determined by the natural order of the elements as retrieved from the source enumerable.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: