mongoc_client_get_gridfs man page

mongoc_client_get_gridfs() — None

Synopsis

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(3) function shall create a new mongoc_gridfs_t 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".

Parameters

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

Errors are propagated via the error parameter.

Returns

A mongoc_gridfs_t on success, NULL upon failure and error is set.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐20 MongoDB C Driver