1BSON_ITER_FIND_DESCENDANT(3)        libbson       BSON_ITER_FIND_DESCENDANT(3)
2
3
4

NAME

6       bson_iter_find_descendant - bson_iter_find_descendant()
7

SYNOPSIS

9          bool
10          bson_iter_find_descendant (bson_iter_t *iter,
11                                     const char *dotkey,
12                                     bson_iter_t *descendant);
13

PARAMETERS

15       • iter: A bson_iter_t.
16
17       • dotkey: A dot-notation key like "a.b.c.d".
18
19       • descendant: A bson_iter_t.
20

DESCRIPTION

22       The  bson_iter_find_descendant() function shall follow standard MongoDB
23       dot notation to recurse into subdocuments. descendant will be  initial‐
24       ized  and  advanced  to the descendant. If false is returned, both iter
25       and descendant should be considered invalid.
26

RETURNS

28       true is returned if the requested key was found. If not, false  is  re‐
29       turned and iter was exhausted and should now be considered invalid.
30

AUTHOR

32       MongoDB, Inc
33

35       2017-present, MongoDB, Inc
36
37
38
39
401.24.3                           Aug 17, 2023     BSON_ITER_FIND_DESCENDANT(3)
Impressum