NAME

bson_iter_as_bool() - Fetches the current field as if it were a boolean.

SYNOPSIS

bool
bson_iter_as_bool (const bson_iter_t *iter);

PARAMETERS

iter
A bson_iter_t \&.

DESCRIPTION

Fetches the current field as if it were a boolean.

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

\[bu]
BSON_TYPE_BOOL
\[bu]
BSON_TYPE_DOUBLE
\[bu]
BSON_TYPE_INT32
\[bu]
BSON_TYPE_INT64
\[bu]
BSON_TYPE_NULL
\[bu]
BSON_TYPE_UNDEFINED
\[bu]
BSON_TYPE_UTF8

BSON_TYPE_UTF8 will always equate to true \&.

RETURNS

true if the field equates to non-zero.

COLOPHON

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