PipelineDefinitionBuilder.Limit(TInput, TOutput) Method

PipelineDefinitionBuilderLimitTInput, TOutput Method

Appends a $limit stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.4.1

Syntax

public static PipelineDefinition<TInput, TOutput> Limit<TInput, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	int limit
)

<ExtensionAttribute>
Public Shared Function Limit(Of TInput, TOutput) ( 
	pipeline As PipelineDefinition(Of TInput, TOutput),
	limit As Integer
) As PipelineDefinition(Of TInput, TOutput)

[<ExtensionAttribute>]
static member Limit : 
        pipeline : PipelineDefinition<'TInput, 'TOutput> * 
        limit : int -> PipelineDefinition<'TInput, 'TOutput>

Parameters

pipeline: Type: MongoDB.DriverPipelineDefinitionTInput, TOutput
The pipeline.
limit: Type: SystemInt32
The limit.

Type Parameters

TInput: The type of the input documents.
TOutput: The type of the output documents.

Return Value

Type: PipelineDefinitionTInput, TOutput
A new pipeline with an additional stage.

Usage Note

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

PipelineDefinitionBuilder Class

MongoDB.Driver Namespace