.\" Man page generated from reStructuredText.
.
.TH "BSON_STRING_FREE" "3" "Jun 04, 2021" "1.17.6" "libbson"
.SH NAME
bson_string_free \- bson_string_free()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
char *
bson_string_free (bson_string_t *string, bool free_segment);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBstring\fP: A \fBbson_string_t\fP\&.
.IP \(bu 2
\fBfree_segment\fP: A bool indicating whether \fBstring\->str\fP should be freed.
.UNINDENT
.SH DESCRIPTION
.sp
Frees the \fBbson_string_t\fP structure and optionally \fBstring\->str\fP\&.
.SH RETURNS
.sp
\fBstring\->str\fP if \fBfree_segment\fP is false, otherwise \fBNULL\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.