SYNOPSIS

#include <bson.h>

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

DESCRIPTION

The bson_append_maxkey() function shall append an element of type BSON_TYPE_MAXKEY to a bson document. This is primarily used in queries and unlikely to be used when storing a document to MongoDB.

RETURN VALUE

TRUE if successful. Otherwise FALSE and no modifications to bson are made.

ERRORS

FALSE is returned if there is insufficient space for the element.

SEE ALSO

AUTHORS

This page was written by MongoDB, Inc.