Expand Minimize

Parallel::ForEach<TSource, TLocal> Method (OrderablePartitioner<TSource>, ParallelOptions, Func<TLocal>, Func<TSource, ParallelLoopState, Int64, TLocal, TLocal>, Action<TLocal>)

.NET Framework 4.6 and 4.5

Executes a foreach (For Each in Visual Basic) operation with 64-bit indexes and with thread-local data on a OrderablePartitioner<TSource> 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
Assemblies:   mscorlib (in mscorlib.dll)
  System.Threading.Tasks.Parallel (in System.Threading.Tasks.Parallel.dll)

generic<typename TSource, typename TLocal>
static ParallelLoopResult ForEach(
	OrderablePartitioner<TSource>^ source, 
	ParallelOptions^ parallelOptions, 
	Func<TLocal>^ localInit, 
	Func<TSource, ParallelLoopState^, long long, TLocal, TLocal>^ body, 
	Action<TLocal>^ localFinally

Type Parameters


The type of the elements in source.


The type of the thread-local data.


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

The orderable partitioner that contains the original data source.

Type: System.Threading.Tasks::ParallelOptions

An object that configures the behavior of this operation.

Type: System::Func<TLocal>

The function delegate that returns the initial state of the local data for each task.

Type: System::Func<TSource, ParallelLoopState, Int64, TLocal, TLocal>

The delegate that is invoked once per iteration.

Type: System::Action<TLocal>

The delegate that performs a final action on the local state of each task.

Return Value

Type: System.Threading.Tasks::ParallelLoopResult
A structure that contains information about which portion of the loop completed.


The source argument is nullptr.


The parallelOptions argument is nullptr.


The body argument is nullptr.


The localInit or localFinally argument is nullptr.


The SupportsDynamicPartitions property in the source Partitioner returns false or the partitioner returns nullptr partitions.


The exception that contains all the individual exceptions thrown on all threads.


The CancellationToken in the parallelOptions argument is canceled.


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

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

The localInit delegate is invoked once for each task that participates in the loop's execution and returns the initial local state for each of those tasks. These initial states are passed to the first body invocations on each task. Then, every subsequent body invocation returns a possibly modified state value that is passed to the next body invocation. Finally, the last body invocation on each thread returns a state value that is passed to the localFinally delegate. The localFinally delegate is invoked once per task to perform a final action on each task’s local state. This delegate might be invoked concurrently on multiple tasks; therefore, you must synchronize access to any shared variables.

The Parallel::ForEach method may use more tasks than threads over the lifetime of its execution, as existing tasks complete and are replaced by new tasks. This gives the underlying TaskScheduler object the chance to add, change, or remove threads that service the loop.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft