IAsyncCursorExtensionsFirstTDocument Method |
Returns the first document of a cursor.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public static TDocument First<TDocument>(
this IAsyncCursor<TDocument> cursor,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function First(Of TDocument) (
cursor As IAsyncCursor(Of TDocument),
Optional cancellationToken As CancellationToken = Nothing
) As TDocument
[<ExtensionAttribute>]
static member First :
cursor : IAsyncCursor<'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> '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:
TDocumentThe 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