GridFSBucketDownloadToStreamAsync Method (BsonValue, Stream, GridFSDownloadOptions, CancellationToken) |
Note: This API is now obsolete.
Downloads a file stored in GridFS and writes the contents to a stream.
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 DownloadToStreamAsync(
BsonValue id,
Stream destination,
GridFSDownloadOptions options = null,
CancellationToken cancellationToken = null
)
<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>
Public Function DownloadToStreamAsync (
id As BsonValue,
destination As Stream,
Optional options As GridFSDownloadOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task
[<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>]
member DownloadToStreamAsync :
id : BsonValue *
destination : Stream *
?options : GridFSDownloadOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
Parameters
- id
- Type: MongoDB.BsonBsonValue
The file id. - destination
- Type: System.IOStream
The destination. - options (Optional)
- Type: MongoDB.Driver.GridFSGridFSDownloadOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskA Task.
See Also