xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_str.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_STR 3
3.Os
4.Sh NAME
5.Nm sqlite3_str
6.Nd dynamic string object
7.Sh SYNOPSIS
8.In sqlite3.h
9.Vt typedef struct sqlite3_str sqlite3_str;
10.Sh DESCRIPTION
11An instance of the sqlite3_str object contains a dynamically-sized
12string under construction.
13.Pp
14The lifecycle of an sqlite3_str object is as follows:
15.Bl -enum
16.It
17The sqlite3_str object is created using
18.Fn sqlite3_str_new .
19.It
20Text is appended to the sqlite3_str object using various methods, such
21as
22.Fn sqlite3_str_appendf .
23.It
24The sqlite3_str object is destroyed and the string it created is returned
25using the
26.Fn sqlite3_str_finish
27interface.
28.El
29.Pp
30.Sh IMPLEMENTATION NOTES
31These declarations were extracted from the
32interface documentation at line 8382.
33.Bd -literal
34typedef struct sqlite3_str sqlite3_str;
35.Ed
36.Sh SEE ALSO
37.Xr sqlite3_str_appendf 3 ,
38.Xr sqlite3_str_finish 3 ,
39.Xr sqlite3_str_new 3
40