Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
BSON_APPEND_MINKEY(3)		    libbson		 BSON_APPEND_MINKEY(3)

SYNOPSIS
	  #define BSON_APPEND_MINKEY(b,	key) \
	     bson_append_minkey	(b, key, (int) strlen (key))

	  bool
	  bson_append_minkey (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_minkey()  function  shall  append  an  element of type
       BSON_TYPE_MINKEY	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.

1.30.2				 Apr 12, 2025		 BSON_APPEND_MINKEY(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bson_append_minkey&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help