table of contents
BSON_AS_JSON(3) | Library Functions Manual | BSON_AS_JSON(3) |
NAME¶
bson_as_json() - The bson_as_json() function shall encode bson as a JSON encoded UTF-8 string.SYNOPSIS¶
char * bson_as_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¶
The bson_as_json(3) function shall encode bson as a JSON encoded UTF‐8 string.The caller is responsible for freeing the resulting UTF‐8 encoded string by calling bson_free(3) 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¶
char *str = bson_as_json (doc, NULL); printf ("%s\n", str); bson_free (str);
COLOPHON¶
This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.2016‐10‐12 | libbson |