Index: www/capi3ref.tcl
==================================================================
--- www/capi3ref.tcl
+++ www/capi3ref.tcl
@@ -1,6 +1,6 @@
-set rcsid {$Id: capi3ref.tcl,v 1.6 2004/07/21 14:07:58 drh Exp $}
+set rcsid {$Id: capi3ref.tcl,v 1.7 2004/07/22 15:45:16 drh Exp $}
source common.tcl
header {C/C++ Interface For SQLite Version 3}
puts {
C/C++ Interface For SQLite Version 3
}
@@ -102,11 +102,11 @@
Bindings are not reset by the sqlite3_reset() routine.
Unbound wildcards are interpreted as NULL.
}
api {} {
- int sqlite3_busy_handler(sqlite*, int(*)(void*,int), void*);
+ int sqlite3_busy_handler(sqlite3*, int(*)(void*,int), void*);
} {
This routine identifies a callback function that is invoked
whenever an attempt is made to open a database table that is
currently locked by another process or thread. If the busy callback
is NULL, then sqlite3_exec() returns SQLITE_BUSY immediately if
@@ -127,11 +127,11 @@
data structures out from under the executing query and will
probably result in a coredump.
}
api {} {
- int sqlite3_busy_timeout(sqlite*, int ms);
+ int sqlite3_busy_timeout(sqlite3*, int ms);
} {
This routine sets a busy handler that sleeps for a while when a
table is locked. The handler will sleep multiple times until
at least "ms" milleseconds of sleeping have been done. After
"ms" milleseconds of sleeping, the handler returns 0 which
@@ -140,11 +140,11 @@
Calling this routine with an argument less than or equal to zero
turns off all busy handlers.
}
api {} {
- int sqlite3_changes(sqlite*);
+ int sqlite3_changes(sqlite3*);
} {
This function returns the number of database rows that were changed
(or inserted or deleted) by the most recently completed
INSERT, UPDATE, or DELETE
statement. Only changes that are directly specified by the INSERT,
@@ -164,11 +164,11 @@
table. To get an accurate count of the number of rows deleted, use
"DELETE FROM table WHERE 1" instead.
}
api {} {
- int sqlite3_total_changes(sqlite*);
+ int sqlite3_total_changes(sqlite3*);
} {
This function returns the total number of database rows that have
be modified, inserted, or deleted since the database connection was
created using sqlite3_open(). All changes are counted, including
changes by triggers and changes to TEMP and auxiliary databases.
@@ -186,11 +186,11 @@
table. To get an accurate count of the number of rows deleted, use
"DELETE FROM table WHERE 1" instead.
}
api {} {
- int sqlite3_close(sqlite *);
+ int sqlite3_close(sqlite3*);
} {
Call this function with a pointer to a structure that was previously
returned from sqlite3_open() or sqlite3_open16()
and the corresponding database will by closed.
@@ -315,11 +315,11 @@
second function parameter. The string returned is UTF-8 for
sqlite3_column_name() and UTF-16 for sqlite3_column_name16().
}
api {} {
-void *sqlite3_commit_hook(sqlite*, int(*xCallback)(void*), void *pArg);
+void *sqlite3_commit_hook(sqlite3*, int(*xCallback)(void*), void *pArg);
} {
Experimental
Register a callback function to be invoked whenever a new transaction
is committed. The pArg argument is passed through to the callback.
@@ -531,11 +531,11 @@
successful.
}
api {} {
int sqlite3_exec(
- sqlite*, /* An open database */
+ sqlite3*, /* An open database */
const char *sql, /* SQL to be executed */
sqlite_callback, /* Callback function */
void *, /* 1st argument to callback function */
char **errmsg /* Error msg written here */
);
@@ -607,11 +607,11 @@
sqlite3_mprintf() or sqlite3_vmprintf().
}
api {} {
int sqlite3_get_table(
- sqlite*, /* An open database */
+ sqlite3*, /* An open database */
const char *sql, /* SQL to be executed */
char ***resultp, /* Result written to a char *[] that this points to */
int *nrow, /* Number of result rows written here */
int *ncolumn, /* Number of result columns written here */
char **errmsg /* Error msg written here */
@@ -662,21 +662,21 @@
The return value of this routine is the same as from sqlite3_exec().
}
api {sqlite3_interrupt} {
- void sqlite3_interrupt(sqlite*);
+ void sqlite3_interrupt(sqlite3*);
} {
This function causes any pending database operation to abort and
return at its earliest opportunity. This routine is typically
called in response to a user action such as pressing "Cancel"
or Ctrl-C where the user wants a long query operation to halt
immediately.
} {}
api {} {
-long long int sqlite3_last_insert_rowid(sqlite*);
+long long int sqlite3_last_insert_rowid(sqlite3*);
} {
Each entry in an SQLite table has a unique integer key. (The key is
the value of the INTEGER PRIMARY KEY column if there is such a column,
otherwise the key is generated at random. The unique key is always
available as the ROWID, OID, or _ROWID_ column.) The following routine
@@ -805,11 +805,11 @@
On success, SQLITE_OK is returned. Otherwise an error code is returned.
}
api {} {
-void sqlite3_progress_handler(sqlite*, int, int(*)(void*), void*);
+void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
} {
Experimental
This routine configures a callback function - the progress callback - that
is invoked periodically during long running calls to sqlite3_exec(),
@@ -870,11 +870,11 @@
for additional information.
}
api {} {
int sqlite3_set_authorizer(
- sqlite*,
+ sqlite3*,
int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
void *pUserData
);
#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
@@ -965,11 +965,11 @@
SQLITE_DONE. Or it could be the case the the same database connection
is being used simulataneously by two or more threads.
}
api {} {
-void *sqlite3_trace(sqlite*, void(*xTrace)(void*,const char*), void*);
+void *sqlite3_trace(sqlite3*, void(*xTrace)(void*,const char*), void*);
} {
Register a function that is called at every invocation of sqlite3_exec()
or sqlite3_prepare(). This function can be used (for example) to generate
a log file of all SQL executed against a database. This is frequently
useful when debugging an application that uses SQLite.