.\" 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_TYPE" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_type() \- The bson_iter_type() function shall return the type of the observed element in a bson document.
.SH "SYNOPSIS"

.nf
.nf
typedef enum
{
   BSON_TYPE_EOD           = 0x00,
   BSON_TYPE_DOUBLE        = 0x01,
   BSON_TYPE_UTF8          = 0x02,
   BSON_TYPE_DOCUMENT      = 0x03,
   BSON_TYPE_ARRAY         = 0x04,
   BSON_TYPE_BINARY        = 0x05,
   BSON_TYPE_UNDEFINED     = 0x06,
   BSON_TYPE_OID           = 0x07,
   BSON_TYPE_BOOL          = 0x08,
   BSON_TYPE_DATE_TIME     = 0x09,
   BSON_TYPE_NULL          = 0x0A,
   BSON_TYPE_REGEX         = 0x0B,
   BSON_TYPE_DBPOINTER     = 0x0C,
   BSON_TYPE_CODE          = 0x0D,
   BSON_TYPE_SYMBOL        = 0x0E,
   BSON_TYPE_CODEWSCOPE    = 0x0F,
   BSON_TYPE_INT32         = 0x10,
   BSON_TYPE_TIMESTAMP     = 0x11,
   BSON_TYPE_INT64         = 0x12,
   BSON_TYPE_MAXKEY        = 0x7F,
   BSON_TYPE_MINKEY        = 0xFF,
} bson_type_t;

bson_type_t
bson_iter_type (const bson_iter_t *iter);
.fi
.fi

.SH "PARAMETERS"

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

.SH "DESCRIPTION"

The
.B bson_iter_type(3)
function shall return the type of the observed element in a bson document.

.SH "RETURNS"

A
.B bson_type_t
.


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