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)

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization := True,  _
	ExternalThreading := True)> _
Public Class ParallelLoopState

The ParallelLoopState type exposes the following members.

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsIsExceptionalGets whether any iteration of the loop has thrown an exception that went unhandled by that iteration.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsIsStoppedGets whether any iteration of the loop has called Stop.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsLowestBreakIterationGets the lowest iteration of the loop from which Break was called.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsShouldExitCurrentIterationGets 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 LibrarySupported in .NET for Windows Store appsBreakCommunicates that the Parallel loop should cease execution at the system's earliest convenience of iterations beyond the current iteration.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows 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 LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsStopCommunicates that the Parallel loop should cease execution at the system's earliest convenience.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns 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.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.

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:
© 2014 Microsoft