IGridFSBucketTFileIdDownloadToStreamAsync Method |
Downloads a file stored in GridFS and writes the contents to a stream.
Namespace:
MongoDB.Driver.GridFS
Assembly:
MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax Task DownloadToStreamAsync(
TFileId id,
Stream destination,
GridFSDownloadOptions options = null,
CancellationToken cancellationToken = default
)
Function DownloadToStreamAsync (
id As TFileId,
destination As Stream,
Optional options As GridFSDownloadOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract DownloadToStreamAsync :
id : 'TFileId *
destination : Stream *
?options : GridFSDownloadOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
Parameters
- id
- Type: TFileId
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