.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_SYMBOL" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_iter_symbol \- bson_iter_symbol()
.
.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
const char *
bson_iter_symbol (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 uint32_t.
.UNINDENT
.SH DESCRIPTION
.sp
The symbol element type is \fIDEPRECATED\fP in the bson specification at \fI\%http://bsonspec.org\fP\&.
.sp
The \fBbson_iter_symbol()\fP function shall return the contents of a BSON_TYPE_SYMBOL element.
.sp
If non\-NULL, \fBlength\fP will be set to the length of the resulting string.
.SH RETURNS
.sp
The symbol and \fBlength\fP is set.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.