DOKK / manpages / debian 10 / libmongoc-doc / mongoc_client_get_gridfs.3.en
MONGOC_CLIENT_GET_GRIDFS(3) MongoDB C Driver MONGOC_CLIENT_GET_GRIDFS(3)

mongoc_client_get_gridfs - mongoc_client_get_gridfs()

mongoc_gridfs_t *
mongoc_client_get_gridfs (mongoc_client_t *client,


                          const char *db,


                          const char *prefix,


                          bson_error_t *error);


The mongoc_client_get_gridfs() function shall create a new mongoc_gridfs_t. The db parameter is the name of the database which the gridfs instance should exist in. The prefix parameter corresponds to the gridfs collection namespacing; its default is "fs", thus the default GridFS collection names are "fs.files" and "fs.chunks".

  • client: A mongoc_client_t.
  • db: The database name.
  • prefix: Optional prefix for gridfs collection names or NULL.
  • error: An optional location for a bson_error_t or NULL.

Errors are propagated via the error parameter.

On success, returns a mongoc_gridfs_t you must free with mongoc_gridfs_destroy(). Returns NULL upon failure and sets error.

MongoDB, Inc

2017-present, MongoDB, Inc

February 23, 2019 1.14.0