This documentation is archived and is not being maintained.

Parallel.For Method (Int32, Int32, ParallelOptions, Action<Int32, ParallelLoopState>)

Executes a for (For in Visual Basic) loop 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)

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

Parameters

fromInclusive
Type: System.Int32
The start index, inclusive.
toExclusive
Type: System.Int32
The end index, exclusive.
parallelOptions
Type: System.Threading.Tasks.ParallelOptions
An object that configures the behavior of this operation.
body
Type: System.Action<Int32, ParallelLoopState>
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 body argument is null.

-or-

The parallelOptions 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 value in the iteration range (fromInclusive, toExclusive). It is provided with the following parameters: the iteration count (Int32), and a ParallelLoopState instance that may be used to break out of the loop prematurely.

If fromInclusive is greater than or equal to toExclusive, the method returns immediately without performing any iterations.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: