KXML_PUTS(3)

🌸 NAME 🌸

okay bestie, this is the KXML_PUTS(3) page from the Library Functions Manual, and the function it's here to hype is kxml_write — the one that puts content data for kcgixml. No cap, that's the whole name vibe. 💅

🦋 LIBRARY 🦋

This cutie lives in the library libkcgixml. 💜

✨ SYNOPSIS ✨

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

enum kcgi_err
kxml_write(const char *buf, size_t sz, void *arg);

💖 DESCRIPTION 💖

kxml_write writes binary data buf of length sz to a context arg, which is a struct kxmlreq initialised with kxml_open(3) and passed in as an opaque pointer. If buf is NULL or sz is zero, it does nothing and returns success. All of the content is XML escaped. 🎀

🩷 RETURN VALUES 🩷

It returns an enum kcgi_err that tells you the error state, bestie. Here's the whole lineup:

• KCGI_OK — success, which is literally not an error. 🎀
• KCGI_ENOMEM — internal memory allocation failure. 😭
• KCGI_HUP — the output connection has been terminated. For FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. 💀
• KCGI_FORM — the connection is still expecting headers with khttp_head(3). This indicates that khttp_body(3) did not return with success or was not invoked. For FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. 😭
• KCGI_SYSTEM — internal system error writing to the output stream. 🔥

🧚 EXAMPLES 🧚

The following outputs a simple XML page. It assumes r is a struct kreq pointer. For brevity, it does not do any error checking. ✨

             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_puts(&req, "Hello, world");
             kxml_close(&req);

🌈 SEE ALSO 🌈

kcgixml(3)

👑 AUTHORS 👑

Written by Kristaps Dzonsons <kristaps@bsd.lv>. 💜

---

and that's the whole page, bestie — this Debian edition is dated $Mdocdate$, and the manual page itself is KXML_PUTS(3). mwah 💋✨