IAsyncCursorSourceExtensions.First<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.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic static TDocument First<TDocument>(
this IAsyncCursorSource<TDocument> source,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function First(Of TDocument) (
source As IAsyncCursorSource(Of TDocument),
Optional cancellationToken As CancellationToken = Nothing
) As TDocument
[<ExtensionAttribute>]
static member First :
source : IAsyncCursorSource<'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TDocument
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:
TDocumentThe 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