sqlite3changeset_finalize(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
SQLITE3CHANGESET_FIN... NetBSD Library Functions ManualSQLITE3CHANGESET_FIN...


NAME

     sqlite3changeset_finalize -- finalize a changeset iterator


SYNOPSIS

     #include <sqlite3.h>

     int
     sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);


DESCRIPTION

     This function is used to finalize an iterator allocated with
     sqlite3changeset_start().  This function should only be called on itera-
     tors created using the sqlite3changeset_start() function.  If an applica-
     tion calls this function with an iterator passed to a conflict-handler by
     sqlite3changeset_apply(), SQLITE_MISUSE is immediately returned and the
     call has no effect.

     If an error was encountered within a call to an sqlite3changeset_xxx()
     function (for example an SQLITE_CORRUPT in sqlite3changeset_next() or an
     SQLITE_NOMEM in sqlite3changeset_new()) then an error code corresponding
     to that error is returned by this function.  Otherwise, SQLITE_OK is
     returned.  This is to allow the following pattern (pseudo-code):

     sqlite3changeset_start(); while( SQLITE_ROW==sqlite3changeset_next()
     ){ // Do something with change.
     } rc = sqlite3changeset_finalize(); if( rc!=SQLITE_OK ){ // An error
     has occurred }


IMPLEMENTATION NOTES

     These declarations were extracted from the interface documentation at
     line 11709.

     SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);


SEE ALSO

     sqlite3changeset_apply(3), sqlite3changeset_new(3),
     sqlite3changeset_next(3), sqlite3changeset_start(3), SQLITE_OK(3)

NetBSD 10.99                   January 24, 2024                   NetBSD 10.99