manpages

mongoc_client_encryption_add_key_alt_name(3)

MONGOC_CLIENT_ENCRYPTION_ADD_KEY_ALT_NAME(3) libmongoc 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 <https://www.mongoc.org/libbson/current/bson_t.html> 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() <https://www.mongoc.org/libbson/current/bson_destroy.html>.
  • error: Optional. bson_error_t <https://www.mongoc.org/libbson/current/bson_error_t.html>.

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.

February 10, 2026 1.30.7