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

GridFSBucketTFileIdOpenDownloadStream 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 GridFSDownloadStream OpenDownloadStream( TFileId id, GridFSDownloadOptions options = null, CancellationToken cancellationToken = null )

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

abstract OpenDownloadStream : id : 'TFileId * ?options : GridFSDownloadOptions * ?cancellationToken : CancellationToken (* Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null ) -> GridFSDownloadStream<'TFileId> override OpenDownloadStream : id : 'TFileId * ?options : GridFSDownloadOptions * ?cancellationToken : CancellationToken ( Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> 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: GridFSDownloadStreamTFileId
A Stream.

Implements

IGridFSBucketTFileIdOpenDownloadStream(TFileId, GridFSDownloadOptions, CancellationToken)

See Also

Reference