.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "BSON_INIT_FROM_JSON" "3" "Feb 22, 2024" "1.26.0" "libbson"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
bson_init_from_json (bson_t *bson,
                     const char *data,
                     ssize_t len,
                     bson_error_t *error);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: Pointer to an uninitialized \fI\%bson_t\fP\&.
.IP \(bu 2
\fBdata\fP: A UTF\-8 encoded string containing valid JSON.
.IP \(bu 2
\fBlen\fP: The length of \fBdata\fP in bytes excluding a trailing \fB\e0\fP or \-1 to determine the length with \fBstrlen()\fP\&.
.IP \(bu 2
\fBerror\fP: An optional location for a \fI\%bson_error_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_init_from_json()\fP function will initialize a new \fI\%bson_t\fP by parsing the JSON found in \fBdata\fP\&. Only a single JSON object may exist in \fBdata\fP or an error will be set and false returned.
.sp
\fBdata\fP should be in \fI\%MongoDB Extended JSON\fP format.
.SH DEPRECATED BEHAVIOR
.sp
If there are multiple comma\-separated JSONs in \fBdata\fP, the keys from all JSONs are merged in the returned BSON.
For example, \fB{\(dqa\(dq: 1},{\(dqb\(dq: 2}\fP is parsed as \fB{\(dqa\(dq: 1, \(dqb\(dq: 2}\fP\&.
.sp
If the first character encountered after the last valid
JSON object is \fB{\fP, all following characters are ignored and no error is set.
Otherwise, an error will be set and NULL returned.
.sp
This deprecated behavior is subject to change in a future release.
.SH ERRORS
.sp
Errors are propagated via the \fBerror\fP parameter.
.SH RETURNS
.sp
Returns \fBtrue\fP if valid JSON was parsed, otherwise \fBfalse\fP and \fBerror\fP is set. On success, \fBbson\fP is initialized and must be freed with \fI\%bson_destroy()\fP, otherwise \fBbson\fP is invalid.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.