bson_iter_codewscope(3)
bson_iter_codewscope()
Description
BSON_ITER_CODEWSCOPE
NAME
bson_iter_codewscope - bson_iter_codewscope()
SYNOPSIS
#define
BSON_ITER_HOLDS_CODEWSCOPE(iter) \
(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);
PARAMETERS
|
• |
iter: A bson_iter_t. | ||
|
• |
length: An optional location for the length of the resulting UTF-8 encoded string. | ||
|
• |
scope_len: A optional location for the length of scope. | ||
|
• |
scope: An optional location to store the immutable raw scope BSON document. |
DESCRIPTION
The bson_iter_codewscope() function acts similar to bson_iter_code() except for BSON_TYPE_CODEWSCOPE elements. It also will provide a pointer to the buffer for scope, which can be loaded into a bson_t using bson_init_static().
RETURNS
An UTF-8 encoded string containing the JavaScript code which should not be modified or freed.
AUTHOR
MongoDB, Inc
COPYRIGHT
2017-present, MongoDB, Inc