.\" 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_APPEND_BOOL" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_append_bool() \- The bson_append_bool() function shall append a new element to bson containing the boolean provided.
.SH "SYNOPSIS"

.nf
.nf
bool
bson_append_bool (bson_t     *bson,
                  const char *key,
                  int         key_length,
                  bool        value);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
bson
A
.B bson_t
.
.LP
.TP
.B
key
The name of the field.
.LP
.TP
.B
key_length
The length of
.B key
or \(hy1 to use strlen().
.LP
.TP
.B
value
true or false.
.LP

.SH "DESCRIPTION"

The
.B bson_append_bool(3)
function shall append a new element to
.B bson
containing the boolean provided.

.SH "RETURNS"

true if the operation was applied successfully, otherwise false and
.B bson
should be discarded.


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