Export (0) Print
Expand All
Expand Minimize

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

.NET Framework 4.6 and 4.5

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
Assemblies:   mscorlib (in mscorlib.dll)
  System.Threading.Tasks.Parallel (in System.Threading.Tasks.Parallel.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::ParallelLoopResult
A structure that contains information about which portion of the loop completed.

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

.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
Show:
© 2015 Microsoft