Parallel.ForEach<TSource> Method (OrderablePartitioner<TSource>, Action<TSource, ParallelLoopState, Int64>)

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

Executes a foreach (For Each in Visual Basic) operation on a OrderablePartitioner<TSource> in which iterations may run in parallel and the state of the loop can be monitored and manipulated.

Namespace:   System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)

public static ParallelLoopResult ForEach<TSource>(
	OrderablePartitioner<TSource> source,
	Action<TSource, ParallelLoopState, long> body
)

Parameters

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

The orderable partitioner that contains the original data source.

body
Type: System.Action<TSource, ParallelLoopState, Int64>

The delegate that is invoked once per iteration.

Return Value

Type: System.Threading.Tasks.ParallelLoopResult

A structure that contains information about which portion of the loop completed.

Type Parameters

TSource

The type of the elements in source.

Exception Condition
ArgumentNullException

The source argument is null.

-or-

The body argument is null.

InvalidOperationException

The SupportsDynamicPartitions property in the source orderable partitioner returns false.

-or-

The KeysNormalized property in the source orderable partitioner returns false.

-or-

Any methods in the source orderable partitioner return null.

This overload is provided for scenarios where you want to override the default partitioning scheme. For example, small loop bodies might benefit from partitioning the range. The Parallel.ForEach<TSource> method expects custom partitioners to support dynamic partitioning. For more information, see Custom Partitioners for PLINQ and TPL and How to: Implement Dynamic Partitions.

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