---
name: "bson_append_array"
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_array"
---

# bson\_append\_array(3)

## SYNOPSIS

```
#define BSON_APPEND_ARRAY(b, key, val) \
   bson_append_array (b, key, (int) strlen (key), val)
bool
bson_append_array (bson_t *bson,
                   const char *key,
                   int key_length,
                   const bson_t *array);
```

## 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()**.

- •

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

## DESCRIPTION

The *bson\_append\_array()* function shall append **array** to **bson** using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of **array** are properly formatted with string keys such as "0", "1", "2" and so forth.

## RETURNS

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

**SEE ALSO:**

```
bson_array_builder_t
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.