CancellationTokenSource.CreateLinkedTokenSource Method (CancellationToken[])

July 28, 2014

Creates a CancellationTokenSource that will be in the canceled state when any of the source tokens are in the canceled state.

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

public static CancellationTokenSource CreateLinkedTokenSource(
	params CancellationToken[] tokens
)

Parameters

tokens
Type: System.Threading.CancellationToken []
The CancellationToken instances to observe.

Return Value

Type: System.Threading.CancellationTokenSource
A CancellationTokenSource that is linked to the source tokens.

ExceptionCondition
ObjectDisposedException

A CancellationTokenSource associated with one of the source tokens has been disposed.

ArgumentNullException

tokens is null.

ArgumentException

If any of the tokens cannot be canceled, they will not be linked. The returned source will be cancelable.

-or-

If any of the tokens are already canceled then the linked token will be returned in canceled state.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft