bson_append_oid (3) Linux Manual Page

NAME

bson_append_oid() – The bson_append_oid() function shall append a new element to bson of type BSON_TYPE_OID. oid MUST be a pointer to a bson_oid_t.

SYNOPSIS

bool bson_append_oid(bson_t *bson,
                     const char *key,
                     int key_length,
                     const bson_oid_t *oid);

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

oid

A bson_oid_t.

DESCRIPTION

The bson_append_oid(3) function shall append a new element to bson of type BSON_TYPE_OID. oid

MUST be a pointer to a bson_oid_t \&.

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.

Index