---
name: "mongoc_gridfs_find_one_with_opts"
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_find_one_with_opts"
---

# mongoc\_gridfs\_find\_one\_with\_opts(3)

## SYNOPSIS

```
mongoc_gridfs_file_t *
mongoc_gridfs_find_one_with_opts (mongoc_gridfs_t *gridfs,
                                  const bson_t *filter,
                                  const bson_t *opts,
                                  bson_error_t *error);
```

## PARAMETERS

- •

  **gridfs**: A *mongoc\_gridfs\_t*.

- •

  **filter**: A *bson\_t* containing the query to execute.

- •

  **opts**: A *bson\_t* query options, including sort order and which fields to return. Can be **NULL**.

- •

  **error**: An optional location for a *bson\_error\_t* or **NULL**.

## DESCRIPTION

Find the first GridFS file matching **filter**. If there is an error, NULL is returned and **error** is filled out; if there is no error but no matching file is found, NULL is returned and the error code and domain are 0.

See *mongoc\_collection\_find\_with\_opts()* for a description of the **filter** and **opts** parameters.

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.

## ERRORS

Errors are propagated via the **error** parameter.

## RETURNS

Returns a newly allocated *mongoc\_gridfs\_file\_t* if successful. You must free the resulting file with *mongoc\_gridfs\_file\_destroy()* when no longer in use.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.
