Export (0) Print
Expand All
Expand Minimize

Parallel.ForEach<TSource> Method (Partitioner<TSource>, ParallelOptions, Action<TSource, ParallelLoopState>)

Executes a foreach (For Each in Visual Basic) operation on a Partitioner in which iterations may run in parallel, loop options can be configured, 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>(
	Partitioner<TSource> source,
	ParallelOptions parallelOptions,
	Action<TSource, ParallelLoopState> body
)

Type Parameters

TSource

The type of the elements in source.

Parameters

source
Type: System.Collections.Concurrent.Partitioner<TSource>
The partitioner that contains the original data source.
parallelOptions
Type: System.Threading.Tasks.ParallelOptions
An object that configures the behavior of this operation.
body
Type: System.Action<TSource, ParallelLoopState>
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.

ExceptionCondition
OperationCanceledException

The CancellationToken in the parallelOptions argument is canceled.

ObjectDisposedException

The CancellationTokenSource associated with the CancellationToken in the parallelOptions has been disposed.

ArgumentNullException

The source argument is null.

-or-

The parallelOptions argument is null.

-or-

The body argument is null.

InvalidOperationException

The SupportsDynamicPartitions property in the source partitioner returns false.

-or-

The exception that is thrown when any methods in the source 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 method expects custom partitioners to support dynamic partitioning. For more information, see Custom Partitioners for PLINQ and TPL and How to: Implement Dynamic Partitions.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

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.

Community Additions

ADD
Show:
© 2014 Microsoft