Parallel.ForEach<TSource> Method (Partitioner<TSource>, ParallelOptions, Action<TSource, ParallelLoopState>)
Executes a foreach (For Each in Visual Basic) operation on a Partitioner<TSource> 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)
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
A ParallelOptions instance 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.ParallelLoopResultA ParallelLoopResult structure that contains information on what portion of the loop completed.
| Exception | Condition |
|---|---|
| OperationCanceledException |
The exception that is thrown when the CancellationToken in the parallelOptions argument is canceled. |
| ObjectDisposedException |
The exception that is thrown when the CancellationTokenSource associated with the CancellationToken in the parallelOptions has been disposed. |
| ArgumentNullException |
The exception that is thrown when the source argument is null. -or- The exception that is thrown when the parallelOptions argument is null. -or- The exception that is thrown when the body argument is null. |
| InvalidOperationException |
The exception that is thrown when 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 that need to override the default partitioning scheme. For example, small loop bodies might benefit from partitioning the range. Parallel.ForEach expects custom partitioners to support dynamic partitioning. For more information, see Custom Partitioners for PLINQ and TPL and How to: Implement Dynamic Partitions.
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.
