NAME

       bson_iter_find()  - The bson_iter_find()function shall advance iterto the element named keyor exhaust all
       elements of iter. If iteris exhausted, false is returned and itershould be considered invalid.

SYNOPSIS

       bool
       bson_iter_find (bson_iter_t *iter,
                       const char  *key);

PARAMETERS

       iter   A bson_iter_t \&.

       key    A string containing the requested key.

DESCRIPTION

       The bson_iter_find(3) function shall advance iter to the element named key or  exhaust  all  elements  of
       iter \&. If iter is exhausted, false is returned and iter should be considered invalid.

       key is case‐sensitive. For a case‐folded version, see bson_iter_find_case(3) \&.

RETURNS

       true  is returned if the requested key was found. If not, 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.