.\" Man page generated from reStructuredText.
.
.TH "BSON_APPEND_DOCUMENT_BEGIN" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_append_document_begin \- bson_append_document_begin()
.
.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
#define BSON_APPEND_DOCUMENT_BEGIN(b, key, child) \e
   bson_append_document_begin (b, key, (int) strlen (key), child)

bool
bson_append_document_begin (bson_t *bson,
                            const char *key,
                            int key_length,
                            bson_t *child);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: A \fBbson_t\fP\&.
.IP \(bu 2
\fBkey\fP: An ASCII C string containing the name of the field.
.IP \(bu 2
\fBkey_length\fP: The length of \fBkey\fP in bytes, or \-1 to determine the length with \fBstrlen()\fP\&.
.IP \(bu 2
\fBchild\fP: An uninitialized \fBbson_t\fP to be initialized as the sub\-document.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_append_document_begin()\fP function shall begin appending a sub\-document to \fBbson\fP\&. Use \fBchild\fP to add fields to the sub\-document. When completed, call \fBbson_append_document_end()\fP to complete the element.
.sp
\fBchild\fP \fIMUST\fP be an uninitialized \fBbson_t\fP to avoid leaking memory.
.SH RETURNS
.sp
Returns \fBtrue\fP if the operation was applied successfully. The function will fail if \fBbson\fP must grow larger than INT32_MAX.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.