bson_append_undefined() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_t

# bson_append_undefined()

## Synopsis

    #define BSON_APPEND_UNDEFINED(b, key) \
       bson_append_undefined (b, key, (int) strlen (key))

    bool
    bson_append_undefined (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()`.

## Description

The bson_append_undefined() function shall append a new element to `bson` of type BSON_TYPE_UNDEFINED. Undefined is common in Javascript. However, this element type is deprecated and should not be used in new code.

## Returns

Returns `true` if the operation was applied successfully. The function will fail if appending the value grows `bson` larger than INT32_MAX.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.