bson_append_now_utc(3)

NAME

bson_append_now_utc() – The bson_append_now_utc() function is a helper to get the current date and time in UTC and append it to bson as a BSON_TYPE_DATE_TIME element.

SYNOPSIS


bool bson_append_now_utc(bson_t *bson,
                         const char *key,
                         int key_length);

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(3) \&.

DESCRIPTION

The bson_append_now_utc(3) function is a helper to get the current date and time in UTC and append it to bson as a BSON_TYPE_DATE_TIME element.

This function calls bson_append_date_time(3) internally.

RETURNS

true if the operation was applied successfully, otherwise false and bson should be discarded.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.