GridFSBucketTFileIdOpenDownloadStreamAsync Method |
Opens a Stream that can be used by the application to read data from a GridFS file.
Namespace:
MongoDB.Driver.GridFS
Assembly:
MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntax public Task<GridFSDownloadStream<TFileId>> OpenDownloadStreamAsync(
TFileId id,
GridFSDownloadOptions options = null,
CancellationToken cancellationToken = null
)
Public Function OpenDownloadStreamAsync (
id As TFileId,
Optional options As GridFSDownloadOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of GridFSDownloadStream(Of TFileId))
abstract OpenDownloadStreamAsync :
id : 'TFileId *
?options : GridFSDownloadOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<GridFSDownloadStream<'TFileId>>
override OpenDownloadStreamAsync :
id : 'TFileId *
?options : GridFSDownloadOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<GridFSDownloadStream<'TFileId>>
Parameters
- id
- Type: TFileId
The file id. - options (Optional)
- Type: MongoDB.Driver.GridFSGridFSDownloadOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskGridFSDownloadStreamTFileIdA Task whose result is a Stream.
Implements
IGridFSBucketTFileIdOpenDownloadStreamAsync(TFileId, GridFSDownloadOptions, CancellationToken)See Also