table of contents
BSON_ITER_RECURSE(3) | Library Functions Manual | BSON_ITER_RECURSE(3) |
NAME¶
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 iterIf 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.2016‐10‐12 | libbson |