xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3changeset_next.3 (revision 7330f729ccf0bd976a06f95fad452fe774fc7fd1)
1.Dd December 19, 2018
2.Dt SQLITE3CHANGESET_NEXT 3
3.Os
4.Sh NAME
5.Nm sqlite3changeset_next
6.Nd Advance A Changeset Iterator
7.Sh SYNOPSIS
8.Ft int
9.Fo sqlite3changeset_next
10.Fa "sqlite3_changeset_iter *pIter"
11.Fc
12.Sh DESCRIPTION
13This function may only be used with iterators created by function sqlite3changeset_start().
14If it is called on an iterator passed to a conflict-handler callback
15by sqlite3changeset_apply(), SQLITE_MISUSE
16is returned and the call has no effect.
17.Pp
18Immediately after an iterator is created by sqlite3changeset_start(),
19it does not point to any change in the changeset.
20Assuming the changeset is not empty, the first call to this function
21advances the iterator to point to the first change in the changeset.
22Each subsequent call advances the iterator to point to the next change
23in the changeset (if any).
24If no error occurs and the iterator points to a valid change after
25a call to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
26Otherwise, if all changes in the changeset have already been visited,
27SQLITE_DONE is returned.
28.Pp
29If an error occurs, an SQLite error code is returned.
30Possible error codes include SQLITE_CORRUPT (if the changeset buffer
31is corrupt) or SQLITE_NOMEM.
32.Sh SEE ALSO
33.Xr sqlite3changeset_apply 3 ,
34.Xr sqlite3changeset_start 3
35