---
name: "bson_append_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_append_oid"
---

# bson\_append\_oid(3)

## SYNOPSIS

```
#define BSON_APPEND_OID(b, key, val) \
   bson_append_oid (b, key, (int) strlen (key), val)
bool
bson_append_oid (bson_t *bson,
                 const char *key,
                 int key_length,
                 const bson_oid_t *oid);
```

## PARAMETERS

- •

  **bson**: A *bson\_t*.

- •

  **key**: An ASCII C string containing the name of the field.

- •

  **key\_length**: The length of **key** in bytes, or -1 to determine the length with **strlen()**.

- •

  **oid**: A bson\_oid\_t.

## DESCRIPTION

The *bson\_append\_oid()* function shall append a new element to **bson** of type BSON\_TYPE\_OID. **oid** *MUST* be a pointer to a *bson\_oid\_t*.

## RETURNS

Returns **true** if the operation was applied successfully. The function will fail if appending **oid** grows **bson** larger than INT32\_MAX.

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.