bson_iter_find_descendant (3) - Linux Man Pages

bson_iter_find_descendant: The bson_iter_find_descendant() function shall follow standard MongoDB dot notation to recurse into subdocuments. descendant will be initialized and advanced to the descendant. If false is returned, both iter and descendant should be considered invalid.

NAME

bson_iter_find_descendant() - The bson_iter_find_descendant() function shall follow standard MongoDB dot notation to recurse into subdocuments. descendant will be initialized and advanced to the descendant. If false is returned, both iter and descendant should be considered invalid.

SYNOPSIS

bool
bson_iter_find_descendant (bson_iter_t *iter,
                           const char  *dotkey,
                           bson_iter_t *descendant);

PARAMETERS

iter
A bson_iter_t \&.

dotkey
A dot-notation key like a.b.c.d \&.

descendant
A bson_iter_t \&.

DESCRIPTION

The bson_iter_find_descendant(3) function shall follow standard MongoDB dot notation to recurse into subdocuments. descendant will be initialized and advanced to the descendant. If false is returned, both iter and descendant should be considered invalid.

RETURNS

true is returned if the requested key was found. If not, false is returned and iter was exhausted and should now be considered invalid.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.