bson_iter_recurse man page

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

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(3) 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

true if child has been intialized. Otherwise, child should be considered invalid.

Colophon

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Referenced By

bson_parsing(3).

2016‐11‐12 libbson