Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
KXML_OPEN(3)		     Library Functions Manual		    KXML_OPEN(3)

NAME
     kxml_open -- open kcgixml context

LIBRARY
     libkcgixml

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

     enum kcgi_err
     kxml_open(struct kxmlreq *xml, struct kreq *req, const char *const *elems,
	 size_t elemsz);

DESCRIPTION
     Zeroes  and  initialises a new context req with the underlying kcgi(3) con-
     text r as allocated with khttp_parse(3) or khttp_fcgi_parse(3).  It  should
     only be called after khttp_body(3).  The context is initialised with elemsz
     possible  elements  having  names elems.  It is the caller's responsibility
     that these be valid XML element names.

     If kcgi_writer_disable(3) has been called, the process will be killed  with
     an uncatchable signal.

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).   Indi-
	  cates  that  khttp_body(3)  did not return with success or was not in-
	  voked.  For FastCGI connections, the current connection should be  re-
	  leased 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_puts(&req, "Hello, world");
	   kxml_close(&req);

SEE ALSO
     kcgixml(3)

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

FreeBSD ports 15.quarterly	   $Mdocdate$			    KXML_OPEN(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=kxml_open&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help