.\" 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_ITER_CODEWSCOPE" "3" "Oct 20, 2022" "1.23.1" "libbson"
.SH NAME
bson_iter_codewscope \- bson_iter_codewscope()
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#define BSON_ITER_HOLDS_CODEWSCOPE(iter) \e
   (bson_iter_type ((iter)) == BSON_TYPE_CODEWSCOPE)

const char *
bson_iter_codewscope (const bson_iter_t *iter,
                      uint32_t *length,
                      uint32_t *scope_len,
                      const uint8_t **scope);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBiter\fP: A \fI\%bson_iter_t\fP\&.
.IP \(bu 2
\fBlength\fP: An optional location for the length of the resulting UTF\-8 encoded string.
.IP \(bu 2
\fBscope_len\fP: A optional location for the length of \fBscope\fP\&.
.IP \(bu 2
\fBscope\fP: An optional location to store the immutable raw scope BSON document.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBbson_iter_codewscope()\fP function acts similar to \fI\%bson_iter_code()\fP except for BSON_TYPE_CODEWSCOPE elements. It also will provide a pointer to the buffer for scope, which can be loaded into a \fI\%bson_t\fP using \fI\%bson_init_static()\fP\&.
.SH RETURNS
.sp
An UTF\-8 encoded string containing the JavaScript code which should not be modified or freed.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.