Scroll to navigation

BSON_APPEND_ITER(3) libbson BSON_APPEND_ITER(3)

NAME

bson_append_iter - bson_append_iter()

SYNOPSIS

bool
bson_append_iter (bson_t *bson,


                  const char *key,


                  int key_length,


                  const bson_iter_t *iter);


PARAMETERS

  • bson: A bson_t.
  • key: Optional field name. If NULL, uses bson_iter_key(iter).
  • key_length: The length of key or -1 to use strlen().
  • iter: A bson_iter_t located on the position of the element to append.

DESCRIPTION

Appends the value at the current position of iter to the document.

RETURNS

Returns true if successful; false if the operation would overflow the maximum document size or another invalid state is detected.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

August 31, 2022 1.23.0