AsyncEnumerable<TResult>.ToListAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Query

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v2.0.3

Package:: Microsoft.EntityFrameworkCore v2.1.11

Package:: Microsoft.EntityFrameworkCore v2.2.6

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.

Asynchronously creates a List<T> from this AsyncEnumerable<TResult> by enumerating it asynchronously.

public System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>> ToListAsync (System.Threading.CancellationToken cancellationToken = default);

member this.ToListAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<'Result>>

Public Function ToListAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of List(Of TResult))

Parameters

cancellationToken: CancellationToken

A CancellationToken to observe while waiting for the task to complete.

Returns

Task<List<TResult>>

A task that represents the asynchronous operation. The task result contains a List<T> that contains elements from the input sequence.

Remarks

Multiple active operations on the same context instance are not supported. Use 'await' to ensure that any asynchronous operations have completed before calling another method on this context.

Applies to