FreeBSD Manual Pages
KJSON_PUTSTRING(3) Library Functions Manual KJSON_PUTSTRING(3) NAME kjson_putstring, kjson_putstringp, kjson_string_puts -- put string content for kcgijson LIBRARY libkcgijson SYNOPSIS #include <sys/types.h> #include <stdarg.h> #include <stdint.h> #include <kcgi.h> #include <kcgijson.h> enum kcgi_err kjson_putstring(struct kjsonreq *req, const char *v); enum kcgi_err kjson_putstringp(struct kjsonreq *req, const char *name, const char *v); enum kcgi_err kjson_string_puts(struct kjsonreq *req, const char *v); DESCRIPTION Write a string v, to a context req initialised with khtml_open(3). If v is NULL, do nothing and return KCGI_OK. The kjson_putstring() form is for array scopes, kjson_putstringp() for ob- jects, and kjson_string_puts() for open strings. All values are JSON escaped so that content cannot prematurely end its con- text. Passing a NULL value to name for kjson_putstringp(), is equivalent to call- ing kjson_putstring(). 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. KCGI_WRITER The incorrect form was used for the current scope, for example, an ar- ray-type write within an object. EXAMPLES The following outputs a simple JSON document. 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_APP_JSON]); khttp_body(r); kjson_open(&req, r); kjson_obj_open(&req); kjson_putstringp(&req, "bar", "shbar"); kjson_arrayp_open(&req, "baz"); kjson_putstring(&req, "xyzzy")); kjson_close(&req); SEE ALSO kcgijson(3) AUTHORS Written by Kristaps Dzonsons <kristaps@bsd.lv>. FreeBSD ports 15.quarterly $Mdocdate$ KJSON_PUTSTRING(3)
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | EXAMPLES | SEE ALSO | AUTHORS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=kjson_putstring&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>