KXML_POPALL(3)

📦 version 1.0.1, in alpine 3.24

🎀 kxml_popall(3) 🎀

okay bestie, so this one's from the libkcgixml library — yes, the manual is literally called KXML_POPALL and it's about closing all your element scopes for kcgixml. slay. let's get into it 💅

✨ SYNOPSIS ✨

like, here's what you gotta include first, no cap:

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

enum kcgi_err
kxml_popall(struct kxmlreq *req);

🦋 DESCRIPTION 🦋

So kxml_popall() closes all the open element scopes of req — and req is the one you initialised with kxml_open(3). icymi, scopes get opened with kxml_push(3) or kxml_pushattrs(3). 🫶

And if there are literally no open scopes? It does nothing. zero. nada. chill like that. ✨

💖 RETURN VALUES 💖

It returns an enum kcgi_err that tells you the error state. here's the vibe check on each one:

  • KCGI_OK — success, bestie! not an error at all 🌸
  • KCGI_ENOMEM — internal memory allocation failure 😭 the memory 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 one means khttp_body(3) didn't return with success, or was never invoked at all 🙈 for FastCGI connections, release the current connection with khttp_free(3) and reenter the parse loop
  • KCGI_SYSTEM — internal system error while writing to the output stream 💀

🌈 EXAMPLES 🌈

okay so this little guy outputs a simple XML page. it assumes r is a struct kreq pointer. and for brevity it does no error checking (we're living dangerously, bestie 🧚):

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_push(&req, 0); /* foo */
kxml_push(&req, 1); /* bar */
kxml_push(&req, 2); /* baz */
kxml_popall(&req);
kxml_close(&req);

look at that. iconic. 👑

👀 SEE ALSO 👀

💜 AUTHORS 💜

Written by Kristaps Dzonsons <kristaps@bsd.lv>. king behaviour fr fr 🫡

ngl this page is from Debian, with the $Mdocdate$ version stamp — so yeah, that's the source and date situation, bestie. go forth and pop those scopes 💅✨🎀
📦 where this page comes from