Updates to the sqlite3_get_table() documentation.

FossilOrigin-Name: c7aa238c3797d8f735739a182d18aeada089def2

diff --git a/manifest b/manifest
index c7d447072faaaf9ccd0ba317485e322d86243071..45598e705f27b342c0a6f0a9f0362b0936d70a59 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,8 +1,8 @@
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1
 
-C Update\sthe\sversion\snumber\sto\s3.7.3\sin\spreparation\sfor\sthe\snext\srelease.
-D 2010-09-28T07:24:50
+C Updates\sto\sthe\ssqlite3_get_table()\sdocumentation.
+D 2010-09-28T13:12:51
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in c599a15d268b1db2aeadea19df2adc3bf2eb6bee
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -178,7 +178,7 @@ F src/resolve.c 1c0f32b64f8e3f555fe1f732f9d6f501a7f05706
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c cf3013b1953348c7c6ff9636342e87b9fda68466
 F src/shell.c 8517fc1f9c59ae4007e6cc8b9af91ab231ea2056
-F src/sqlite.h.in dae3f74d7b2b516967ede39b8e503718b571d9da
+F src/sqlite.h.in 4d59b9292a52d5601a050e29a3508e5c0a2821fa
 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89
 F src/sqliteInt.h 224c8e31f88489ea015c695bcf1877f3701b404c
 F src/sqliteLimit.h a17dcd3fb775d63b64a43a55c54cb282f9726f44
@@ -871,14 +871,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P 1f7ef0af8d9e41cd41f9046d198132eabd89ab18
-R c1de76a1e20bf82edb6f300a802e755a
+P 88108fff672b6012ffe87ba4b1efe6d5a07037d1
+R 62eb83ce7402078eda4d46a3720d1bc0
 U drh
-Z cfe1b7fddad23a17ff19d611bd0a56de
+Z e1fc9f70b217665fc93baf8f4f7536cd
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.6 (GNU/Linux)
 
-iD8DBQFMoZhFoxKgR168RlERAg8aAJ4muhcUyw4IlMoQ+uexHKZh/O9mPACeLhtt
-jdkGg7eouzypFikYLrYAMrI=
-=ICt4
+iD8DBQFMoenWoxKgR168RlERAp4pAJ0T37hXwFJQ2aW/fE3pt0QiFBp7lwCcCaGF
+XLDtZ232M8EgPmyFmr14UCk=
+=+VhH
 -----END PGP SIGNATURE-----

diff --git a/manifest.uuid b/manifest.uuid
index 2354fb07881d957f8a088d0ced7de3a87044e383..a1b9217a671b9877a86f42a1d724ca08d31548c8 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-88108fff672b6012ffe87ba4b1efe6d5a07037d1
\ No newline at end of file
+c7aa238c3797d8f735739a182d18aeada089def2
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index d54f9743bf563c2440fde43750a44e2335bd282c..90c3b6e7db5836383db0aca4e1982bbe60dc26db 100644 (file)
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -1731,6 +1731,9 @@ int sqlite3_busy_timeout(sqlite3*, int ms);
 /*
 ** CAPI3REF: Convenience Routines For Running Queries
 **
+** This is a legacy interface that is preserved for backwards compatibility.
+** Use of this interface is not recommended.
+**
 ** Definition: A <b>result table</b> is memory data structure created by the
 ** [sqlite3_get_table()] interface.  A result table records the
 ** complete query results from one or more queries.
@@ -1751,7 +1754,7 @@ int sqlite3_busy_timeout(sqlite3*, int ms);
 ** It is not safe to pass a result table directly to [sqlite3_free()].
 ** A result table should be deallocated using [sqlite3_free_table()].
 **
-** As an example of the result table format, suppose a query result
+** ^(As an example of the result table format, suppose a query result
 ** is as follows:
 **
 ** <blockquote><pre>
@@ -1775,7 +1778,7 @@ int sqlite3_busy_timeout(sqlite3*, int ms);
 **        azResult&#91;5] = "28";
 **        azResult&#91;6] = "Cindy";
 **        azResult&#91;7] = "21";
-** </pre></blockquote>
+** </pre></blockquote>)^
 **
 ** ^The sqlite3_get_table() function evaluates one or more
 ** semicolon-separated SQL statements in the zero-terminated UTF-8
@@ -1783,19 +1786,19 @@ int sqlite3_busy_timeout(sqlite3*, int ms);
 ** pointer given in its 3rd parameter.
 **
 ** After the application has finished with the result from sqlite3_get_table(),
-** it should pass the result table pointer to sqlite3_free_table() in order to
+** it must pass the result table pointer to sqlite3_free_table() in order to
 ** release the memory that was malloced.  Because of the way the
 ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
 ** function must not try to call [sqlite3_free()] directly.  Only
 ** [sqlite3_free_table()] is able to release the memory properly and safely.
 **
-** ^(The sqlite3_get_table() interface is implemented as a wrapper around
+** The sqlite3_get_table() interface is implemented as a wrapper around
 ** [sqlite3_exec()].  The sqlite3_get_table() routine does not have access
 ** to any internal data structures of SQLite.  It uses only the public
 ** interface defined here.  As a consequence, errors that occur in the
 ** wrapper layer outside of the internal [sqlite3_exec()] call are not
 ** reflected in subsequent calls to [sqlite3_errcode()] or
-** [sqlite3_errmsg()].)^
+** [sqlite3_errmsg()].
 */
 int sqlite3_get_table(
   sqlite3 *db,          /* An open database */