IAsyncCursorExtensions.FirstAsync(TDocument) Method (original) (raw)
IAsyncCursorExtensionsFirstAsyncTDocument Method
Returns the first document of a cursor.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
public static Task FirstAsync( this IAsyncCursor cursor, CancellationToken cancellationToken = null )
Public Shared Function FirstAsync(Of TDocument) ( cursor As IAsyncCursor(Of TDocument), Optional cancellationToken As CancellationToken = Nothing ) As Task(Of TDocument)[] static member FirstAsync : cursor : IAsyncCursor<'TDocument> * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken null *) -> Task<'TDocument>
Parameters
cursor
Type: MongoDB.DriverIAsyncCursorTDocument
The cursor.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
TDocument
The type of the document.
Return Value
Type: TaskTDocument
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 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).
See Also