manpages

mongoc_gridfs_bucket_open_download_stream(3)

MONGOC_GRIDFS_BUCKET_OPEN_DOWNLOAD_STREAM(3) libmongoc MONGOC_GRIDFS_BUCKET_OPEN_DOWNLOAD_STREAM(3)

SYNOPSIS

mongoc_stream_t *
mongoc_gridfs_bucket_open_download_stream (mongoc_gridfs_bucket_t *bucket,


                                           const bson_value_t *file_id,


                                           bson_error_t *error);


PARAMETERS

  • bucket: A mongoc_gridfs_bucket_t <>.
  • file_id: A bson_value_t <https://www.mongoc.org/libbson/current/bson_value_t.html> of the id of the file to download.
  • error: A bson_error_t <https://www.mongoc.org/libbson/current/bson_error_t.html> to receive any error or NULL.

DESCRIPTION

Opens a stream for reading a file from GridFS.

RETURNS

A mongoc_stream_t <> that can be read from or NULL on failure. Errors on this stream can be retrieved with mongoc_gridfs_bucket_stream_error() <>.

See also:

mongoc_gridfs_bucket_stream_error() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

February 10, 2026 1.30.7