Man page - bson_append_maxkey(3)

Packages contains this manual

Manual

BSON_APPEND_MAXKEY

SYNOPSIS
PARAMETERS
DESCRIPTION
RETURNS
AUTHOR
COPYRIGHT

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 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_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.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.