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

GridFSBucketTFileIdOpenDownloadStreamByName 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 OpenDownloadStreamByName( string filename, GridFSDownloadByNameOptions options = null, CancellationToken cancellationToken = null )

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

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

Implements

IGridFSBucketTFileIdOpenDownloadStreamByName(String, GridFSDownloadByNameOptions, CancellationToken)

See Also

Reference