.\" Man page generated from reStructuredText.
.
.TH "MONGOC_CLIENT_GET_GRIDFS" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_client_get_gridfs \- mongoc_client_get_gridfs()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongoc_gridfs_t *
mongoc_client_get_gridfs (mongoc_client_t *client,
                          const char *db,
                          const char *prefix,
                          bson_error_t *error);
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBmongoc_client_get_gridfs()\fP function shall create a new \fBmongoc_gridfs_t\fP\&. The \fBdb\fP parameter is the name of the database which the gridfs instance should exist in. The \fBprefix\fP parameter corresponds to the gridfs collection namespacing; its default is "fs", thus the default GridFS collection names are "fs.files" and "fs.chunks".
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBclient\fP: A \fBmongoc_client_t\fP\&.
.IP \(bu 2
\fBdb\fP: The database name.
.IP \(bu 2
\fBprefix\fP: Optional prefix for gridfs collection names or \fBNULL\fP\&.
.IP \(bu 2
\fBerror\fP: An optional location for a \fBbson_error_t\fP or \fBNULL\fP\&.
.UNINDENT
.SH ERRORS
.sp
Errors are propagated via the \fBerror\fP parameter.
.SH RETURNS
.sp
On success, returns a \fBmongoc_gridfs_t\fP you must free with \fBmongoc_gridfs_destroy()\fP\&. Returns \fBNULL\fP upon failure and sets \fBerror\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.