manpages

mongoc_client_encryption_get_key_by_alt_name(3)

MONGOC_CLIENT_ENCRYPTION_GET_KEY_BY_ALT_NAME(3) libmongoc MONGOC_CLIENT_ENCRYPTION_GET_KEY_BY_ALT_NAME(3)

SYNOPSIS

bool
mongoc_client_encryption_get_key_by_alt_name (


   mongoc_client_encryption_t *client_encryption,


   const char *keyaltname,


   bson_value_t *key_doc,


   bson_error_t *error);


Get a key document in the key vault collection that has the given keyaltname.

PARAMETERS

  • client_encryption: A mongoc_client_encryption_t <>.
  • keyaltname: The key alternate name of the key to get.
  • key_doc: Optional. An uninitialized bson_t <https://www.mongoc.org/libbson/current/bson_t.html> set to the resulting key document, or an empty document if the key does not exist. Must be freed by bson_value_destroy() <https://www.mongoc.org/libbson/current/bson_value_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