.\" 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_APPEND_ARRAY_BEGIN" "3" "Apr 02, 2024" "1.26.2" "libbson"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#define BSON_APPEND_ARRAY_BEGIN(b, key, child) \e
   bson_append_array_begin (b, key, (int) strlen (key), child)

bool
bson_append_array_begin (bson_t *bson,
                         const char *key,
                         int key_length,
                         bson_t *child);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: A \fI\%bson_t\fP\&.
.IP \(bu 2
\fBkey\fP: A string containing the name for the key.
.IP \(bu 2
\fBkey_length\fP: The length of \fBkey\fP or \-1 to call \fBstrlen()\fP\&.
.IP \(bu 2
\fBchild\fP: A \fI\%bson_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
The \fI\%bson_append_array_begin()\fP function shall begin appending an array field to \fBbson\fP\&. This allows for incrementally building a sub\-array. Doing so will generally yield better performance as you will serialize to a single buffer. When done building the sub\-array, the caller \fIMUST\fP call \fI\%bson_append_array_end()\fP\&.
.sp
For generating array element keys, see \fI\%bson_uint32_to_string()\fP\&.
.sp
Consider using \fI\%bson_array_builder_t\fP to append an array without needing to generate array element keys.
.SH RETURNS
.sp
Returns \fBtrue\fP if the operation was applied successfully. The function will fail if appending the array grows \fBbson\fP larger than INT32_MAX.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.nf
\fI\%bson_array_builder_t\fP
.fi
.sp
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.