Scroll to navigation

MONGOC_CLIENT_ENCRYPTION_GET_KEY_BY_ALT_NAME(3) libmongoc MONGOC_CLIENT_ENCRYPTION_GET_KEY_BY_ALT_NAME(3)

NAME

mongoc_client_encryption_get_key_by_alt_name - mongoc_client_encryption_get_key_by_alt_name()

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 set to the resulting key document, or an empty document if the key does not exist. Must be freed by bson_value_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

2017-present, MongoDB, Inc

August 31, 2022 1.23.0