GridFSBucket.DownloadAsBytesAsync Method (BsonValue, GridFSDownloadOptions, CancellationToken)

GridFSBucketDownloadAsBytesAsync Method (BsonValue, GridFSDownloadOptions, CancellationToken)

Note: This API is now obsolete.

Downloads a file stored in GridFS and returns it as a byte array.

Namespace: MongoDB.Driver.GridFS
Assembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.2.0

Syntax

[ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")]
public Task<byte[]> DownloadAsBytesAsync(
	BsonValue id,
	GridFSDownloadOptions options = null,
	CancellationToken cancellationToken = null
)

<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>
Public Function DownloadAsBytesAsync ( 
	id As BsonValue,
	Optional options As GridFSDownloadOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Byte())

[<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>]
member DownloadAsBytesAsync : 
        id : BsonValue * 
        ?options : GridFSDownloadOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<byte[]>

Parameters

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

Return Value

Type: TaskByte
A Task whose result is a byte array containing the contents of the file stored in GridFS.

Reference

GridFSBucket Class

DownloadAsBytesAsync Overload

MongoDB.Driver.GridFS Namespace