IMongoCollectionExtensionsFindSyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, FilterDefinitionTDocument, FindOptionsTDocument, TDocument, CancellationToken) (original) (raw)

Finds the documents matching the filter.

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

Syntax

public static IAsyncCursor FindSync( this IMongoCollection collection, IClientSessionHandle session, FilterDefinition filter, FindOptions<TDocument, TDocument> options = null, CancellationToken cancellationToken = null )

Public Shared Function FindSync(Of TDocument) ( collection As IMongoCollection(Of TDocument), session As IClientSessionHandle, filter As FilterDefinition(Of TDocument), Optional options As FindOptions(Of TDocument, TDocument) = Nothing, Optional cancellationToken As CancellationToken = Nothing ) As IAsyncCursor(Of TDocument)

[] static member FindSync : collection : IMongoCollection<'TDocument> * session : IClientSessionHandle * filter : FilterDefinition<'TDocument> * ?options : FindOptions<'TDocument, 'TDocument> * ?cancellationToken : CancellationToken (* Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> IAsyncCursor<'TDocument>

Parameters

collection

Type: MongoDB.DriverIMongoCollectionTDocument
The collection.

session

Type: MongoDB.DriverIClientSessionHandle
The session.

filter

Type: MongoDB.DriverFilterDefinitionTDocument
The filter.

options (Optional)

Type: MongoDB.DriverFindOptionsTDocument, TDocument
The options.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument

The type of the document.

Return Value

Type: IAsyncCursorTDocument
A Task whose result is a cursor.

Usage Note

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

Reference