---
name: "bson_append_dbpointer"
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_dbpointer"
---

# bson\_append\_dbpointer(3)

## SYNOPSIS

```
#define BSON_APPEND_DBPOINTER(b, key, coll, oid) \
   bson_append_dbpointer (b, key, (int) strlen (key), coll, oid)
bool
bson_append_dbpointer (bson_t *bson,
                       const char *key,
                       int key_length,
                       const char *collection,
                       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()**.

- •

  **collection**: The target collection name.

- •

  **oid**: The target document identifier.

## DESCRIPTION

**WARNING:**

The dbpointer field type is *DEPRECATED* and should only be used when interacting with legacy systems.

## RETURNS

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

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.
