xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_str_appendf.3 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.Dd December 19, 2018
2.Dt SQLITE3_STR_APPENDF 3
3.Os
4.Sh NAME
5.Nm sqlite3_str_appendf ,
6.Nm sqlite3_str_vappendf ,
7.Nm sqlite3_str_append ,
8.Nm sqlite3_str_appendall ,
9.Nm sqlite3_str_appendchar ,
10.Nm sqlite3_str_reset
11.Nd Add Content To A Dynamic String
12.Sh SYNOPSIS
13.Ft void
14.Fo sqlite3_str_appendf
15.Fa "sqlite3_str*"
16.Fa "const char *zFormat"
17.Fa "..."
18.Fc
19.Ft void
20.Fo sqlite3_str_vappendf
21.Fa "sqlite3_str*"
22.Fa "const char *zFormat"
23.Fa "va_list"
24.Fc
25.Ft void
26.Fo sqlite3_str_append
27.Fa "sqlite3_str*"
28.Fa "const char *zIn"
29.Fa "int N"
30.Fc
31.Ft void
32.Fo sqlite3_str_appendall
33.Fa "sqlite3_str*"
34.Fa "const char *zIn"
35.Fc
36.Ft void
37.Fo sqlite3_str_appendchar
38.Fa "sqlite3_str*"
39.Fa "int N"
40.Fa "char C"
41.Fc
42.Ft void
43.Fo sqlite3_str_reset
44.Fa "sqlite3_str*"
45.Fc
46.Sh DESCRIPTION
47These interfaces add content to an sqlite3_str object previously obtained
48from sqlite3_str_new().
49.Pp
50The sqlite3_str_appendf(X,F,...) and sqlite3_str_vappendf(X,F,V)
51interfaces uses the built-in printf functionality of
52SQLite to append formatted text onto the end of sqlite3_str
53object X.
54.Pp
55The sqlite3_str_append(X,S,N) method appends
56exactly N bytes from string S onto the end of the sqlite3_str
57object X.
58N must be non-negative.
59S must contain at least N non-zero bytes of content.
60To append a zero-terminated string in its entirety, use the sqlite3_str_appendall()
61method instead.
62.Pp
63The sqlite3_str_appendall(X,S) method appends
64the complete content of zero-terminated string S onto the end of sqlite3_str
65object X.
66.Pp
67The sqlite3_str_appendchar(X,N,C) method
68appends N copies of the single-byte character C onto the end of sqlite3_str
69object X.
70This method can be used, for example, to add whitespace indentation.
71.Pp
72The sqlite3_str_reset(X) method resets the string
73under construction inside sqlite3_str object X back to zero
74bytes in length.
75.Pp
76These methods do not return a result code.
77If an error occurs, that fact is recorded in the sqlite3_str
78object and can be recovered by a subsequent call to sqlite3_str_errcode(X).
79.Sh SEE ALSO
80.Xr sqlite3_str 3 ,
81.Xr sqlite3_str_appendf 3 ,
82.Xr sqlite3_str_new 3
83