SYNOPSIS

#include <bson.h>

#define BSON_ITER_HOLDS_SYMBOL(iter) \
   (bson_iter_type ((iter)) == BSON_TYPE_SYMBOL)

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

DESCRIPTION

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

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

if non-NULL, length will be set to the length of the resulting string.

RETURN VALUE

The symbol and length is set.

ERRORS

No errors are defined.

SEE ALSO

AUTHORS

This page was written by MongoDB, Inc.