.Dd January 24, 2024
.Dt SQLITE3_STR_FINISH 3
.Os
.Sh NAME
.Nm sqlite3_str_finish
.Nd finalize a dynamic string
.Sh SYNOPSIS
.In sqlite3.h
.Ft char *
.Fo sqlite3_str_finish
.Fa "sqlite3_str*"
.Fc
.Sh DESCRIPTION
The sqlite3_str_finish(X) interface destroys the
sqlite3_str object X and returns a pointer to a memory buffer obtained
from
.Fn sqlite3_malloc64
that contains the constructed string.
The calling application should pass the returned value to
.Fn sqlite3_free
to avoid a memory leak.
The sqlite3_str_finish(X) interface may return
a NULL pointer if any errors were encountered during construction of
the string.
The sqlite3_str_finish(X) interface will also
return a NULL pointer if the string in sqlite3_str object
X is zero bytes long.
.Sh IMPLEMENTATION NOTES
These declarations were extracted from the
interface documentation at line 8427.
.Bd -literal
SQLITE_API char *sqlite3_str_finish(sqlite3_str*);
.Ed
.Sh SEE ALSO
.Xr sqlite3_malloc 3 ,
.Xr sqlite3_str 3