Scroll to navigation

BSON_APPEND_BOOL(3) Libbson BSON_APPEND_BOOL(3)

NAME

bson_append_bool - bson_append_bool()

SYNOPSIS

#define BSON_APPEND_BOOL(b, key, val) \
   bson_append_bool (b, key, (int) strlen (key), val)
bool
bson_append_bool (bson_t *bson, const char *key, int key_length, bool value);


PARAMETERS

  • bson: A bson_t.
  • key: The name of the field.
  • key_length: The length of key or -1 to use strlen().
  • value: true or false.

DESCRIPTION

The bson_append_bool() function shall append a new element to bson containing the boolean provided.

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
February 23, 2019 1.14.0