.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_BINARY" "3" "Feb 23, 2019" "1.14.0" "Libbson"
.SH NAME
bson_iter_binary \- bson_iter_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_ITER_HOLDS_BINARY(iter) \e
   (bson_iter_type ((iter)) == BSON_TYPE_BINARY)

void
bson_iter_binary (const bson_iter_t *iter,
                  bson_subtype_t *subtype,
                  uint32_t *binary_len,
                  const uint8_t **binary);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fBbson_iter_t\fP\&.
.IP \(bu 2
\fBsubtype\fP: A location for a \fBbson_subtype_t\fP or NULL.
.IP \(bu 2
\fBbinary_len\fP: A location for the length of \fBbinary\fP\&.
.IP \(bu 2
\fBbinary\fP: A location for a pointer to the immutable buffer.
.UNINDENT
.SH DESCRIPTION
.sp
This function shall return the binary data of a BSON_TYPE_BINARY element. It is a programming error to call this function on a field that is not of type BSON_TYPE_BINARY. You can check this with the BSON_ITER_HOLDS_BINARY() macro or \fBbson_iter_type()\fP\&.
.sp
The buffer that \fBbinary\fP points to is only valid until the iterator\(aqs \fBbson_t\fP is modified or freed.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.