This documentation is archived and is not being maintained.

ParallelLoopState Class

Enables iterations of Parallel loops to interact with other iterations. An instance of this class is provided by the Parallel class to each loop; you can not create instances in your user code.


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

[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public class ParallelLoopState

The ParallelLoopState type exposes the following members.

Public propertyIsExceptionalGets whether any iteration of the loop has thrown an exception that went unhandled by that iteration.
Public propertyIsStoppedGets whether any iteration of the loop has called Stop.
Public propertyLowestBreakIterationGets the lowest iteration of the loop from which Break was called.
Public propertyShouldExitCurrentIterationGets whether the current iteration of the loop should exit based on requests made by this or other iterations.

Public methodBreakCommunicates that the Parallel loop should cease execution at the system's earliest convenience of iterations beyond the current iteration.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStopCommunicates that the Parallel loop should cease execution at the system's earliest convenience.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

A ParallelLoopState instance is meant to be used only within the body of the loop to which an instance was provided. It is not safe to use a provided ParallelLoopState instance after the associated loop ends, nor is it safe to explicitly hand it off to other threads and have those threads access it at any time. A different ParallelLoopState instance will be provided to each thread involved in a loop.