.\" Man page generated from reStructuredText.
.
.TH "BSON_UTF8_ESCAPE_FOR_JSON" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_utf8_escape_for_json \- bson_utf8_escape_for_json()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
char *
bson_utf8_escape_for_json (const char *utf8, ssize_t utf8_len);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fButf8\fP: A UTF\-8 encoded string.
.IP \(bu 2
\fButf8_len\fP: The length of \fButf8\fP in bytes or \-1 if it is NULL terminated.
.UNINDENT
.SH DESCRIPTION
.sp
Allocates a new string matching \fButf8\fP except that special
characters in JSON are escaped. The resulting string is also
UTF\-8 encoded.
.sp
Both " and \e characters will be backslash\-escaped. If a NUL
byte is found before \fButf8_len\fP bytes, it is converted to
"\eu0000". Other non\-ASCII characters in the input are preserved.
.SH RETURNS
.sp
A newly allocated string that should be freed with \fBbson_free()\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.