.\" Man page generated from reStructuredText.
.
.TH "BSON_APPEND_BINARY" "3" "Feb 23, 2019" "1.14.0" "Libbson"
.SH NAME
bson_append_binary \- bson_append_binary()
.
.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_BINARY(b, key, subtype, val, len) \e
   bson_append_binary (b, key, (int) strlen (key), subtype, val, len)

bool
bson_append_binary (bson_t *bson,
                    const char *key,
                    int key_length,
                    bson_subtype_t subtype,
                    const uint8_t *binary,
                    uint32_t length);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: A \fBbson_t\fP\&.
.IP \(bu 2
\fBkey\fP: The key name.
.IP \(bu 2
\fBkey_length\fP: The length of \fBkey\fP in bytes or \-1 to use strlen().
.IP \(bu 2
\fBsubtype\fP: A bson_subtype_t indicating the binary subtype.
.IP \(bu 2
\fBbinary\fP: A buffer to embed as binary data. Must not be \fBNULL\fP\&.
.IP \(bu 2
\fBlength\fP: The length of \fBbuffer\fP in bytes.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_append_binary()\fP function shall append a new element to \fBbson\fP containing the binary data provided.
.SH RETURNS
.sp
Returns \fBtrue\fP if the operation was applied successfully. The function will fail if appending \fBbinary\fP grows \fBbson\fP larger than INT32_MAX.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.