summaryrefslogtreecommitdiff
path: root/external/public-domain/sqlite/man/sqlite3_str_finish.3
blob: 6b0c18454b18256201b0d3d5c1951efe884951f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.Dd December 19, 2018
.Dt SQLITE3_STR_FINISH 3
.Os
.Sh NAME
.Nm sqlite3_str_finish
.Nd Finalize A Dynamic String
.Sh SYNOPSIS
.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 sqlite3_malloc64() that contains the constructed
string.
The calling application should pass the returned value to 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 SEE ALSO
.Xr sqlite3_malloc 3 ,
.Xr sqlite3_str 3