---
name: "bson_iter_code"
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_code"
---

# bson\_iter\_code(3)

## SYNOPSIS

```
#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);
```

## PARAMETERS

- •

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

- •

  **length**: A location for the length of the UTF-8 encoded string or NULL.

## DESCRIPTION

This function returns the contents of a BSON\_TYPE\_CODE field. The length of the string is stored in **length** if non-NULL.

It is invalid to call this function on a field that is not of type BSON\_TYPE\_CODE.

## RETURNS

A UTF-8 encoded string which should not be modified or freed.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.