Scroll to navigation

BSON_APPEND_TIMEVAL(3) Libbson BSON_APPEND_TIMEVAL(3)

NAME

bson_append_timeval - bson_append_timeval()

SYNOPSIS

#define BSON_APPEND_TIMEVAL(b, key, val) \
   bson_append_timeval (b, key, (int) strlen (key), val)
bool
bson_append_timeval (bson_t *bson,
                     const char *key,
                     int key_length,
                     struct timeval *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 struct timeval.

DESCRIPTION

The bson_append_timeval() function is a helper that takes a struct timeval instead of milliseconds since the UNIX epoch.

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, 2019 1.15.1