xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_str.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
2.Dt SQLITE3_STR 3
3.Os
4.Sh NAME
5.Nm sqlite3_str
6.Nd Dynamic String Object
7.Sh SYNOPSIS
8.Vt typedef struct sqlite3_str sqlite3_str;
9.Sh DESCRIPTION
10An instance of the sqlite3_str object contains a dynamically-sized
11string under construction.
12.Pp
13The lifecycle of an sqlite3_str object is as follows:
14.Bl -enum
15.It
16The sqlite3_str object is created using sqlite3_str_new().
17.It
18Text is appended to the sqlite3_str object using various methods, such
19as sqlite3_str_appendf().
20.It
21The sqlite3_str object is destroyed and the string it created is returned
22using the sqlite3_str_finish() interface.
23.El
24.Pp
25.Sh SEE ALSO
26.Xr sqlite3_str_appendf 3 ,
27.Xr sqlite3_str_finish 3 ,
28.Xr sqlite3_str_new 3
29