For Method (Int32, Int32, ParallelOptions, Action(Int32))

From Task Parallel System.Threading

previous page next page

Executes a for loop in which iterations may run in parallel.

Namespace: System.Threading.Tasks
Assembly: System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function For ( _ fromInclusive As Integer, _ toExclusive As Integer, _ parallelOptions As ParallelOptions, _ body As Action(Of Integer) _ ) As ParallelLoopResult

C#
public static ParallelLoopResult For( int fromInclusive, int toExclusive, ParallelOptions parallelOptions, Action<int> body )

Parameters

fromInclusive: Type: System..::.Int32
The start index, inclusive.

toExclusive: Type: System..::.Int32
The end index, exclusive.

parallelOptions: Type: System.Threading.Tasks..::.ParallelOptions
A ParallelOptions instance that configures the behavior of this operation.

body: Type: System..::.Action<(Of <(Int32>)>)
The delegate that is invoked once per iteration.

Return Value

A ParallelLoopResult structure that contains information on what portion of the loop completed.

Remarks

The body delegate is invoked once for each value in the iteration range: [fromInclusive, toExclusive). It is provided with the iteration count (an Int32) as a parameter.

Exceptions

Exception	Condition
System..::.ArgumentNullException	The exception that is thrown when the body argument is null.
System..::.ArgumentNullException	The exception that is thrown when the parallelOptions argument is null.
System..::.OperationCanceledException	The exception that is thrown when the CancellationToken in the parallelOptions argument is set.
System..::.AggregateException	The exception that is thrown to contain an exception thrown from one of the specified delegates.
System..::.ObjectDisposedException	The exception that is thrown when the the CancellationTokenSource associated with the the CancellationToken in the parallelOptions has been disposed.