.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "BSON_ITER_FIND_DESCENDANT" "3" "Apr 02, 2024" "1.26.2" "libbson"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
bson_iter_find_descendant (bson_iter_t *iter,
                           const char *dotkey,
                           bson_iter_t *descendant);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fI\%bson_iter_t\fP\&.
.IP \(bu 2
\fBdotkey\fP: A dot\-notation key like \fB\(dqa.b.c.d\(dq\fP\&.
.IP \(bu 2
\fBdescendant\fP: A \fI\%bson_iter_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fI\%bson_iter_find_descendant()\fP function shall follow standard MongoDB dot notation to recurse into subdocuments. \fBdescendant\fP will be initialized and advanced to the descendant. If false is returned, both \fBiter\fP and \fBdescendant\fP should be considered invalid.
.SH RETURNS
.sp
true is returned if the requested key was found. If not, false is returned and \fBiter\fP was exhausted and should now be considered invalid.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.