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

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

Syntax

public Task<GridFSDownloadStream> OpenDownloadStreamAsync( TFileId id, GridFSDownloadOptions options = null, CancellationToken cancellationToken = null )

Public Function OpenDownloadStreamAsync ( id As TFileId, Optional options As GridFSDownloadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of GridFSDownloadStream(Of TFileId))

abstract OpenDownloadStreamAsync : id : 'TFileId * ?options : GridFSDownloadOptions * ?cancellationToken : CancellationToken (* Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null ) -> Task<GridFSDownloadStream<'TFileId>> override OpenDownloadStreamAsync : id : 'TFileId * ?options : GridFSDownloadOptions * ?cancellationToken : CancellationToken ( Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> Task<GridFSDownloadStream<'TFileId>>

Parameters

id

Type: TFileId
The file id.

options (Optional)

Type: MongoDB.Driver.GridFSGridFSDownloadOptions
The options.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskGridFSDownloadStreamTFileId
A Task whose result is a Stream.

Implements

IGridFSBucketTFileIdOpenDownloadStreamAsync(TFileId, GridFSDownloadOptions, CancellationToken)

See Also

Reference