.\" 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_SYMBOL" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_symbol() \- The symbol element type is DEPRECATED in the bson specification at http://bsonspec.org.
.SH "SYNOPSIS"

.nf
.nf
const char *
bson_iter_symbol (const bson_iter_t *iter,
                  uint32_t          *length);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
iter
A
.B bson_iter_t
.
.LP
.TP
.B
length
A uint32_t.
.LP

.SH "DESCRIPTION"

The symbol element type is
.B DEPRECATED
in the bson specification at http://bsonspec.org.

The
.B bson_iter_symbol(3)
function shall return the contents of a BSON_TYPE_SYMBOL element.

if non\(hyNULL,
.B length
will be set to the length of the resulting string.

.SH "RETURNS"

The symbol and
.B length
is set.


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