IAggregateFluentExtensionsFirstTResult Method

Returns the first document of the aggregate result.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e

Syntax

Copy

public static TResult First<TResult>(
	this IAggregateFluent<TResult> aggregate,
	CancellationToken cancellationToken = null
)

<ExtensionAttribute>
Public Shared Function First(Of TResult) ( 
	aggregate As IAggregateFluent(Of TResult),
	Optional cancellationToken As CancellationToken = Nothing
) As TResult

[<ExtensionAttribute>]
static member First : 
        aggregate : IAggregateFluent<'TResult> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TResult

Parameters

aggregate: Type: MongoDB.DriverIAggregateFluentTResult
The aggregate.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TResult: The type of the result.

Return Value

Type: TResult
The fluent aggregate interface.

Usage Note

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

IAggregateFluentExtensions Class