ForEach(TSource, TLocal) Method (Partitioner(TSource), ParallelOptions, Func(TLocal), Func(TSource, ParallelLoopState, TLocal, TLocal), Action(TLocal))
TOC
Collapse the table of content
Expand the table of content

Parallel.ForEach(Of TSource, TLocal) Method (Partitioner(Of TSource), ParallelOptions, Func(Of TLocal), Func(Of TSource, ParallelLoopState, TLocal, TLocal), Action(Of TLocal))

.NET Framework (current version)
 

Executes a foreach (For Each in Visual Basic) operation with thread-local data 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 Shared Function ForEach(Of TSource, TLocal) (
	source As Partitioner(Of TSource),
	parallelOptions As ParallelOptions,
	localInit As Func(Of TLocal),
	body As Func(Of TSource, ParallelLoopState, TLocal, TLocal),
	localFinally As Action(Of TLocal)
) As ParallelLoopResult

Parameters

source
Type: System.Collections.Concurrent.Partitioner(Of TSource)

The partitioner that contains the original data source.

parallelOptions
Type: System.Threading.Tasks.ParallelOptions

An object that configures the behavior of this operation.

localInit
Type: System.Func(Of TLocal)

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

body
Type: System.Func(Of TSource, ParallelLoopState, TLocal, TLocal)

The delegate that is invoked once per iteration.

localFinally
Type: System.Action(Of 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.

Type Parameters

TSource

The type of the elements in source.

TLocal

The type of the thread-local data.

Exception Condition
ArgumentNullException

The source argument is null.

-or-

The parallelOptions argument is null.

-or-

The body argument is null.

-or-

The localInit argument is null.

-or-

The localFinally argument is null.

InvalidOperationException

The SupportsDynamicPartitions property in the sourcePartitioner returns false or the partitioner returns null partitions.

AggregateException

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

OperationCanceledException

The CancellationToken in the parallelOptions argument is canceled.

ObjectDisposedException

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(Of TSource, TLocal) method expects custom partitioners to support dynamic partitioning. This overload is provided for scenarios with small loop bodies that might benefit from static range partitioning. Partitioners must support dynamic partitions. 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 task 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(Of TSource) 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.

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