.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_FIND" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_iter_find \- bson_iter_find()
.
.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
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bool
bson_iter_find (bson_iter_t *iter, const char *key);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fBbson_iter_t\fP\&.
.IP \(bu 2
\fBkey\fP: A string containing the requested key.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_iter_find()\fP function shall advance \fBiter\fP to the element named \fBkey\fP or exhaust all elements of \fBiter\fP\&. If \fBiter\fP is exhausted, false is returned and \fBiter\fP should be considered invalid.
.sp
\fBkey\fP is case\-sensitive. For a case\-folded version, see \fBbson_iter_find_case()\fP\&.
.SH RETURNS
.sp
true is returned if the requested key was found. If not, \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.
.