bson_iter_recurse man page

bson_iter_recurse — 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

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

Author

MongoDB, Inc

Info

Mar 07, 2017 1.6.1 Libbson