Parallel.ForEach(TSource, TLocal) Method (Partitioner(TSource), ParallelOptions, Func(TLocal), Func(TSource, ParallelLoopState, TLocal, TLocal), Action(TLocal))
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.
Assembly: mscorlib (in mscorlib.dll)
static member ForEach : source:Partitioner<'TSource> * parallelOptions:ParallelOptions * localInit:Func<'TLocal> * body:Func<'TSource, ParallelLoopState, 'TLocal, 'TLocal> * localFinally:Action<'TLocal> -> ParallelLoopResult
The type of the elements in source.
The type of the thread-local data.
- Type: System.Collections.Concurrent.Partitioner()
The partitioner that contains the original data source.
- Type: System.Threading.Tasks.ParallelOptions
An object that configures the behavior of this operation.
- Type: System.Func()
The function delegate that returns the initial state of the local data for each task.
- Type: System.Action()
The delegate that performs a final action on the local state of each task.
Return ValueType: System.Threading.Tasks.ParallelLoopResult
A structure that contains information about which portion of the loop completed.
The source argument is a null reference (Nothing in Visual Basic).
The parallelOptions argument is a null reference (Nothing in Visual Basic).
The body argument is a null reference (Nothing in Visual Basic).
The localInit argument is a null reference (Nothing in Visual Basic).
The localFinally argument is a null reference (Nothing in Visual Basic).
The exception that contains all the individual exceptions thrown on all threads.
The CancellationToken in the parallelOptions argument is canceled.
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. 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 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.