Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Parallel.ForEach(Of TSource) Method (OrderablePartitioner(Of TSource), ParallelOptions, Action(Of TSource, ParallelLoopState, Int64))

Executes a foreach (For Each in Visual Basic) operation on a OrderablePartitioner(Of TSource) 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)
'Declaration
Public Shared Function ForEach(Of TSource) ( _
	source As OrderablePartitioner(Of TSource), _
	parallelOptions As ParallelOptions, _
	body As Action(Of TSource, ParallelLoopState, Long) _
) As ParallelLoopResult

Type Parameters

TSource

The type of the elements in source.

Parameters

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

The orderable partitioner that contains the original data source.

parallelOptions
Type: System.Threading.Tasks.ParallelOptions

An object that configures the behavior of this operation.

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

The CancellationToken in the parallelOptions argument is canceled

ArgumentNullException

The source argument is Nothing.

-or-

The parallelOptions argument is Nothing.

-or-

The body argument is Nothing.

ObjectDisposedException

The CancellationTokenSource associated with the CancellationToken in the parallelOptions has been disposed.

InvalidOperationException

The SupportsDynamicPartitions property in the source orderable partitioner returns false.

-or-

The KeysNormalized property in the source orderable partitioner returns false.

-or-

The exception that is thrown when any methods in the source orderable partitioner return Nothing.

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.ForEachmethod 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.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.