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

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Executes a for (For in Visual Basic) loop with 64-bit indexes 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(
	long fromInclusive,
	long toExclusive,
	ParallelOptions parallelOptions,
	Action<long, ParallelLoopState> body
)

Parameters

fromInclusive
Type: System.Int64

The start index, inclusive.

toExclusive
Type: System.Int64

The end index, exclusive.

parallelOptions
Type: System.Threading.Tasks.ParallelOptions

An object that configures the behavior of this operation.

body
Type: System.Action<Int64, 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.

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 (Int64), 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.

The following example shows how to use the Parallel.For method with a ParallelOptions object:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;


class ParallelOptionsDemo
{
    // Demonstrated features:
    // 		Parallel.For()
    //		ParallelOptions
    // Expected results:
    // 		An iteration for each argument value (0, 1, 2, 3, 4, 5, 6, 7, 8, 9) is executed.
    //		The order of execution of the iterations is undefined.
    //		Verify that no more than two threads have been used for the iterations.
    // Documentation:
    //		http://msdn.microsoft.com/en-us/library/system.threading.tasks.parallel.for(VS.100).aspx
    static void Main()
    {
        ParallelOptions options = new ParallelOptions();
        options.MaxDegreeOfParallelism = 2; // -1 is for unlimited. 1 is for sequential.

        try
        {
            Parallel.For(
                    0,
                    9,
                    options,
                    (i) =>
                    {
                        Console.WriteLine("Thread={0}, i={1}", Thread.CurrentThread.ManagedThreadId, i);
                    }
                );

        }
        // No exception is expected in this example, but if one is still thrown from a task,
        // it will be wrapped in AggregateException and propagated to the main thread.
        catch (AggregateException e)
        {
            Console.WriteLine("Parallel.For has thrown the following (unexpected) exception:\n{0}", e);
        }
    }

}


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
Return to top
Show: