---
name: "bson_iter_symbol"
section: "3"
platform: "linux"
package: "libbson-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/bson_iter_symbol"
---

# bson\_iter\_symbol(3)

## SYNOPSIS

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

## PARAMETERS

- •

  **iter**: A *bson\_iter\_t*.

- •

  **length**: A uint32\_t.

## 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.

## RETURNS

The symbol and **length** is set.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.