bson_append_code_with_scope (3) - Linux Manuals

bson_append_code_with_scope: The bson_append_code_with_scope() function shall perform like bson_append_code() except it allows providing a scope to the javascript function in the form of a bson document.

Command to display bson_append_code_with_scope manual in Linux: $ man 3 bson_append_code_with_scope

NAME

bson_append_code_with_scope() - The bson_append_code_with_scope() function shall perform like bson_append_code() except it allows providing a scope to the javascript function in the form of a bson document.

SYNOPSIS

bool
bson_append_code_with_scope (bson_t       *bson,
                             const char   *key,
                             int           key_length,
                             const char   *javascript,
                             const bson_t *scope);

PARAMETERS

bson: A bson_t \&.

key: An ASCII C string containing the name of the field.

key_length: The length of key in bytes, or -1 to determine the length with strlen(3) \&.

javascript: A NULL-terminated UTF-8 encoded string containing the javascript fragment.

scope: A bson_t containing the scope for javascript \&.

DESCRIPTION

The bson_append_code_with_scope(3) function shall perform like bson_append_code(3) except it allows providing a scope to the javascript function in the form of a bson document.

RETURNS

true if the operation was applied successfully, otherwise false and bson should be discarded.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.