.\" Man page generated from reStructuredText.
.
.TH "MONGOC_GRIDFS_BUCKET_OPEN_UPLOAD_STREAM" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_gridfs_bucket_open_upload_stream \- mongoc_gridfs_bucket_open_upload_stream()
.
.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_stream_t *
mongoc_gridfs_bucket_open_upload_stream (mongoc_gridfs_bucket_t *bucket,
                                         const char *filename,
                                         const bson_t *opts,
                                         bson_value_t *file_id,
                                         bson_error_t *error);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbucket\fP: A \fBmongoc_gridfs_bucket_t\fP\&.
.IP \(bu 2
\fBfilename\fP: The name of the file to create.
.IP \(bu 2
\fBopts\fP: A \fI\%bson_t\fP or \fBNULL\fP\&.
.IP \(bu 2
\fBfile_id\fP: A \fI\%bson_value_t\fP to receive the generated id of the file or \fBNULL\fP\&.
.IP \(bu 2
\fBerror\fP: A \fI\%bson_error_t\fP to receive any error or \fBNULL\fP\&.
.UNINDENT
.sp
\fBopts\fP may be NULL or a BSON document with additional command options:
.INDENT 0.0
.IP \(bu 2
\fBchunkSizeBytes\fP: An \fBint32\fP chunk size to use for this file. Overrides the \fBchunkSizeBytes\fP set on \fBbucket\fP\&.
.IP \(bu 2
\fBmetadata\fP: A \fI\%bson_t\fP representing metadata to include with the file.
.UNINDENT
.SH DESCRIPTION
.sp
Opens a stream for writing to a new file in GridFS. The file id is generated automatically.
To specify an explicit file id, use \fBmongoc_gridfs_bucket_open_upload_stream_with_id()\fP\&.
.SH SEE ALSO
.sp
\fBmongoc_gridfs_bucket_open_upload_stream_with_id()\fP
.sp
\fBmongoc_gridfs_bucket_stream_error()\fP
.SH RETURNS
.sp
A \fBmongoc_stream_t\fP that can be written to or \fBNULL\fP on failure. Errors on this stream can be retrieved with \fBmongoc_gridfs_bucket_stream_error\fP\&. After calling \fBmongoc_stream_close\fP the file is completely written in GridFS.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.