IAsyncCursorExtensionsToListTDocument Method

Returns a list containing all the documents returned by a cursor.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa

Syntax

Copy

public static List<TDocument> ToList<TDocument>(
	this IAsyncCursor<TDocument> source,
	CancellationToken cancellationToken = null
)

<ExtensionAttribute>
Public Shared Function ToList(Of TDocument) ( 
	source As IAsyncCursor(Of TDocument),
	Optional cancellationToken As CancellationToken = Nothing
) As List(Of TDocument)

[<ExtensionAttribute>]
static member ToList : 
        source : IAsyncCursor<'TDocument> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> List<'TDocument>

Parameters

source: Type: MongoDB.DriverIAsyncCursorTDocument
The source.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument: The type of the document.

Return Value

Type: ListTDocument
The list of documents.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncCursorTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

IAsyncCursorExtensions Class