IAsyncCursorExtensionsFirstOrDefaultTDocument Method

Returns the first document of a cursor, or a default value if the cursor contains no documents.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

Copy

public static TDocument FirstOrDefault<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = null
)

<ExtensionAttribute>
Public Shared Function FirstOrDefault(Of TDocument) ( 
	cursor As IAsyncCursor(Of TDocument),
	Optional cancellationToken As CancellationToken = Nothing
) As TDocument

[<ExtensionAttribute>]
static member FirstOrDefault : 
        cursor : IAsyncCursor<'TDocument> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> '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: TDocument
The first document of the cursor, or a default value if the cursor contains no documents.

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).

Reference

IAsyncCursorExtensions Class