Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# bson_iter_overwrite_bool()

## Synopsis

    void
    bson_iter_overwrite_bool (bson_iter_t *iter, bool value);

## Parameters

- `iter`: A bson_iter_t.

- `value`: A bool containing the new value.

## Description

The `bson_iter_overwrite_bool()` function shall overwrite the contents of a BSON_TYPE_BOOL element in place.

This may only be done when the underlying bson document allows mutation.

It is a programming error to call this function when `iter` is not observing an element of type BSON_TYPE_BOOL.