.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "BSON_ITER_OVERWRITE_DOUBLE" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_overwrite_double() \- The bson_iter_overwrite_double() function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place.
.SH "SYNOPSIS"

.nf
.nf
void
bson_iter_overwrite_double (bson_iter_t *iter,
                            double       value);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
iter
A
.B bson_iter_t
.
.LP
.TP
.B
value
The new double value.
.LP

.SH "DESCRIPTION"

The
.B bson_iter_overwrite_double(3)
function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place.

This may only be done when the underlying bson document allows mutation.

It is a programming error to call this function when
.B iter
is not obvserving an element of type BSON_TYPE_DOUBLE.


.B
.SH COLOPHON
This page is part of libbson.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.