.\" Man page generated from reStructuredText.
.
.TH "MONGOC_GRIDFS_BUCKET_DOWNLOAD_TO_STREAM" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_gridfs_bucket_download_to_stream \- mongoc_gridfs_bucket_download_to_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
bool
mongoc_gridfs_bucket_download_to_stream (mongoc_gridfs_bucket_t *bucket,
                                         const bson_value_t *file_id,
                                         mongoc_stream_t *destination,
                                         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
\fBfile_id\fP: A \fI\%bson_value_t\fP of the id of the file to download.
.IP \(bu 2
\fBdestination\fP: A \fBmongoc_stream_t\fP which receives data from the downloaded file.
.IP \(bu 2
\fBerror\fP: A \fI\%bson_error_t\fP to receive any error or \fBNULL\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Reads from the GridFS file and writes to the \fBdestination\fP stream.
.sp
Writes the full contents of the file to the \fBdestination\fP stream.
The \fBdestination\fP stream is not closed after calling \fBmongoc_gridfs_bucket_download_to_stream()\fP; call \fBmongoc_stream_close()\fP after.
.sp
This function is considered a retryable read operation.
Upon a transient error (a network error, errors due to replica set failover, etc.) the operation is safely retried once.
If \fBretryreads\fP is false in the URI (see \fBmongoc_uri_t\fP) the retry behavior does not apply.
.SH SEE ALSO
.sp
\fBmongoc_stream_file_new\fP and \fBmongoc_stream_file_new_for_path\fP, which can be used to create a destination stream from a file.
.SH RETURNS
.sp
True if the operation succeeded. False otherwise, and sets \fBerror\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.