Click or drag to resize

IAsyncCursorExtensions.First<TDocument> Method

Returns the first document of a cursor.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntax
public static TDocument First<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = null
)

Parameters

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

Type Parameters

TDocument
The type of the document.

Return Value

Type: TDocument
The first document.

Usage Note

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