.\" Man page generated from reStructuredText.
.
.TH "BSON_UTF8_VALIDATE" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_utf8_validate \- bson_utf8_validate()
.
.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
bool
bson_utf8_validate (const char *utf8, size_t utf8_len, bool allow_null);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fButf8\fP: A string to verify.
.IP \(bu 2
\fButf8_len\fP: The length of \fButf8\fP in bytes.
.IP \(bu 2
\fBallow_null\fP: A bool indicating that embedded \fB\e0\fP bytes are allowed.
.UNINDENT
.SH DESCRIPTION
.sp
Validates that the content within \fButf8\fP is valid UTF\-8 (by the RFC 3629 standard). If \fBallow_null\fP is \fBtrue\fP, then embedded NULL bytes are allowed (\fB\e0\fP).
.SH RETURNS
.sp
true if \fButf8\fP contains valid UTF\-8.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.