bson_iter_recurse() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_iter_t

# bson_iter_recurse()

## Synopsis

    bool
    bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);

## Parameters

- `iter`: A bson_iter_t.
- `child`: A bson_iter_t.

## Description

The bson_iter_recurse() function shall initialize `child` using the embedded document or array currently observed by `iter`.

If there was a failure to initialize the `iter`, false is returned and both `iter` and `child` should be considered invalid.

This should only be called when observing an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.

## Returns

If `iter` observes an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT, then `child` is initialized and the function returns `true`. Otherwise, the function returns `false` and `child` is invalid.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.