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

.NET Framework (current version)

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)

Syntax

C++

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.

Exceptions

Exception	Condition
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.

Version Information

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