Click or drag to resize

IAsyncCursorSourceExtensions.FirstAsync<TDocument> Method

Returns the first document of a cursor returned by a cursor source.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e
Syntax
public static Task<TDocument> FirstAsync<TDocument>(
	this IAsyncCursorSource<TDocument> source,
	CancellationToken cancellationToken = null
)

Parameters

source
Type: MongoDB.Driver.IAsyncCursorSource<TDocument>
The source.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: Task<TDocument>
A Task whose result is the first document.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncCursorSource<TDocument>. 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).
See Also