Simplified documentation for the pointer passing interface.

FossilOrigin-Name: 2dfcd9a8ecdf0ddd8e044d820639830c6171141c588cf0224255af85c64cf79c

diff --git a/manifest b/manifest
index fe093dce1e09a386fff040bab6acbec829f4040e..6da960e7a03fc1e433a482402eb61ac6fd787a69 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Add\sdestructor\sfunctions\sfor\sthe\spointer\sargument\s(NB:\snot\sthe\stype\sstring)\nto\sthe\ssqlite3_bind_pointer()\sand\ssqlite3_result_pointer()\sinterfaces.\s\sUse\nthis\snew\scapability\sto\sresolve\sa\spointer\sleak\sin\sthe\scustom\sgeometry\sfunction\nmechanism\sof\sthe\sRTREE\sextension.
-D 2017-07-27T17:45:08.840
+C Simplified\sdocumentation\sfor\sthe\spointer\spassing\sinterface.
+D 2017-07-27T18:43:13.023
 F Makefile.in d9873c9925917cca9990ee24be17eb9613a668012c85a343aef7e5536ae266e8
 F Makefile.linux-gcc 7bc79876b875010e8c8f9502eb935ca92aa3c434
 F Makefile.msc 02b469e9dcd5b7ee63fc1fb05babc174260ee4cfa4e0ef2e48c3c6801567a016
@@ -455,7 +455,7 @@ F src/rowset.c 7b7e7e479212e65b723bf40128c7b36dc5afdfac
 F src/select.c c6bf96a7f9d7d68f929de84738c599a30d0a725ab0b54420e70545743cd5ee7b
 F src/shell.c bd6a37cbe8bf64ef6a6a74fdc50f067d3148149b4ce2b4d03154663e66ded55f
 F src/shell.c.in b5725acacba95ccefa57b6d068f710e29ba8239c3aa704628a1902a1f729c175
-F src/sqlite.h.in 86a14aab0f03021bdc71e8a78091ca52931cdc3dc69633dacf9a511dfe9ee993
+F src/sqlite.h.in 0e2603c23f0747c5660669f946e231730af000c76d1653b153dcf2c26fce0a6b
 F src/sqlite3.rc 5121c9e10c3964d5755191c80dd1180c122fc3a8
 F src/sqlite3ext.h 0f9f72b86a3792314f5db7a1dfbc2c82376bcd8d0919ceb80637bca126ec3c68
 F src/sqliteInt.h bd6be75bc43d38ada272ef0b3472bc44ef0cc15536bea22c349ca1a2812a19ce
@@ -1637,8 +1637,7 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93
 F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc
 F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e
 F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0
-P f39cb76b3347baba22f2c329e74036710b64620414433a952de8d44da79ba8d9 d6684d2a744e6e04b8796c3b5ecb81c6577728b698c1ab5f4a828b2ac114b8a2
-R 94d2d6800509c651201392a359c9b77e
-T +closed d6684d2a744e6e04b8796c3b5ecb81c6577728b698c1ab5f4a828b2ac114b8a2
+P 5a2340b81faf0a29deb5b7c9a2ba6a7697d646de6cc4e9b2e6e5e6463fa394bd
+R 371adde7af7e490c29a3965ed217ae65
 U drh
-Z 1a620a1987be7e7a32507ea55728d87e
+Z 2e135a84e2e3ccffaa287c569d9bdf94

diff --git a/manifest.uuid b/manifest.uuid
index 935cff7820d75898b08d5843ededdb9464e38136..27050c0daedfe4cb8bc93033ef23d73e1b430cbc 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-5a2340b81faf0a29deb5b7c9a2ba6a7697d646de6cc4e9b2e6e5e6463fa394bd
\ No newline at end of file
+2dfcd9a8ecdf0ddd8e044d820639830c6171141c588cf0224255af85c64cf79c
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 93410d523fb8bad63593dba7dd70a506d0c2840c..e8f34e4ab28cc658ece32ace03477c868ce62078 100644 (file)
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -3886,17 +3886,11 @@ typedef struct sqlite3_context sqlite3_context;
 ** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
 ** [prepared statement] S to have an SQL value of NULL, but to also be
 ** associated with the pointer P of type T.  ^D is either a NULL pointer or
-** a pointer to a destructor function that is called when P goes out of scope.
-** ^The sqlite3_bind_pointer() routine can be used to pass
-** host-language pointers into [application-defined SQL functions].
-** ^A parameter that is initialized using [sqlite3_bind_pointer()] appears
-** to be an ordinary SQL NULL value to everything other than
-** [sqlite3_value_pointer()].  The T parameter should be a static string,
-** preferably a string literal.  The procedure that invokes 
-** sqlite3_bind_pointer(S,I,P,T,D) owns the T string and
-** must guarantee that it remains valid and unchanged until after the last
-** access via [sqlite3_value_pointer()].  The sqlite3_bind_pointer() routine
-** is part of the [pointer passing interface] added for SQLite 3.20.0.
+** a pointer to a destructor function for P. ^SQLite will invoke the
+** destructor D with a single argument of P when it is finished using
+** P.  The T parameter should be a static string, preferably a string
+** literal. The sqlite3_bind_pointer() routine is part of the
+** [pointer passing interface] added for SQLite 3.20.0.
 **
 ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
 ** for the [prepared statement] or with a prepared statement for which
@@ -4767,7 +4761,8 @@ SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
 ** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
 ** and if X and Y are strings that compare equal according to strcmp(X,Y),
 ** then sqlite3_value_pointer(V,Y) will return the pointer P.  ^Otherwise,
-** sqlite3_value_pointer(V,Y) returns a NULL.
+** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer() 
+** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
 **
 ** ^(The sqlite3_value_type(V) interface returns the
 ** [SQLITE_INTEGER | datatype code] for the initial datatype of the
@@ -5108,14 +5103,10 @@ typedef void (*sqlite3_destructor_type)(void*);
 ** NULL value such that the pointer can be retrieved within an
 ** [application-defined SQL function] using [sqlite3_value_pointer()].
 ** ^If the D parameter is not NULL, then it is a pointer to a destructor
-** for the P parameter.  ^The destructor D is invoked on P when the result
-** value goes out of scope.
-** The T parameter should be a static string and preferably a string
-** literal. The procedure that invokes sqlite3_result_pointer(C,P,T,D)
-** continues to own the P and T pointers and must guarantee that 
-** those pointers remain valid until after the last access via
-** [sqlite3_value_pointer()].  The sqlite3_result_pointer() routine
-** is part of the [pointer passing interface] added for SQLite 3.20.0.
+** for the P parameter.  ^SQLite invokes D with P as its only argument
+** when SQLite is finished with P.  The T parameter should be a static
+** string and preferably a string literal. The sqlite3_result_pointer()
+** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
 **
 ** If these routines are called from within the different thread
 ** than the one containing the application-defined function that received