bson_append_symbol(3)

NAME

bson_append_symbol() – Appends a new field to bson of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.

SYNOPSIS


bool bson_append_symbol(bson_t *bson,
                        const char *key,
                        int key_length,
                        const char *value,
                        int 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) \&.

value: The symbol.

length: A length of symbol in bytes, or -1 to determine the length with strlen(3) \&.

DESCRIPTION

Appends a new field to bson of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.

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.