1BSON_ITER_RECURSE(3)                libbson               BSON_ITER_RECURSE(3)
2
3
4

NAME

6       bson_iter_recurse - bson_iter_recurse()
7

SYNOPSIS

9          bool
10          bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);
11

PARAMETERS

13       • iter: A bson_iter_t.
14
15       • child: A bson_iter_t.
16

DESCRIPTION

18       The  bson_iter_recurse()  function shall initialize child using the em‐
19       bedded document or array currently observed by iter.
20
21       If there was a failure to initialize the iter, false  is  returned  and
22       both iter and child should be considered invalid.
23
24       This   should  only  be  called  when  observing  an  element  of  type
25       BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.
26

RETURNS

28       If iter observes an element of type BSON_TYPE_ARRAY or  BSON_TYPE_DOCU‐
29       MENT,  then  child is initialized and the function returns true. Other‐
30       wise, the function returns false and child is invalid.
31

AUTHOR

33       MongoDB, Inc
34

36       2017-present, MongoDB, Inc
37
38
39
40
411.17.6                           Jun 03, 2021             BSON_ITER_RECURSE(3)
Impressum