1.Dd December 19, 2018 2.Dt SQLITE3CHANGESET_FINALIZE 3 3.Os 4.Sh NAME 5.Nm sqlite3changeset_finalize 6.Nd Finalize A Changeset Iterator 7.Sh SYNOPSIS 8.Ft int 9.Fo sqlite3changeset_finalize 10.Fa "sqlite3_changeset_iter *pIter" 11.Fc 12.Sh DESCRIPTION 13This function is used to finalize an iterator allocated with sqlite3changeset_start(). 14.Pp 15This function should only be called on iterators created using the 16sqlite3changeset_start() function. 17If an application calls this function with an iterator passed to a 18conflict-handler by sqlite3changeset_apply(), 19SQLITE_MISUSE is immediately returned and the call has 20no effect. 21.Pp 22If an error was encountered within a call to an sqlite3changeset_xxx() 23function (for example an SQLITE_CORRUPT in sqlite3changeset_next() 24or an SQLITE_NOMEM in sqlite3changeset_new()) 25then an error code corresponding to that error is returned by this 26function. 27Otherwise, SQLITE_OK is returned. 28This is to allow the following pattern (pseudo-code): 29.Bd -literal 30sqlite3changeset_start(); while( SQLITE_ROW==sqlite3changeset_next() 31){ // Do something with change. 32} rc = sqlite3changeset_finalize(); if( rc!=SQLITE_OK ){ // An error 33has occurred } 34.Ed 35.Pp 36.Sh SEE ALSO 37.Xr sqlite3changeset_apply 3 , 38.Xr sqlite3changeset_new 3 , 39.Xr sqlite3changeset_next 3 , 40.Xr sqlite3changeset_start 3 , 41.Xr SQLITE_OK 3 42