From: drh <drh@noemail.net>
Date: Wed, 15 Sep 2010 23:41:24 +0000 (+0000)
Subject: Updates to the sqlite3_progress_handler() documentation.
X-Git-Tag: experimental~28
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ddbb6b48c9818d5cfb8b787cc9dff49789136bae;p=thirdparty%2Fsqlite.git

Updates to the sqlite3_progress_handler() documentation.

FossilOrigin-Name: 78f659ee9bb60df3503998301b554fe81fa6bdd3
---

diff --git a/manifest b/manifest
index b697940a46..e6cad06192 100644
--- a/manifest
+++ b/manifest
@@ -1,5 +1,8 @@
-C Add\stests\sfor\sORDER\sBY\sclauses\sto\se_select.test.
-D 2010-09-15T19:02:15
+-----BEGIN PGP SIGNED MESSAGE-----
+Hash: SHA1
+
+C Updates\sto\sthe\ssqlite3_progress_handler()\sdocumentation.
+D 2010-09-15T23:41:24
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in c599a15d268b1db2aeadea19df2adc3bf2eb6bee
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -174,7 +177,7 @@ F src/resolve.c 1c0f32b64f8e3f555fe1f732f9d6f501a7f05706
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c b0b124781474e4e0c8f64022875e5e2009e13443
 F src/shell.c 8517fc1f9c59ae4007e6cc8b9af91ab231ea2056
-F src/sqlite.h.in f12039ff7abd1de321a799023e9611747a25cbf8
+F src/sqlite.h.in f49225203481147f42df8939bf46290057898571
 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89
 F src/sqliteInt.h ef7ed8746759c09edd87e5550de973a4da3e4ca7
 F src/sqliteLimit.h a17dcd3fb775d63b64a43a55c54cb282f9726f44
@@ -857,7 +860,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P 82268a2c3d75431cd40de6ad09d398729de32a29
-R 48a80b0cb89bcc7b71e963e4d1b3c7ea
-U dan
-Z f68af529d6b5be773510b84a0d6c9b0e
+P 14f156632729d1a44ef234f39ff9df32db6b308a
+R d553d625fffd87b4f35a681bb7a245ce
+U drh
+Z 0d39acdb955e95d3736b9e8eb9643b00
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1.4.6 (GNU/Linux)
+
+iD8DBQFMkVmooxKgR168RlERAgNmAJoDiKM26gmlvaa5t8E8s8hnaY4+pACgim5h
+26XMQhRVu2SUorfyCfdexXo=
+=Y4G6
+-----END PGP SIGNATURE-----
diff --git a/manifest.uuid b/manifest.uuid
index cac73ad4ac..f0da3184ba 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-14f156632729d1a44ef234f39ff9df32db6b308a
\ No newline at end of file
+78f659ee9bb60df3503998301b554fe81fa6bdd3
\ No newline at end of file
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 4e836f513b..cfcfd99080 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -2207,17 +2207,28 @@ SQLITE_EXPERIMENTAL void *sqlite3_profile(sqlite3*,
 /*
 ** CAPI3REF: Query Progress Callbacks
 **
-** ^This routine configures a callback function - the
-** progress callback - that is invoked periodically during long
-** running calls to [sqlite3_exec()], [sqlite3_step()] and
-** [sqlite3_get_table()].  An example use for this
+** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
+** function X to be invoked periodically during long running calls to
+** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
+** database connection D.  An example use for this
 ** interface is to keep a GUI updated during a large query.
 **
+** ^The parameter P is passed through as the only parameter to the 
+** callback function X.  ^The parameter N is the number of 
+** [virtual machine instructions] that are evaluated between successive
+** invocations of the callback X.
+**
+** ^Only a single progress handler may be defined at one time per
+** [database connection]; setting a new progress handler cancels the
+** old one.  ^Setting parameter X to NULL disables the progress handler.
+** ^The progress handler is also disabled by setting N to a value less
+** than 1.
+**
 ** ^If the progress callback returns non-zero, the operation is
 ** interrupted.  This feature can be used to implement a
 ** "Cancel" button on a GUI progress dialog box.
 **
-** The progress handler must not do anything that will modify
+** The progress handler callback must not do anything that will modify
 ** the database connection that invoked the progress handler.
 ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
 ** database connections for the meaning of "modify" in this paragraph.