Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 895 Bytes

bson_append_maxkey.rst

File metadata and controls

32 lines (21 loc) · 895 Bytes
Raw
man_page:bson_append_maxkey

bson_append_maxkey()

Synopsis

#define BSON_APPEND_MAXKEY(b, key) \
   bson_append_maxkey (b, key, (int) strlen (key))

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

Parameters

  • bson: A :symbol:`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 :symbol:`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.

Returns

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