From: drh Date: Fri, 11 Dec 2009 23:11:26 +0000 (+0000) Subject: Additional changes to C-language interface documentation. X-Git-Tag: version-3.7.2~711 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fb434036418e01e241bd7ec16a40bd85293ce6e5;p=thirdparty%2Fsqlite.git Additional changes to C-language interface documentation. FossilOrigin-Name: 1342916fd350d06e1c1f3d7d380249f0c9282c7b --- diff --git a/manifest b/manifest index f2584d5465..6d208602c0 100644 --- a/manifest +++ b/manifest @@ -1,5 +1,8 @@ -C Change\sthe\sfts3\stest\sinterface\sused\sto\sconfigure\sthe\sadvisory\snode\ssize\sparaemeter. -D 2009-12-11T16:03:45 +-----BEGIN PGP SIGNED MESSAGE----- +Hash: SHA1 + +C Additional\schanges\sto\sC-language\sinterface\sdocumentation. +D 2009-12-11T23:11:27 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0 F Makefile.in c5827ead754ab32b9585487177c93bb00b9497b3 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654 @@ -164,7 +167,7 @@ F src/resolve.c d052e5c44bab34f83b3c1741aaa07478d18b5dd5 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697 F src/select.c 68c58dc49341472e4e5661a47a1a9e5f8a161340 F src/shell.c f4948cb6d30665d755a6b5e0ec313d1094aab828 -F src/sqlite.h.in 4d7bcef44286d9c2ff968be8f51fbbd2b7e9e492 +F src/sqlite.h.in 0c73df1f6e82e18e24b5abe8a561abfa6d098b96 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89 F src/sqliteInt.h e946a6a3f2df015cdbc7668e9626987e8badbb5f F src/sqliteLimit.h 3afab2291762b5d09ae20c18feb8e9fa935a60a6 @@ -778,7 +781,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f -P 29476da353df4c67fe744c1c5f466ba5b9c1a54b -R 8ca2da08c312091c8993186dd9f053b6 -U dan -Z db31ff17c7c3485d488732b71bbeecde +P 87fc0ce151c89beb5a43b65c0b1706f340c0c173 +R b6b67451b1e0a7b9820d087eb26e450f +U drh +Z 763db5cb8f1e7f1ba88fe11712fa307e +-----BEGIN PGP SIGNATURE----- +Version: GnuPG v1.4.6 (GNU/Linux) + +iD8DBQFLItGjoxKgR168RlERAhmMAJ9m9BZSx/FxFUNPj9G9NQ3Jc6mFwgCfaZ8y +dtfT2OxwqJGAKinsW/tudQE= +=r4RM +-----END PGP SIGNATURE----- diff --git a/manifest.uuid b/manifest.uuid index 1a5f2d036a..38b40e7299 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -87fc0ce151c89beb5a43b65c0b1706f340c0c173 \ No newline at end of file +1342916fd350d06e1c1f3d7d380249f0c9282c7b \ No newline at end of file diff --git a/src/sqlite.h.in b/src/sqlite.h.in index 119f83b98c..d5170f9062 100644 --- a/src/sqlite.h.in +++ b/src/sqlite.h.in @@ -818,7 +818,7 @@ struct sqlite3_vfs { ** CAPI3REF: Flags for the xAccess VFS method ** ** These integer constants can be used as the third parameter to -** the xAccess method of an [sqlite3_vfs] object. {END} They determine +** the xAccess method of an [sqlite3_vfs] object. They determine ** what kind of permissions the xAccess method is looking for. ** With SQLITE_ACCESS_EXISTS, the xAccess method ** simply checks whether the file exists. @@ -964,14 +964,11 @@ SQLITE_EXPERIMENTAL int sqlite3_config(int, ...); ** ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if ** the call is considered successful. -** -** Requirements: -** [H14203] [H14206] [H14209] [H14212] [H14215] */ SQLITE_EXPERIMENTAL int sqlite3_db_config(sqlite3*, int op, ...); /* -** CAPI3REF: Memory Allocation Routines {H10155} +** CAPI3REF: Memory Allocation Routines ** EXPERIMENTAL ** ** An instance of this object defines the interface between SQLite @@ -1053,7 +1050,7 @@ struct sqlite3_mem_methods { }; /* -** CAPI3REF: Configuration Options {H10160} +** CAPI3REF: Configuration Options ** EXPERIMENTAL ** ** These constants are the available integer configuration options that @@ -1258,7 +1255,7 @@ struct sqlite3_mem_methods { #define SQLITE_CONFIG_GETPCACHE 15 /* sqlite3_pcache_methods* */ /* -** CAPI3REF: Configuration Options {H10170} +** CAPI3REF: Configuration Options ** EXPERIMENTAL ** ** These constants are the available integer configuration options that @@ -2501,7 +2498,7 @@ const char *sqlite3_sql(sqlite3_stmt *pStmt); typedef struct Mem sqlite3_value; /* -** CAPI3REF: SQL Function Context Object {H16001} +** CAPI3REF: SQL Function Context Object ** ** The context in which an SQL function executes is stored in an ** sqlite3_context object. ^A pointer to an sqlite3_context object @@ -2515,7 +2512,7 @@ typedef struct Mem sqlite3_value; typedef struct sqlite3_context sqlite3_context; /* -** CAPI3REF: Binding Values To Prepared Statements {H13500} +** CAPI3REF: Binding Values To Prepared Statements ** KEYWORDS: {host parameter} {host parameters} {host parameter name} ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} ** @@ -2862,7 +2859,8 @@ int sqlite3_step(sqlite3_stmt*); /* ** CAPI3REF: Number of columns in a result set ** -** ^Returns the number of values in the current row of the result set. +** ^The sqlite3_data_count(P) the number of columns in the +** of the result set of [prepared statement] P. */ int sqlite3_data_count(sqlite3_stmt *pStmt); @@ -2870,7 +2868,7 @@ int sqlite3_data_count(sqlite3_stmt *pStmt); ** CAPI3REF: Fundamental Datatypes ** KEYWORDS: SQLITE_TEXT ** -** {H10266} Every value in SQLite has one of five fundamental datatypes: +** ^(Every value in SQLite has one of five fundamental datatypes: ** **
    **
  • 64-bit signed integer @@ -2878,7 +2876,7 @@ int sqlite3_data_count(sqlite3_stmt *pStmt); **
  • string **
  • BLOB **
  • NULL -**
{END} +** )^ ** ** These constants are codes for each of those types. ** @@ -3581,7 +3579,7 @@ void sqlite3_result_zeroblob(sqlite3_context*, int n); ** ^The remaining arguments to the application-supplied routine are two strings, ** each represented by a (length, data) pair and encoded in the encoding ** that was passed as the third argument when the collation sequence was -** registered. {END} The application defined collation routine should +** registered. The application defined collation routine should ** return negative, zero or positive if the first string is less than, ** equal to, or greater than the second string. i.e. (STRING1 - STRING2). ** @@ -3620,7 +3618,7 @@ int sqlite3_create_collation16( ); /* -** CAPI3REF: Collation Needed Callbacks {H16700} +** CAPI3REF: Collation Needed Callbacks ** ** ^To avoid having to register all collation sequences before a database ** can be used, a single callback function may be registered with the @@ -3779,7 +3777,7 @@ sqlite3 *sqlite3_db_handle(sqlite3_stmt*); sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt); /* -** CAPI3REF: Commit And Rollback Notification Callbacks {H12950} +** CAPI3REF: Commit And Rollback Notification Callbacks ** ** ^The sqlite3_commit_hook() interface registers a callback ** function to be invoked whenever a transaction is [COMMIT | committed]. @@ -3953,7 +3951,7 @@ int sqlite3_release_memory(int); void sqlite3_soft_heap_limit(int); /* -** CAPI3REF: Extract Metadata About A Column Of A Table {H12850} +** CAPI3REF: Extract Metadata About A Column Of A Table ** ** ^This routine returns metadata about a specific column of a specific ** database table accessible using the [database connection] handle @@ -4258,7 +4256,7 @@ struct sqlite3_index_info { ** CAPI3REF: Register A Virtual Table Implementation ** EXPERIMENTAL ** -** ^This routine is used to register a new [virtual table module] name. +** ^These routines are used to register a new [virtual table module] name. ** ^Module names must be registered before ** creating a new [virtual table] using the module, or before using a ** preexisting [virtual table] for the module. @@ -4271,8 +4269,12 @@ struct sqlite3_index_info { ** into the [xCreate] and [xConnect] methods of the virtual table module ** when a new virtual table is be being created or reinitialized. ** -** ^This interface has exactly the same effect as calling -** [sqlite3_create_module_v2()] with a NULL client data destructor. +** ^The sqlite3_create_module_v2() interface has a fifth parameter which +** is a pointer to a destructor for the pClientData. ^SQLite will +** invoke the destructor function (if it is not NULL) when SQLite +** no longer needs the pClientData pointer. ^The sqlite3_create_module() +** interface is equivalent to sqlite3_create_module_v2() with a NULL +** destructor. */ SQLITE_EXPERIMENTAL int sqlite3_create_module( sqlite3 *db, /* SQLite connection to register module with */ @@ -4280,17 +4282,6 @@ SQLITE_EXPERIMENTAL int sqlite3_create_module( const sqlite3_module *p, /* Methods for the module */ void *pClientData /* Client data for xCreate/xConnect */ ); - -/* -** CAPI3REF: Register A Virtual Table Implementation -** EXPERIMENTAL -** -** ^This routine is identical to the [sqlite3_create_module()] method, -** except that it has an extra parameter to specify -** a destructor function for the client data pointer. ^SQLite will -** invoke the destructor function (if it is not NULL) when SQLite -** no longer needs the pClientData pointer. -*/ SQLITE_EXPERIMENTAL int sqlite3_create_module_v2( sqlite3 *db, /* SQLite connection to register module with */ const char *zName, /* Name of the module */ @@ -4405,7 +4396,7 @@ SQLITE_EXPERIMENTAL int sqlite3_overload_function(sqlite3*, const char *zFuncNam typedef struct sqlite3_blob sqlite3_blob; /* -** CAPI3REF: Open A BLOB For Incremental I/O {H17810} +** CAPI3REF: Open A BLOB For Incremental I/O ** ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located ** in row iRow, column zColumn, table zTable in database zDb; @@ -4873,7 +4864,7 @@ int sqlite3_mutex_notheld(sqlite3_mutex*); sqlite3_mutex *sqlite3_db_mutex(sqlite3*); /* -** CAPI3REF: Low-Level Control Of Database Files {H11300} +** CAPI3REF: Low-Level Control Of Database Files ** ** ^The [sqlite3_file_control()] interface makes a direct call to the ** xFileControl method for the [sqlite3_io_methods] object associated