---
name: "mongoc_change_stream_next"
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_change_stream_next"
---

# mongoc\_change\_stream\_next(3)

## SYNOPSIS

```
bool
mongoc_change_stream_next (mongoc_change_stream_t *stream,
                           const bson_t **bson);
```

This function iterates the underlying cursor, setting **bson** to the next document. This will block for a maximum of **maxAwaitTimeMS** milliseconds as specified in the options when created, or the default timeout if omitted. Data may be returned before the timeout. If no data is returned this function returns **false**.

## PARAMETERS

- •

  **stream**: A *mongoc\_change\_stream\_t*.

- •

  **bson**: The location for the resulting document.

## RETURNS

This function returns true if a valid bson document was read from the stream. Otherwise, false if there was an error or no document was available.

Errors can be determined with the *mongoc\_change\_stream\_error\_document()* function.

## LIFECYCLE

Similar to *mongoc\_cursor\_next()* the lifetime of **bson** is until the next call to *mongoc\_change\_stream\_next()*, so it needs to be copied to extend the lifetime.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.