Export (0) Print
Expand All

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.

System.Object
  System.Threading.Tasks.ParallelLoopState

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

[DebuggerDisplayAttribute("ShouldExitCurrentIteration = {ShouldExitCurrentIteration}")]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public class ParallelLoopState

The ParallelLoopState type exposes the following members.

  NameDescription
Public propertySupported by Portable Class LibraryIsExceptionalGets whether any iteration of the loop has thrown an exception that went unhandled by that iteration.
Public propertySupported by Portable Class LibraryIsStoppedGets whether any iteration of the loop has called Stop.
Public propertySupported by Portable Class LibraryLowestBreakIterationGets the lowest iteration of the loop from which Break was called.
Public propertySupported by Portable Class LibraryShouldExitCurrentIterationGets whether the current iteration of the loop should exit based on requests made by this or other iterations.
Top

  NameDescription
Public methodSupported by Portable Class LibraryBreakCommunicates that the Parallel loop should cease execution at the system's earliest convenience of iterations beyond the current iteration.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryStopCommunicates that the Parallel loop should cease execution at the system's earliest convenience.
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

NoteNote

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.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

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.

Show:
© 2015 Microsoft