MONGOC_CLIENT_...E_KEY_ALT_NAME(3)

📦
version 2.5.6 · 15 versions
, in epel 10

bestie, welcome to the libmongoc manual page for mongoc_client_encryption_remove_key_alt_name — the header spells it MONGOC_CLIENT_...E_KEY_ALT_NAME(3), and that ellipsis is main character energy. 💅✨

✨ SYNOPSIS ✨

bool
mongoc_client_encryption_remove_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);

okay so the vibe is: this function removes keyaltname from the set of keyAltNames in the key document with UUID keyid. it also removes the keyAltNames field from the key document if it would otherwise be empty — like, if that set would be left with nothing, the field itself gets ghosted too. 💨 no cap.

🎀 PARAMETERS 🎀

  • client_encryption — a mongoc_client_encryption_t. slay.
  • keyid — the UUID (BSON binary subtype 0x04) of the key you're removing the key alternate name from. periodt.
  • keyaltname — the key alternate name to remove. simple as that, bestie.
  • key_doc — optional. an uninitialized bson_t set to the value of the key document before removal of the key alternate name, or an empty document if the key does not exist. it must be freed by bson_value_destroy() — that's the rule, fr fr.
  • error — optional. a bson_error_t.

🔥 RETURNS 🔥

returns true if successful. returns false and sets error otherwise. that's the whole vibe check. ✅

👀 SEE ALSO 👀

  • mongoc_client_encryption_t

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

this page is from libmongoc version 2.5.6, footer date Oct 09, 202 — yes the last digit got clipped, and honestly same. bye bestie, go be iconic with your key alt names 💖✨🫶

📦 where this page comes from