.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_CODE" "3" "Feb 23, 2019" "1.14.0" "Libbson"
.SH NAME
bson_iter_code \- bson_iter_code()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#define BSON_ITER_HOLDS_CODE(iter) (bson_iter_type ((iter)) == BSON_TYPE_CODE)

const char *
bson_iter_code (const bson_iter_t *iter, uint32_t *length);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fBbson_iter_t\fP\&.
.IP \(bu 2
\fBlength\fP: A location for the length of the UTF\-8 encoded string or NULL.
.UNINDENT
.SH DESCRIPTION
.sp
This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in \fBlength\fP if non\-NULL.
.sp
It is invalid to call this function on a field that is not of type BSON_TYPE_CODE.
.SH RETURNS
.sp
A UTF\-8 encoded string which should not be modified or freed.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.