This topic has not yet been rated - Rate this topic

ParallelLoopState.ShouldExitCurrentIteration Property

Gets whether the current iteration of the loop should exit based on requests made by this or other iterations.

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)
public bool ShouldExitCurrentIteration { get; }

Property Value

Type: System.Boolean
true if the current iteration should exit; otherwise false.

When an iteration of a loop calls Break or Stop, or when one throws an exception, or when the loop is canceled, the Parallel class will proactively attempt to prohibit additional iterations of the loop from starting execution.

However, there may be cases where it is unable to prevent additional iterations from starting.

It may also be the case that a long-running iteration has already begun execution. In such cases, iterations may explicitly check the ShouldExitCurrentIteration property and cease execution if the property returns true.

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.