.\" Man page generated from reStructuredText.
.
.TH "BSON_ITER_ARRAY" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_iter_array \- bson_iter_array()
.
.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_ARRAY(iter) (bson_iter_type ((iter)) == BSON_TYPE_ARRAY)

void
bson_iter_array (const bson_iter_t *iter,
                 uint32_t *array_len,
                 const uint8_t **array);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fBbson_iter_t\fP\&.
.IP \(bu 2
\fBarray_len\fP: A location for the buffer length.
.IP \(bu 2
\fBarray\fP: A location for the immutable buffer.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_iter_array()\fP function shall retrieve the raw buffer of a sub\-array from \fBiter\fP\&. \fBiter\fP \fIMUST\fP be on an element that is of type BSON_TYPE_ARRAY. This can be verified with \fBbson_iter_type()\fP or the \fBBSON_ITER_HOLDS_ARRAY()\fP macro.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.