SYNOPSIS

#include <bson.h>

char *
bson_string_free (bson_string_t *string,
                  bool           free_segment);

DESCRIPTION

The bson_string_free() function shall free string. If free_segment is FALSE, then the built string will be returned to the caller. Otherwise, the built string is also freed.

RETURN VALUE

The built string if free_segment is FALSE, otherwise NULL.

ERRORS

No errors are defined.

AUTHORS

This page was written by MongoDB, Inc.