GridFSBucketTFileIdOpenDownloadStreamByNameAsync 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.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax public Task<GridFSDownloadStream<TFileId>> OpenDownloadStreamByNameAsync(
string filename,
GridFSDownloadByNameOptions options = null,
CancellationToken cancellationToken = default
)
Public Function OpenDownloadStreamByNameAsync (
filename As String,
Optional options As GridFSDownloadByNameOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of GridFSDownloadStream(Of TFileId))
abstract OpenDownloadStreamByNameAsync :
filename : string *
?options : GridFSDownloadByNameOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<GridFSDownloadStream<'TFileId>>
override OpenDownloadStreamByNameAsync :
filename : string *
?options : GridFSDownloadByNameOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<GridFSDownloadStream<'TFileId>>
Parameters
- filename
- Type: SystemString
The filename. - options (Optional)
- Type: MongoDB.Driver.GridFSGridFSDownloadByNameOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskGridFSDownloadStreamTFileIdA Task whose result is a Stream.
Implements
IGridFSBucketTFileIdOpenDownloadStreamByNameAsync(String, GridFSDownloadByNameOptions, CancellationToken)See Also