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

FreeBSD Manual Pages

  
 
  

home | help
BSON_APPEND_ARRAY(3)		    libbson		  BSON_APPEND_ARRAY(3)

SYNOPSIS
	  #define BSON_APPEND_ARRAY(b, key, val) \
	     bson_append_array (b, key,	(int) strlen (key), val)

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

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

        array:	A bson_t.

DESCRIPTION
       The  bson_append_array()	 function shall	append array to	bson using the
       specified key. The type of the field will be an array, but  it  is  the
       responsibility of the caller to ensure that the keys of array are prop-
       erly formatted with string keys such as "0", "1", "2" and so forth.

RETURNS
       Returns	true  if  the operation	was applied successfully. The function
       fails if	appending the array grows bson larger than INT32_MAX.

       SEE ALSO:
	  bson_array_builder_t

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025		  BSON_APPEND_ARRAY(3)

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

home | help