.\" 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_AS_BOOL" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_as_bool() \- Fetches the current field as if it were a boolean.
.SH "SYNOPSIS"

.nf
.nf
bool
bson_iter_as_bool (const bson_iter_t *iter);
.fi
.fi

.SH "PARAMETERS"

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

.SH "DESCRIPTION"

Fetches the current field as if it were a boolean.

.B bson_iter_as_bool(3)
currently knows how to determine a boolean value from the following types:

.IP \[bu] 2
BSON_TYPE_BOOL
.IP \[bu] 2
BSON_TYPE_DOUBLE
.IP \[bu] 2
BSON_TYPE_INT32
.IP \[bu] 2
BSON_TYPE_INT64
.IP \[bu] 2
BSON_TYPE_NULL
.IP \[bu] 2
BSON_TYPE_UNDEFINED
.IP \[bu] 2
BSON_TYPE_UTF8

BSON_TYPE_UTF8 will always equate to
.B true
.

.SH "RETURNS"

true if the field equates to non\(hyzero.


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