bson_string_free(3)

BSON_STRING_FREE(3) libbson BSON_STRING_FREE(3)

Warning:

Deprecated since version 1.29.0.



SYNOPSIS

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


PARAMETERS

  • string: A bson_string_t <>.
  • free_segment: A bool indicating whether string->str should be freed.

DESCRIPTION

Frees the bson_string_t structure and optionally string->str.

RETURNS

string->str if free_segment is false, otherwise NULL.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

February 10, 2026 1.30.7