- MongoDB C Driver 1.13.1 »
- API Reference »
- mongoc_change_stream_t

# mongoc_change_stream_error_document()

## Synopsis

    bool
    mongoc_change_stream_error_document (mongoc_change_stream_t *stream,
                                         bson_error_t *err,
                                         const bson_t **reply);

Checks if an error has occurred when creating or iterating over a change stream.

Similar to mongoc_cursor_error_document() if the error has occurred client-side then the `reply` will be set to an empty BSON document. If the error occurred server-side, `reply` is set to the server’s reply document.

## Parameters

- `stream`: A mongoc_change_stream_t.
- `err`: An optional location for a bson_error_t or `NULL`.
- `reply`: A location for a `bson_t`.

## Returns

A boolean indicating if there was an error.

Created using Sphinx 1.8.3, based on Sphinx Readable Theme.