.\" 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_BOOL" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_bool() \- The bson_iter_bool()function shall return the boolean value of a BSON_TYPE_BOOL element. It is a programming error to call this function on an element other than BSON_TYPE_BOOL. You can check this with bson_iter_type() or BSON_ITER_HOLDS_BOOL().
.SH "SYNOPSIS"

.nf
.nf
#define BSON_ITER_HOLDS_BOOL(iter) \e
   (bson_iter_type ((iter)) == BSON_TYPE_BOOL)

bool
bson_iter_bool (const bson_iter_t *iter);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
iter
A
.B bson_iter_t
.
.LP

.SH "DESCRIPTION"

The
.B bson_iter_bool(3)
function shall return the boolean value of a BSON_TYPE_BOOL element. It is a programming error to call this function on an element other than BSON_TYPE_BOOL. You can check this with
.B bson_iter_type(3)
or
.B BSON_ITER_HOLDS_BOOL(3)
.

.SH "RETURNS"

Either
.B true
or
.B false
.


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