---
name: "mongoc_client_encryption_add_key_alt_name"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_client_encryption_add_key_alt_name"
---

# mongoc\_client\_encryption\_add\_key\_alt\_name(3)

## SYNOPSIS

```
bool
mongoc_client_encryption_add_key_alt_name (
   mongoc_client_encryption_t *client_encryption,
   const bson_value_t *keyid,
   const char *keyaltname,
   bson_t *key_doc,
   bson_error_t *error);
```

Add **keyaltname** to the set of alternate names in the key document with UUID **keyid**.

## PARAMETERS

- •

  **client\_encryption**: A *mongoc\_client\_encryption\_t*.

- •

  **keyid**: A UUID (BSON binary subtype 0x04) key ID of the key to add the key alternate name to.

- •

  **keyaltname**: The key alternate name to add.

- •

  **key\_doc**: Optional. An uninitialized *bson\_t* set to the value of the key document before addition of the alternate name, or an empty document if the key does not exist. Must be freed by *bson\_destroy()*.

- •

  **error**: Optional. *bson\_error\_t*.

## RETURNS

Returns **true** if successful. Returns **false** and sets **error** otherwise.

**SEE ALSO:**

```
mongoc_client_encryption_t
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.