Parallel.ForEach<'TSource> Method (IEnumerable<'TSource>, ParallelOptions, Action<'TSource, ParallelLoopState, Int64>)

.NET Framework (current version)
 

Executes a foreach (For Each in Visual Basic) operation with 64-bit indexes on an IEnumerable 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)

static member ForEach<'TSource> : 
        source:IEnumerable<'TSource> *
        parallelOptions:ParallelOptions *
        body:Action<'TSource, ParallelLoopState, int64> -> ParallelLoopResult

Parameters

source
Type: System.Collections.Generic.IEnumerable<'TSource>

An enumerable data source.

parallelOptions
Type: System.Threading.Tasks.ParallelOptions

An object that configures the behavior of this operation.

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.

Type Parameters

TSource

The type of the data in the source.

Exception Condition
OperationCanceledException

The CancellationToken in the parallelOptions argument is canceled

ArgumentNullException

The source argument is null.

-or-

The parallelOptions argument is null.

-or-

The body argument is null.

AggregateException

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

ObjectDisposedException

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

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: