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

SYNOPSIS

6          bool
7          bson_iter_find_descendant (bson_iter_t *iter,
8                                     const char *dotkey,
9                                     bson_iter_t *descendant);
10

PARAMETERS

12       • iter: A bson_iter_t.
13
14       • dotkey: A dot-notation key like "a.b.c.d".
15
16       • descendant: A bson_iter_t.
17

DESCRIPTION

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

RETURNS

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

AUTHOR

29       MongoDB, Inc
30

32       2017-present, MongoDB, Inc
33
34
35
36
371.25.1                           Nov 08, 2023     BSON_ITER_FIND_DESCENDANT(3)
Impressum