bson_append_code(3)

bson_append_code()

Section 3 libbson-doc bookworm source

Description

BSON_APPEND_CODE

NAME

bson_append_code - bson_append_code()

SYNOPSIS

#define BSON_APPEND_CODE(b, key, val) \
bson_append_code (b, key, (int) strlen (key), val)

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

PARAMETERS

bson: A bson_t.

key: The key name.

key_length: The length of key or -1 to use strlen().

javascript: A UTF-8 encoded string containing the javascript.

DESCRIPTION

The bson_append_code() function shall append a new element to bson using the UTF-8 encoded javascript provided. javascript must be a NULL terminated C string.

RETURNS

Returns true if the operation was applied successfully. The function will fail if appending javascript grows bson larger than INT32_MAX.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc