bson_append_array (3) Linux Manual Page

NAME

bson_append_array() – The bson_append_array() function shall append child to bson using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of child are properly formatted with string keys such as "0", "1", "2" and so forth.

SYNOPSIS

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

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

array

A bson_t \&.

DESCRIPTION

The bson_append_array(3) function shall append child to bson using the specified key. The type of the field will be an array, but it is the responsibility of the caller to ensure that the keys of child are properly formatted with string keys such as "0", "1", "2" and so forth.

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