Scroll to navigation

BSON_APPEND_VALUE(3) libbson BSON_APPEND_VALUE(3)

NAME

bson_append_value - bson_append_value()

SYNOPSIS

#define BSON_APPEND_VALUE(b, key, val) \

bson_append_value (b, key, (int) strlen (key), (val)) bool bson_append_value (bson_t *bson,
const char *key,
int key_length,
const bson_value_t *value);


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().
  • value: A bson_value_t.

DESCRIPTION

Appends a new field to bson by determining the boxed type in value. This is useful if you want to copy fields between documents but do not know the field type until runtime.

RETURNS

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

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

August 31, 2022 1.23.0