kxml_popall - close all element scopes for kcgixml


KXML_POPALL(3) Library Functions Manual KXML_POPALL(3)

NAME

kxml_popall — close all element scopes for kcgixml

LIBRARY

library “libkcgixml”

SYNOPSIS

#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

Closes all open element scopes of req, initialised with kxml_open(3). Scopes are opened with kxml_push(3) or kxml_pushattrs(3). If there are no open scopes, this does nothing.

RETURN VALUES

Returns an enum kcgi_err indicating the error state.

KCGI_OK

Success (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 parse loop reentered.

KCGI_FORM

The connection is still expecting headers with khttp_head(3). 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 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_push(&req, 1); /* bar */
kxml_push(&req, 2); /* baz */
kxml_popall(&req);
kxml_close(&req);

SEE ALSO

kcgixml(3)

AUTHORS

Written by Kristaps Dzonsons <[email protected]>. GNU $Mdocdate$ KXML_POPALL(3)


Updated 2024-01-29 - jenkler.se | uex.se