ParallelLoopResult Struct

Definition

Provides completion status on the execution of a Parallel loop.

public value class ParallelLoopResult
public struct ParallelLoopResult
type ParallelLoopResult = struct
Public Structure ParallelLoopResult
Inheritance
ParallelLoopResult

Remarks

If IsCompleted returns true, then the loop ran to completion, such that all iterations of the loop were executed. If IsCompleted returns false and LowestBreakIteration returns null, a call to Stop was used to end the loop prematurely. If IsCompleted returns false and LowestBreakIteration returns a non-null integral value, Break was used to end the loop prematurely.

Properties

IsCompleted

Gets whether the loop ran to completion, such that all iterations of the loop were executed and the loop didn't receive a request to end prematurely.

LowestBreakIteration

Gets the index of the lowest iteration from which Break() was called.

Applies to

Thread Safety

All public members of ParallelLoopResult are thread safe and may be called from multiple threads concurrently.

See also