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