.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_AS_DOUBLE" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_iter_as_double \- bson_iter_as_double()
.
.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_as_double (const bson_iter_t *iter);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fBbson_iter_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Fetches the current field as if it were a double.
.sp
\fBbson_iter_as_double()\fP will cast the following types to double
.INDENT 0.0
.IP \(bu 2
BSON_TYPE_BOOL
.IP \(bu 2
BSON_TYPE_DOUBLE
.IP \(bu 2
BSON_TYPE_INT32
.IP \(bu 2
BSON_TYPE_INT64
.UNINDENT
.sp
Any other value will return 0.
.SH RETURNS
.sp
The value type casted to double.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.