Additional API documentation updates in sqlite.h.in. (CVS 4756)

FossilOrigin-Name: 9b6ab9faad39dd20d761efa68f137c596fbcd7a5
This commit is contained in:
drh 2008-01-31 12:26:49 +00:00
parent 33c1be3962
commit 21ac7f9dcd
3 changed files with 78 additions and 11 deletions

View File

@ -1,5 +1,5 @@
C Improvements\sto\sthe\sAPI\sdocumentation\sfound\sin\scomments\sin\sthe\ssqlite.h.in\nsource\sfile.\s(CVS\s4755)
D 2008-01-30T16:16:14
C Additional\sAPI\sdocumentation\supdates\sin\ssqlite.h.in.\s(CVS\s4756)
D 2008-01-31T12:26:50
F Makefile.arm-wince-mingw32ce-gcc ac5f7b2cef0cd850d6f755ba6ee4ab961b1fadf7
F Makefile.in bc2b5df3e3d0d4b801b824b7ef6dec43812b049b
F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@ -135,7 +135,7 @@ F src/random.c 02ef38b469237482f1ea14a78b2087cfbaec48bd
F src/select.c 1a5d0aaf8f420b164eb775d3b1ba2bfb79597f65
F src/server.c 087b92a39d883e3fa113cae259d64e4c7438bc96
F src/shell.c ca06cb687c40a8bff6307b5fad41a0e86a0f8558
F src/sqlite.h.in 14ad9ebfa35f3682d6e96af5d9d7d8fee9ce700c
F src/sqlite.h.in a65fd6667df5b8a8abc287edebe6b4b82c10cce1
F src/sqlite3ext.h a93f59cdee3638dc0c9c086f80df743a4e68c3cb
F src/sqliteInt.h b006a4d887af1ce273683cc4874a506254068dbd
F src/sqliteLimit.h ee4430f88f69bf63527967bb35ca52af7b0ccb1e
@ -614,7 +614,7 @@ F www/tclsqlite.tcl 8be95ee6dba05eabcd27a9d91331c803f2ce2130
F www/vdbe.tcl 87a31ace769f20d3627a64fa1fade7fed47b90d0
F www/version3.tcl 890248cf7b70e60c383b0e84d77d5132b3ead42b
F www/whentouse.tcl fc46eae081251c3c181bd79c5faef8195d7991a5
P e01f9ed9450d3e23fc052e1b779c7a1965e76f7e
R 641c42d99396a9977a46f015bf233d32
P 0b8b5c2e833c90aec1c14d16c12334e01b50f35f
R 113395e4e14d7af9c66f7bdd06d5b190
U drh
Z 2835805394c64fcc6fc8489fa18a7daa
Z 7adba9c8b04c8c53a7557bb15857b7f9

View File

@ -1 +1 @@
0b8b5c2e833c90aec1c14d16c12334e01b50f35f
9b6ab9faad39dd20d761efa68f137c596fbcd7a5

View File

@ -30,7 +30,7 @@
** the version number) and changes its name to "sqlite3.h" as
** part of the build process.
**
** @(#) $Id: sqlite.h.in,v 1.279 2008/01/30 16:16:14 drh Exp $
** @(#) $Id: sqlite.h.in,v 1.280 2008/01/31 12:26:50 drh Exp $
*/
#ifndef _SQLITE3_H_
#define _SQLITE3_H_
@ -1299,7 +1299,7 @@ int sqlite3_busy_timeout(sqlite3*, int ms);
** result set of the query into *nrow if the query is
** successful (if the function returns SQLITE_OK).
**
** {F12373} The [sqlite3_get_table()] function sets its *ncolumn value
** {F12376} The [sqlite3_get_table()] function sets its *ncolumn value
** to the number of columns in the result set of the query in the
** sql parameter, or to zero if the query in sql has an empty
** result set.
@ -3112,6 +3112,61 @@ int sqlite3_data_count(sqlite3_stmt *pStmt);
** is either the integer 0, the floating point number 0.0, or a NULL
** pointer. Subsequent calls to [sqlite3_errcode()] will return
** [SQLITE_NOMEM].
**
** INVARIANTS:
**
** {F13803} The [sqlite3_column_blob(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a blob and then returns a
** pointer to the converted value.
**
** {F13806} The [sqlite3_column_bytes(S,N)] interface returns the
** number of bytes in the blob or string (exclusive of the
** zero terminator on the string) that was returned by the
** most recent call to [sqlite3_column_blob(S,N)] or
** [sqlite3_column_text(S,N)].
**
** {F13809} The [sqlite3_column_bytes16(S,N)] interface returns the
** number of bytes in the string (exclusive of the
** zero terminator on the string) that was returned by the
** most recent call to [sqlite3_column_text16(S,N)].
**
** {F13812} The [sqlite3_column_double(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a floating point value and
** returns a copy of that value.
**
** {F13815} The [sqlite3_column_int(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a 32-bit signed integer and
** returns a copy of that integer.
**
** {F13818} The [sqlite3_column_int64(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a 64-bit signed integer and
** returns a copy of that integer.
**
** {F13821} The [sqlite3_column_text(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a zero-terminated UTF-8
** string and returns a pointer to that string.
**
** {F13824} The [sqlite3_column_text16(S,N)] interface converts the
** Nth column in the current row of the result set for
** [prepared_statement] S into a zero-terminated 2-byte
** aligned UTF-16 native byte order
** string and returns a pointer to that string.
**
** {F13827} The [sqlite3_column_type(S,N)] interface returns
** one of [SQLITE_NULL], [SQLITE_INTEGER], [SQLITE_REAL],
** [SQLITE_TEXT], or [SQLITE_BLOB] as appropriate for
** the Nth column in the current row of the result set for
** [prepared_statement] S.
**
** {F13830} The [sqlite3_column_value(S,N)] interface returns a
** pointer to the [sqlite3_value] object that for the
** Nth column in the current row of the result set for
** [prepared_statement] S.
*/
const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
@ -3183,8 +3238,10 @@ int sqlite3_reset(sqlite3_stmt *pStmt);
/*
** CAPI3REF: Create Or Redefine SQL Functions {F16100}
** KEYWORDS: {function creation routines}
**
** The following two functions are used to add SQL functions or aggregates
** These two 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
** difference only between the two is that the second parameter, the
** name of the (scalar) function or aggregate, is encoded in UTF-8 for
@ -3238,6 +3295,16 @@ int sqlite3_reset(sqlite3_stmt *pStmt);
** arguments or differing perferred text encodings. SQLite will use
** the implementation most closely matches the way in which the
** SQL function is used.
**
** INVARIANTS:
**
** {F16103} The [sqlite3_create_function16()] interface behaves exactly
** like [sqlite3_create_function()] in every way except that it
** interprets the zFunctionName argument as
** zero-terminated UTF-16 native byte order instead of as a
** zero-terminated UTF-8.
**
** {F16106}
*/
int sqlite3_create_function(
sqlite3 *db,
@ -4097,7 +4164,7 @@ int sqlite3_auto_extension(void *xEntryPoint);
**
** {F12661} This function disables all previously registered
** automatic extensions. {END} This
** routine undoes the effect of all prior [sqlite3_automatic_extension()]
** routine undoes the effect of all prior [sqlite3_auto_extension()]
** calls.
**
** {F12662} This call disabled automatic extensions in all threads. {END}