.\" Man page generated from reStructuredText.
.
.TH "BSON_INIT_FROM_JSON" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_init_from_json \- bson_init_from_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
bool
bson_init_from_json (bson_t *bson,
                     const char *data,
                     ssize_t len,
                     bson_error_t *error);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: Pointer to an uninitialized \fBbson_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 \fBbson_error_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_init_from_json()\fP function will initialize a new \fBbson_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 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 \fBbson_destroy\fP, otherwise \fBbson\fP is invalid.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.