MONGOC_CLIENT_...YPTION_GET_KEY(3)

📦
version 2.5.6 · 15 versions
, in epel 10

💖 MONGOC_CLIENT_...YPTION_GET_KEY(3) 💖

okay so this is a libmongoc manual page, and it's all about grabbing a key document. Bestie, it's giving “fetch the key from the vault” energy. 🎀

✨ SYNOPSIS ✨

          bool
          mongoc_client_encryption_get_key (mongoc_client_encryption_t *client_encryption,
                                            const bson_value_t *keyid,
                                            bson_t *key_doc,
                                            bson_error_t *error);

Get a key document in the key vault collection that has the given keyid. That's the whole vibe. 🦋

🌸 PARAMETERS 🌸

  • client_encryption — a mongoc_client_encryption_t. The main character object you're passing in. 💅
  • keyid — the UUID of the key to get. It's a BSON binary subtype 0x04, iykyk. 🔑
  • key_doc — optional, bestie. It's an uninitialized bson_t that gets set to the resulting key document, or to an empty document value if the key does not exist. You must free it with bson_destroy(). Don't forget, fr fr. 🫶
  • error — optional. A bson_error_t. That's where the error tea goes if something's off. 🙈

🔥 RETURNS 🔥

Returns true if successful. Returns false and sets error otherwise. No cap. ✅

👀 SEE ALSO 👀

  • mongoc_client_encryption_t

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

Catch you later, bestie — this is libmongoc version 2.5.6, dated Oct 09, 202 (the footer got cut off mid-date, iykyk) 💖✨

📦 where this page comes from