ParallelOptions.CancellationToken Property

Definition

Namespace:

System.Threading.Tasks

Assembly:

System.Threading.Tasks.Parallel.dll

Source:

Parallel.cs

Gets or sets the CancellationToken associated with this ParallelOptions instance.

public:
 property System::Threading::CancellationToken CancellationToken { System::Threading::CancellationToken get(); void set(System::Threading::CancellationToken value); };

public System.Threading.CancellationToken CancellationToken { get; set; }

member this.CancellationToken : System.Threading.CancellationToken with get, set

Public Property CancellationToken As CancellationToken

Property Value

CancellationToken

The token that is associated with this instance.

Remarks

Providing a CancellationToken to a Parallel method enables the operation to be exited early. Code external to the operation may cancel the token, and if the operation observes the token being set, it may exit early by throwing an OperationCanceledException.