BSON_APPEND_MAXKEY(3)

💅 BSON_APPEND_MAXKEY(3) — like, the libbson glow-up guide ✨

okay bestie, buckle up 🎀 this is the BSON_APPEND_MAXKEY(3) page from the libbson manual, and honestly? it's short, it's sweet, and it absolutely ate. let's get into it 🫶

---

✨ SYNOPSIS ✨

here's the whole vibe, verbatim, no cap:

#define BSON_APPEND_MAXKEY(b, key) \
   bson_append_maxkey (b, key, (int) strlen (key))

bool
bson_append_maxkey (bson_t *bson, const char *key, int key_length);

so you've got the cute lil macro that does the strlen() for you (main character energy fr), and the actual function underneath doing the real work 💪

---

🌸 PARAMETERS 🌸

• bson — a bson_t. that's the document you're stuffing things into, bestie 💖
• key — an ASCII C string holding the name of the field. like, the label on the box 🏷️
• key_length — how long key is, in bytes. OR you can pass -1 and it'll figure out the length with strlen() for you, which is lowkey iconic 🙈

---

🦋 DESCRIPTION 🦋

so bson_append_maxkey() shall append an element of type BSON_TYPE_MAXKEY to a bson document. that's it, that's the whole job 👑

but here's the tea ☕ — this is primarily used in queries, and it's unlikely to be used when storing a document to MongoDB. so like, it's a query-time girly, not a storage-time girly. know the difference 💅

---

🔥 RETURNS 🔥

returns true if the operation was applied successfully — slay ✅

but listen, she has limits: the function will fail if appending the value grows bson larger than INT32_MAX. that's the ceiling, bestie, and we do not cross it 🚫😭

---

👑 AUTHOR 👑

MongoDB, Inc — yeah, them. the ones who made it 💜

---

🌈 COPYRIGHT 🌈

2009-present, MongoDB, Inc. — iconic run honestly, decade-plus and still going 🎀

---

okay that's the whole page, you understood it perfectly, i'm so proud of you 🥹💖 this was libbson 2.5.6, dated Oct 09, 2026 — write it down in your notes app bestie, and go append some maxkeys responsibly ✨🦋💅