From: drh Date: Fri, 10 Sep 2010 16:38:30 +0000 (+0000) Subject: Updates to the documentation on the sqlite3_create_function() family of X-Git-Tag: experimental~47 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c20207374de350adeedbab1817979d68f00066f7;p=thirdparty%2Fsqlite.git Updates to the documentation on the sqlite3_create_function() family of interfaces. FossilOrigin-Name: 9d277e0b82ff8759369b43ee5f2e5628724a84bd --- diff --git a/manifest b/manifest index 660e5860bc..0821521265 100644 --- a/manifest +++ b/manifest @@ -1,8 +1,8 @@ -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 -C Make\ssure\sSQLite\sis\srunning\swith\sMEMSTATUS\senabled\sat\sthe\sbeginning\sof\nevery\stest\sscript. -D 2010-09-10T13:23:00 +C Updates\sto\sthe\sdocumentation\son\sthe\ssqlite3_create_function()\sfamily\sof\ninterfaces. +D 2010-09-10T16:38:30 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f F Makefile.in c599a15d268b1db2aeadea19df2adc3bf2eb6bee F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23 @@ -177,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 0b4284c09f25406bfb2bf93784fae02cbd737773 +F src/sqlite.h.in 4c33ee7e9c6dc1ac4fe07a8810285982ac40975b F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89 F src/sqliteInt.h 81343db96497aebf81dff9c695dfd29699b377b3 F src/sqliteLimit.h a17dcd3fb775d63b64a43a55c54cb282f9726f44 @@ -860,14 +860,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f -P c23b97219df43a870c6cb2aac84e54aaa5db4f3a -R 690b86651016964cb6c585f5663514da +P 699953140511c14cbba499fad086187977476660 +R a98222a511f2ce08f191c79b06034362 U drh -Z af87d1a482e7680c020abb1599e233d7 +Z ac14bd325befba7c1df6ebb4d19b0458 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (GNU/Linux) -iD8DBQFMijNvoxKgR168RlERAiJPAJ9vKY/leUtbcNkIXYMghZ/BlKvPcACfbHML -M80lH+VrkbAsjRlvmGuGhCE= -=6NrJ +iD8DBQFMil8JoxKgR168RlERApA9AJsGDcvyR1yXt0v3ZLCL+dsSWgyOgwCfUjgT +rY5I/OHNQz+JOmEpvVLOp0c= +=Ps59 -----END PGP SIGNATURE----- diff --git a/manifest.uuid b/manifest.uuid index c4b5992fce..5307db30e7 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -699953140511c14cbba499fad086187977476660 \ No newline at end of file +9d277e0b82ff8759369b43ee5f2e5628724a84bd \ No newline at end of file diff --git a/src/sqlite.h.in b/src/sqlite.h.in index 0fda216235..b08f4bd410 100644 --- a/src/sqlite.h.in +++ b/src/sqlite.h.in @@ -3290,21 +3290,22 @@ int sqlite3_reset(sqlite3_stmt *pStmt); ** KEYWORDS: {application-defined SQL function} ** KEYWORDS: {application-defined SQL functions} ** -** ^These two functions (collectively known as "function creation routines") +** ^These functions (collectively known as "function creation routines") ** are used to add SQL functions or aggregates or to redefine the behavior -** of existing SQL functions or aggregates. The only difference between the -** two is that the second parameter, the name of the (scalar) function or -** aggregate, is encoded in UTF-8 for sqlite3_create_function() and UTF-16 -** for sqlite3_create_function16(). +** of existing SQL functions or aggregates. The only differences between +** these routines are the text encoding expected for +** the the second parameter (the name of the function being created) +** and the presence or absence of a destructor callback for +** the application data pointer. ** ** ^The first parameter is the [database connection] to which the SQL ** function is to be added. ^If an application uses more than one database ** connection then application-defined SQL functions must be added ** to each database connection separately. ** -** The second parameter is the name of the SQL function to be created or +** ^The second parameter is the name of the SQL function to be created or ** redefined. ^The length of the name is limited to 255 bytes, exclusive of -** the zero-terminator. Note that the name length limit is in bytes, not +** the zero-terminator. ^Note that the name length limit is in bytes, not ** characters. ^Any attempt to create a function with a longer name ** will result in [SQLITE_ERROR] being returned. ** @@ -3316,7 +3317,7 @@ int sqlite3_reset(sqlite3_stmt *pStmt); ** parameter is less than -1 or greater than 127 then the behavior is ** undefined. ** -** The fourth parameter, eTextRep, specifies what +** ^The fourth parameter, eTextRep, specifies what ** [SQLITE_UTF8 | text encoding] this SQL function prefers for ** its parameters. Any SQL function implementation should be able to work ** work with UTF-8, UTF-16le, or UTF-16be. But some implementations may be @@ -3331,13 +3332,14 @@ int sqlite3_reset(sqlite3_stmt *pStmt); ** ^(The fifth parameter is an arbitrary pointer. The implementation of the ** function can gain access to this pointer using [sqlite3_user_data()].)^ ** -** The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are +** ^The seventh, eighth and ninth parameters, xFunc, xStep and xFinal, are ** pointers to C-language functions that implement the SQL function or ** aggregate. ^A scalar SQL function requires an implementation of the xFunc -** callback only; NULL pointers should be passed as the xStep and xFinal +** callback only; NULL pointers must be passed as the xStep and xFinal ** parameters. ^An aggregate SQL function requires an implementation of xStep -** and xFinal and NULL should be passed for xFunc. ^To delete an existing -** SQL function or aggregate, pass NULL for all three function callbacks. +** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing +** SQL function or aggregate, pass NULL poiners for all three function +** callbacks. ** ** ^It is permitted to register multiple implementations of the same ** functions with the same name but with either differing numbers of