GridFSBucket(TFileId).DownloadToStreamAsync Method (original) (raw)

GridFSBucketTFileIdDownloadToStreamAsync 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.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public Task DownloadToStreamAsync( TFileId id, Stream destination, GridFSDownloadOptions options = null, CancellationToken cancellationToken = null )

Public 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 null ) -> Task override DownloadToStreamAsync : id : 'TFileId * destination : Stream * ?options : GridFSDownloadOptions * ?cancellationToken : CancellationToken ( Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> 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: Task
A Task.

Implements

IGridFSBucketTFileIdDownloadToStreamAsync(TFileId, Stream, GridFSDownloadOptions, CancellationToken)

See Also

Reference