Parallel::ForEach<TSource> Method (OrderablePartitioner<TSource>, Action<TSource, ParallelLoopState, Int64>)
Executes a foreach (For Each in Visual Basic) operation on a OrderablePartitioner<TSource> in which iterations may run in parallel and the state of the loop can be monitored and manipulated.
Namespace: System.Threading.Tasks
Assembly: mscorlib (in mscorlib.dll)
public: generic<typename TSource> static ParallelLoopResult ForEach( OrderablePartitioner<TSource>^ source, Action<TSource, ParallelLoopState^, long long>^ body )
Type Parameters
- TSource
The type of the elements in source.
Parameters
- source
- Type: System.Collections.Concurrent::OrderablePartitioner<TSource>
The orderable partitioner that contains the original data source.
- body
- Type: System::Action<TSource, ParallelLoopState, Int64>
The delegate that is invoked once per iteration.
Return Value
Type: System.Threading.Tasks::ParallelLoopResultA structure that contains information about which portion of the loop completed.
| Exception | Condition |
|---|---|
| ArgumentNullException | The source argument is nullptr. -or- The body argument is nullptr. |
| InvalidOperationException | The SupportsDynamicPartitions property in the source orderable partitioner returns false. -or- The KeysNormalized property in the source orderable partitioner returns false. -or- Any methods in the source orderable partitioner return nullptr. |
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.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
