IGridFSBucket.OpenDownloadStream Method

IGridFSBucketOpenDownloadStream 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.2.0

Syntax

GridFSDownloadStream OpenDownloadStream(
	ObjectId id,
	GridFSDownloadOptions options = null,
	CancellationToken cancellationToken = null
)

Function OpenDownloadStream ( 
	id As ObjectId,
	Optional options As GridFSDownloadOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As GridFSDownloadStream

abstract OpenDownloadStream : 
        id : ObjectId * 
        ?options : GridFSDownloadOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> GridFSDownloadStream

Parameters

id: Type: MongoDB.BsonObjectId
The file id.
options (Optional): Type: MongoDB.Driver.GridFSGridFSDownloadOptions
The options.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: GridFSDownloadStream
A Stream.

Reference

IGridFSBucket Interface

MongoDB.Driver.GridFS Namespace