.\" 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_RECURSE" "3" "Feb 22, 2024" "1.26.0" "libbson"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fI\%bson_iter_t\fP\&.
.IP \(bu 2
\fBchild\fP: A \fI\%bson_iter_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fI\%bson_iter_recurse()\fP function shall initialize \fBchild\fP using the embedded document or array currently observed by \fBiter\fP\&.
.sp
If there was a failure to initialize the \fBiter\fP, false is returned and both \fBiter\fP and \fBchild\fP should be considered invalid.
.sp
This should only be called when observing an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.
.SH RETURNS
.sp
If \fBiter\fP observes an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT, then \fBchild\fP is initialized and the function returns \fBtrue\fP\&. Otherwise, the function returns \fBfalse\fP and \fBchild\fP is invalid.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.