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

FreeBSD Manual Pages

  
 
  

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

NAME
     khtml_puts -- put string content for kcgihtml

LIBRARY
     libkcgihtml

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

     enum kcgi_err
     khtml_puts(struct khtmlreq *req, const char *cp);

DESCRIPTION
     Writes  a	NUL-terminated	string	cp  to	a  context  req initialised with
     khtml_open(3).  If cp is NULL, does nothing and returns  success.	 All  of
     the  content  is  HTML  escaped, for example, the left-angle bracket "<" is
     rendered as "&lt;".  It does not append a newline like puts(3).

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_elem(&req, KELEM_P);
	   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_PUTS(3)

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

home | help