---
name: "bson_append_minkey"
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_minkey"
---

# bson\_append\_minkey(3)

## SYNOPSIS

```
#define BSON_APPEND_MINKEY(b, key) \
   bson_append_minkey (b, key, (int) strlen (key))
bool
bson_append_minkey (bson_t *bson, const char *key, int key_length);
```

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

## DESCRIPTION

The *bson\_append\_minkey()* function shall append an element of type BSON\_TYPE\_MINKEY to a bson document. This is primarily used in queries and unlikely to be used when storing a document to MongoDB.

## RETURNS

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

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.