bson_iter_find_descendant() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_iter_t

# bson_iter_find_descendant()

## Synopsis

    bool
    bson_iter_find_descendant (bson_iter_t *iter,
                               const char *dotkey,
                               bson_iter_t *descendant);

## Parameters

- `iter`: A bson_iter_t.
- `dotkey`: A dot-notation key like `"a.b.c.d"`.
- `descendant`: A bson_iter_t.

## Description

The bson_iter_find_descendant() function shall follow standard MongoDB dot notation to recurse into subdocuments. `descendant` will be initialized and advanced to the descendant. If false is returned, both `iter` and `descendant` should be considered invalid.

## Returns

true is returned if the requested key was found. If not, false is returned and `iter` was exhausted and should now be considered invalid.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.