---
name: "bson_iter_oid"
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_oid"
---

# bson\_iter\_oid(3)

## SYNOPSIS

```
#define BSON_ITER_HOLDS_OID(iter) (bson_iter_type ((iter)) == BSON_TYPE_OID)
const bson_oid_t *
bson_iter_oid (const bson_iter_t *iter);
```

## PARAMETERS

- •

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

## DESCRIPTION

Fetches the *bson\_oid\_t* for a BSON\_TYPE\_OID element. You should verify it is an element of type BSON\_TYPE\_OID before calling this function.

## RETURNS

A *bson\_oid\_t* that should not be modified or freed.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.