xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_str_finish.3 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.Dd December 19, 2018
2.Dt SQLITE3_STR_FINISH 3
3.Os
4.Sh NAME
5.Nm sqlite3_str_finish
6.Nd Finalize A Dynamic String
7.Sh SYNOPSIS
8.Ft char *
9.Fo sqlite3_str_finish
10.Fa "sqlite3_str*"
11.Fc
12.Sh DESCRIPTION
13The sqlite3_str_finish(X) interface destroys the
14sqlite3_str object X and returns a pointer to a memory buffer obtained
15from sqlite3_malloc64() that contains the constructed
16string.
17The calling application should pass the returned value to sqlite3_free()
18to avoid a memory leak.
19The sqlite3_str_finish(X) interface may return
20a NULL pointer if any errors were encountered during construction of
21the string.
22The sqlite3_str_finish(X) interface will also
23return a NULL pointer if the string in sqlite3_str object
24X is zero bytes long.
25.Sh SEE ALSO
26.Xr sqlite3_malloc 3 ,
27.Xr sqlite3_str 3
28