Parallel.For<TLocal> Method (Int64, Int64, Func<TLocal>, Func<Int64, ParallelLoopState, TLocal, TLocal>, Action<TLocal>)
Executes a for (For in Visual Basic) loop with 64-bit indexes and thread-local data in which iterations may run in parallel, and the state of the loop can be monitored and manipulated.
Assemblies: mscorlib (in mscorlib.dll)
System.Threading.Tasks.Parallel (in System.Threading.Tasks.Parallel.dll)
public static ParallelLoopResult For<TLocal>( long fromInclusive, long toExclusive, Func<TLocal> localInit, Func<long, ParallelLoopState, TLocal, TLocal> body, Action<TLocal> localFinally )
The type of the thread-local data.
- Type: System.Int64
The start index, inclusive.
- Type: System.Int64
The end index, exclusive.
- Type: System.Func<>
The function delegate that returns the initial state of the local data for each task.
- Type: System.Action<>
The delegate that performs a final action on the local state of each task.
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 (Int64), a ParallelLoopState instance that may be used to break out of the loop prematurely, and some local state that may be shared amongst iterations that execute on the same task.
The localInit delegate is invoked once for each task that participates in the loop's execution and returns the initial local state for each of those tasks. These initial states are passed to the first body invocations on each task. Then, every subsequent body invocation returns a possibly modified state value that is passed to the next body invocation. Finally, the last body invocation on each task returns a state value that is passed to the localFinally delegate. The localFinally delegate is invoked once per task to perform a final action on each task's local state. This delegate might be invoked concurrently on multiple tasks; therefore, you must synchronize access to any shared variables.
The Parallel.For method may use more tasks than threads over the lifetime of its execution, as existing tasks complete and are replaced by new tasks. This gives the underlying TaskScheduler object the chance to add, change, or remove threads that service the loop.
If fromInclusive is greater than or equal to toExclusive, then the method returns immediately without performing any iterations.
For an example that uses this method, see How to: Write a Parallel.For Loop with Thread-Local Variables.