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

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Executes a foreach (For Each in Visual Basic) operation with 64-bit indexes on an IEnumerable 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 Shared Function ForEach(Of TSource) (
	source As IEnumerable(Of TSource),
	body As Action(Of TSource, ParallelLoopState, Long)
) As ParallelLoopResult

Parameters

source
Type: System.Collections.Generic.IEnumerable(Of TSource)

An enumerable data source.

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.

Type Parameters

TSource

The type of the data in the source.

Exception Condition
ArgumentNullException

The source argument is null.

-or-

The body argument is null.

AggregateException

The exception that contains all the individual exceptions thrown on all threads.

The body delegate is invoked once for each element in the source enumerable. It is provided with the following parameters: the current element, a ParallelLoopState instance that may be used to break out of the loop prematurely, and the current element's index (Int64).

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: