ConfiguredCancelableAsyncEnumerable<T>.WithCancellation Method

Reference

Definition

Namespace:: System.Runtime.CompilerServices

Assembly:: System.Runtime.dll

Assembly:: System.Threading.Tasks.dll

Assembly:: Microsoft.Bcl.AsyncInterfaces.dll

Assembly:: netstandard.dll

Package:: Microsoft.Bcl.AsyncInterfaces v9.0.0

Source:: ConfiguredCancelableAsyncEnumerable.cs

Source:: ConfiguredCancelableAsyncEnumerable.cs

Source:: ConfiguredCancelableAsyncEnumerable.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the CancellationToken to be passed to GetAsyncEnumerator(CancellationToken) when iterating.

public:
 System::Runtime::CompilerServices::ConfiguredCancelableAsyncEnumerable<T> WithCancellation(System::Threading::CancellationToken cancellationToken);

public System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable<T> WithCancellation (System.Threading.CancellationToken cancellationToken);

member this.WithCancellation : System.Threading.CancellationToken -> System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable<'T>

Public Function WithCancellation (cancellationToken As CancellationToken) As ConfiguredCancelableAsyncEnumerable(Of T)

Parameters

cancellationToken: CancellationToken

The CancellationToken to use.

Returns

ConfiguredCancelableAsyncEnumerable<T>

The configured enumerable.

Remarks

This will replace any previous CancellationToken set by WithCancellation(CancellationToken) for this iteration.

Applies to

Jaa