NAME

       bson_append_maxkey()  -  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.

SYNOPSIS

       bool
       bson_append_maxkey (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(3) \&.

DESCRIPTION

       The  bson_append_maxkey(3)  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.

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.