KXML_PROLOGUE(3)

💖 KXML_PROLOGUE(3) 💖

okay so bestie, welcome to kxml_prologue — she lives in the Library Functions Manual section, she's part of the kcgixml family, and honestly? she's the easiest little icon in the whole group chat. let me tell you everything 🫶

---

🌸 LIBRARY 🌸

she ships in the library “libkcgixml” — that's the whole vibe, no cap ✨

---

🎀 SYNOPSIS 🎀

like, here's how you summon her:

#include <sys/types.h>
#include <stdarg.h>
#include <stdint.h>
#include <kcgi.h>
#include <kcgixml.h>

enum kcgi_err
kxml_prologue(struct kxmlreq *req);

one function, one argument, zero drama 💅

---

✨ DESCRIPTION ✨

so what she does is write the standard XML prologue into a context req that you already initialised with kxml_open(3). that's it. that's the whole job, and she does it flawlessly 🔥

and the prologue she writes is literally this exact string:

<?xml version="1.0" encoding="utf-8" ?>

no cap, that's the one. every single time 👑

---

💀 RETURN VALUES 💀

she returns an enum kcgi_err so you know exactly what the vibe check said. here's the full lineup:

• KCGI_OK — success!! not an error, she's just happy 🥰
• KCGI_ENOMEM — internal memory allocation failure 😭 the allocation said no
• KCGI_HUP — the output connection has been terminated 💔 for FastCGI connections, you should release the current connection with khttp_free(3) and reenter the parse loop
• KCGI_FORM — the connection is still expecting headers with khttp_head(3) 🙈 this means khttp_body(3) either didn't return with success or was never invoked at all. for FastCGI connections, same deal: release the current connection with khttp_free(3) and reenter the parse loop
• KCGI_SYSTEM — internal system error writing to the output stream, like the OS fumbled the bag 💀

---

🦋 EXAMPLES 🦋

okay here's a whole lil XML page, start to finish. this assumes r is a struct kreq pointer. and for brevity (we're keeping it snack-sized, not a whole meal) it does zero error checking — iconic but chaotic of us 🙈

const char *const elems[] =
  { "foo", "bar", "baz" };
khttp_head(r, kresps[KRESP_STATUS],
  "%s", khttps[KHTTP_200]);
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
  "%s", kmimetypes[KMIME_TEXT_XML]);
khttp_body(r);
kxml_open(&req, r, elems, 3);
kxml_prologue(&req);
kxml_push(&req, 0); /* foo */
kxml_puts(&req, "Hello, world");
kxml_close(&req);

see how kxml_prologue(&req) just slides in right after kxml_open? main character energy honestly 🌟

---

🌈 SEE ALSO 🌈

• kcgixml(3) — go read the rest of the family, iykyk 💜

---

👑 AUTHORS 👑

written by Kristaps Dzonsons <kristaps@bsd.lv> — ty for the lore, king 🫡

---

fr fr, that's the whole page: standard XML prologue, <?xml version="1.0" encoding="utf-8" ?>, five possible return values, and one very cute example. go forth and slay ✨

mwah 💋 this little page came to you from Debian, dated $Mdocdate$, and she's known as KXML_PROLOGUE(3) — see u in the next manpage bestie 🎀