Scroll to navigation

BSON_APPEND_DATE_TIME(3) libbson BSON_APPEND_DATE_TIME(3)

NAME

bson_append_date_time - bson_append_date_time()

SYNOPSIS

#define BSON_APPEND_DATE_TIME(b, key, val) \


   bson_append_date_time (b, key, (int) strlen (key), val)
bool
bson_append_date_time (bson_t *bson,


                       const char *key,


                       int key_length,


                       int64_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: The date and time as specified in milliseconds since the UNIX epoch.

DESCRIPTION

The bson_append_date_time() function shall append a new element to a bson document containing a date and time with no timezone information. value is assumed to be in UTC format of milliseconds since the UNIX epoch. value MAY be negative.

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

October 20, 2022 1.23.1