MONGOC_CLIENT_...EY_BY_ALT_NAME(3)

📦
version 2.5.6 · 15 versions
, in epel 10

💅 MONGOC_CLIENT_...EY_BY_ALT_NAME(3)

okay so bestie, this is MONGOC_CLIENT_...EY_BY_ALT_NAME(3) straight out of the libmongoc manual, and we're gonna get you fluent in it, no cap 🫶

✨ 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);

That's the whole vibe. One function, four arguments, returns a bool. Iconic of her honestly 👑

🌸 DESCRIPTION 🌸

So what does it do? It gets a key document in the key vault collection that has the given keyaltname. That's the entire job. She looks it up by alternate name, periodt 💅

🎀 PARAMETERS 🎀

  • client_encryption — a mongoc_client_encryption_t. You know her, you love her, she's your encryption bestie.
  • keyaltname — the key alternate name of the key to get. Like the nickname you saved your key under 🔑
  • 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(). Yeah, the description says bson_t — that's literally what the page says, we're not editing her 👀
  • error — Optional. A bson_error_t. For when things go sideways, which they won't, but like, she's there 🌸

🦋 RETURNS 🦋

Returns true if successful. Returns false and sets error otherwise. That's it — binary queen, no in-between 🌈

🌟 SEE ALSO

mongoc_client_encryption_t

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

alright bestie, that's the whole page, you ate it up fr fr 💅✨ — this one's rockin' version 2.5.6, dated Oct 09, 202, and it's giving manual-page main character energy till the very end 🎀🦋

📦 where this page comes from