ParallelLoopState.Stop Method

Communicates that the Parallel loop should cease execution at the system's earliest convenience.

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)

public void Stop()

ExceptionCondition
InvalidOperationException

The Break method was previously called. Break and Stop may not be used in combination by iterations of the same loop.

Stop may be used to communicate to the loop that no other iterations need be run.

For long-running iterations that may already be executing, Stop causes IsStopped to return true for all other iterations of the loop, such that another iteration may check IsStopped and exit early if it's observed to be true.

Stop is typically employed in search-based algorithms, where once a result is found, no other iterations need be executed.

.NET Framework

Supported in: 4.5.2, 4.5.1, 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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft