MongoQueryableFirstAsyncTSource Method (IMongoQueryableTSource, CancellationToken) |
Returns the first element of a sequence.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntax public static Task<TSource> FirstAsync<TSource>(
this IMongoQueryable<TSource> source,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FirstAsync(Of TSource) (
source As IMongoQueryable(Of TSource),
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TSource)
[<ExtensionAttribute>]
static member FirstAsync :
source : IMongoQueryable<'TSource> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<'TSource>
Parameters
- source
- Type: MongoDB.Driver.LinqIMongoQueryableTSource
The IMongoQueryableT to return the first element of. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
TaskTSource
The first element in
source.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoQueryableTSource. 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