GridFSBucketOpenDownloadStreamAsync Method (BsonValue, GridFSDownloadOptions, CancellationToken) |
Note: This API is now obsolete.
Opens a Stream that can be used by the application to read data from a GridFS file.
Namespace: MongoDB.Driver.GridFSAssembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.1.0
Syntax [ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")]
public Task<GridFSDownloadStream> OpenDownloadStreamAsync(
BsonValue id,
GridFSDownloadOptions options = null,
CancellationToken cancellationToken = null
)
<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>
Public Function OpenDownloadStreamAsync (
id As BsonValue,
Optional options As GridFSDownloadOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of GridFSDownloadStream)
[<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>]
member OpenDownloadStreamAsync :
id : BsonValue *
?options : GridFSDownloadOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<GridFSDownloadStream>
Parameters
- id
- Type: MongoDB.BsonBsonValue
The file id. - options (Optional)
- Type: MongoDB.Driver.GridFSGridFSDownloadOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskGridFSDownloadStreamA Task whose result is a Stream.
See Also