Parallel.For Method (Int32, Int32, Action<Int32, ParallelLoopState>)
Executes a for (For in Visual Basic) loop in which iterations may run in parallel and the state of the loop can be monitored and manipulated.
Assembly: mscorlib (in mscorlib.dll)
public static ParallelLoopResult For( int fromInclusive, int toExclusive, Action<int, ParallelLoopState> body )
- Type: System.Int32
The start index, inclusive.
- Type: System.Int32
The end index, exclusive.
Return ValueType: System.Threading.Tasks.ParallelLoopResult
A structure that contains information about which portion of the loop completed.
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.
Calling the Break method informs the for operation that iterations after the current one don't have to execute. However, all iterations before the current one will still have to be executed if they haven't already.
Therefore, calling Break is similar to using a break operation within a conventional for loop in a language like C#, but it is not a perfect substitute: For example, there is no guarantee that iterations after the current one will definitely not execute.
If executing all iterations before the current one is not necessary, use the Stop method instead of using Break. Calling Stop informs the for loop that it may abandon all remaining iterations, regardless of whether they're before or after the current iteration, because all required work will have already been completed. However, as with Break, there are no guarantees regarding which other iterations will not execute.
If a loop is ended prematurely, the ParallelLoopResult structure that is returned will contain relevant information about the loop's completion.
If fromInclusive is greater than or equal to toExclusive, the method returns immediately without performing any iterations.
This example demonstrates how to use the ParallelLoopState instance, which is passed to the body delegate of some Parallel.For overloads, to stop a loop's execution before all iterations have completed executing.
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.