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

  
 
  

home | help
BSON_ARRAY_AS_..._EXTENDED_JSON(3)   libbson  BSON_ARRAY_AS_..._EXTENDED_JSON(3)

SYNOPSIS
	char *
	bson_array_as_legacy_extended_json (const bson_t *bson, size_t *length)

PARAMETERS
     * bson: A bson_t.

     * length: An optional location for the length of the resulting string.

DESCRIPTION
     bson_array_as_legacy_extended_json()  encodes  bson as a UTF-8 string using
     libbson's Legacy Extended JSON.  The outermost element is encoded as a JSON
     array ([ ... ]), rather than a JSON document ({ ... }).  This  function  is
     superseded       by       bson_array_as_canonical_extended_json()	     and
     bson_array_as_relaxed_extended_json(), which use the same MongoDB	Extended
     JSON format as all other MongoDB drivers.

     The caller is responsible for freeing the resulting UTF-8 encoded string by
     calling bson_free() with the result.

     If non-NULL, length will be set to the length of the result in bytes.

RETURNS
     If successful, a newly allocated UTF-8 encoded string and length is set.

     Upon failure, NULL is returned.

EXAMPLE
	bson_t *b = BCON_NEW ("0", BCON_INT32 (1), "1", BCON_UTF8 ("bar"));
	// The document for an array is a normal BSON document with integer values for the keys, starting with 0 and
	// continuing sequentially.
	char *str = bson_array_as_legacy_extended_json (b, NULL);
	printf ("Legacy Extended JSON array: %s\n", str);
	// Prints:
	// Legacy Extended JSON array: [ 1, "bar" ]
	bson_free (str);
	bson_destroy (b);

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026BSON_ARRAY_AS_..._EXTENDED_JSON(3)

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

home | help