IAsyncEnumerable<T>.GetAsyncEnumerator(CancellationToken) Method

  • Reference

Definition

Namespace:
System.Collections.Generic
Assembly:
System.Runtime.dll
Assembly:
Microsoft.Bcl.AsyncInterfaces.dll
Assembly:
netstandard.dll
Package:
Microsoft.Bcl.AsyncInterfaces v9.0.0-rc.2.24473.5

Returns an enumerator that iterates asynchronously through the collection.

public System.Collections.Generic.IAsyncEnumerator<out T> GetAsyncEnumerator (System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsyncEnumerator : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerator<'T>
Public Function GetAsyncEnumerator (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerator(Of Out T)

Parameters

cancellationToken
CancellationToken

A CancellationToken that may be used to cancel the asynchronous iteration.

Returns

IAsyncEnumerator<T>

An enumerator that can be used to iterate asynchronously through the collection.

Applies to