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

FreeBSD Manual Pages

  
 
  

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

NAME
     khtml_open -- open kcgihtml context

LIBRARY
     libkcgihtml

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

     enum kcgi_err
     khtml_open(struct khtmlreq *req, struct kreq *r, int opts);

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).  If opts is	set to KHTML_PRETTY, the
     output is lightly "pretty-printed" with newlines  and  indentation  spaces.
     By default, output is all on one line.

     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 HTML page.	It assumes r is  a  struct  kreq
     pointer.  For brevity, it does not do any error checking.

	   khttp_head(r, kresps[KRESP_STATUS],
	     "%s", khttps[KHTTP_200]);
	   khttp_head(r, kresps[KRESP_CONTENT_TYPE],
	     "%s", kmimetypes[KMIME_TEXT_HTML]);
	   khttp_body(r);
	   khtml_open(&req, r, 0);
	   khtml_elem(&req, KELEM_DOCTYPE);
	   khtml_elem(&req, KELEM_HTML);
	   khtml_elem(&req, KELEM_BODY);
	   khtml_puts(&req, "Hello, world");
	   khtml_close(&req);

SEE ALSO
     kcgihtml(3)

STANDARDS
     The referenced HTML5 standard is HTML5.2.

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

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

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

home | help