IGridFSBucket(TFileId).OpenDownloadStreamByNameAsync Method

IGridFSBucketTFileIdOpenDownloadStreamByNameAsync 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.4.1

Syntax

Task<GridFSDownloadStream<TFileId>> OpenDownloadStreamByNameAsync(
	string filename,
	GridFSDownloadByNameOptions options = null,
	CancellationToken cancellationToken = null
)

Function OpenDownloadStreamByNameAsync ( 
	filename As String,
	Optional options As GridFSDownloadByNameOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of GridFSDownloadStream(Of TFileId))

abstract OpenDownloadStreamByNameAsync : 
        filename : string * 
        ?options : GridFSDownloadByNameOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<GridFSDownloadStream<'TFileId>>

Parameters

filename: Type: SystemString
The filename.
options (Optional): Type: MongoDB.Driver.GridFSGridFSDownloadByNameOptions
The options.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskGridFSDownloadStreamTFileId
A Task whose result is a Stream.

Reference

IGridFSBucketTFileId Interface

MongoDB.Driver.GridFS Namespace