---
name: "mongoc_gridfs_bucket_download_to_stream"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_gridfs_bucket_download_to_stream"
---

# mongoc\_gridfs\_bucket\_download\_to\_stream(3)

## SYNOPSIS

```
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);
```

## PARAMETERS

- •

  **bucket**: A *mongoc\_gridfs\_bucket\_t*.

- •

  **file\_id**: A *bson\_value\_t* of the id of the file to download.

- •

  **destination**: A *mongoc\_stream\_t* which receives data from the downloaded file.

- •

  **error**: A *bson\_error\_t* to receive any error or **NULL**.

## DESCRIPTION

Reads from the GridFS file and writes to the **destination** stream.

Writes the full contents of the file to the **destination** stream. The **destination** stream is not closed after calling *mongoc\_gridfs\_bucket\_download\_to\_stream()*; call *mongoc\_stream\_close()* after.

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 **retryreads** is false in the URI (see *mongoc\_uri\_t*) the retry behavior does not apply.

## RETURNS

True if the operation succeeded. False otherwise, and sets **error**.

**SEE ALSO:**

```
mongoc_stream_file_new() and mongoc_stream_file_new_for_path(), which can be used to create a destination stream from a file.
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.