bson_append_document - bson_append_document()

NAME  SYNOPSIS  PARAMETERS  DESCRIPTION  RETURNS  AUTHOR  COPYRIGHT 

NAME

bson_append_document − bson_append_document()

SYNOPSIS

#define BSON_APPEND_DOCUMENT(b, key, val) \
   bson_append_document (b, key, (int) strlen (key), val)


bool
bson_append_document (bson_t *bson,
                      const char *key,
                      int key_length,
                      const bson_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_t containing the sub−document to append.

DESCRIPTION

The bson_append_document() function shall append child to bson using the specified key. The type of the field will be a document.

RETURNS

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

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc


Updated 2024-01-29 - jenkler.se | uex.se