NAME

bson_string_free() - Frees the bson_string_t structure and optionally the string itself.

SYNOPSIS

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

PARAMETERS

string
A bson_string_t \&.

free_segment
A bool indicating if str->str should be returned.

DESCRIPTION

Frees the bson_string_t structure and optionally the string itself.

RETURNS

str->str if free_segment is true, otherwise NULL.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.