hlreq.html

sqlite的帮助文档

  int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
  int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  int (*xSectorSize)(sqlite3_file*);
  int (*xDeviceCharacteristics)(sqlite3_file*);
  /* Additional methods may be added in future releases */
};

</pre></blockquote></td></tr><tr><td valign="top">H11140</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
typedef struct sqlite3_vfs sqlite3_vfs;
struct sqlite3_vfs {
  int iVersion;            /* Structure version number */
  int szOsFile;            /* Size of subclassed sqlite3_file */
  int mxPathname;          /* Maximum file pathname length */
  sqlite3_vfs *pNext;      /* Next registered VFS */
  const char *zName;       /* Name of this virtual file system */
  void *pAppData;          /* Pointer to application-specific data */
  int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
               int flags, int *pOutFlags);
  int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
  int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
  int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
  void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
  void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
  void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol);
  void (*xDlClose)(sqlite3_vfs*, void*);
  int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
  int (*xSleep)(sqlite3_vfs*, int microseconds);
  int (*xCurrentTime)(sqlite3_vfs*, double*);
  int (*xGetLastError)(sqlite3_vfs*, int, char *);
  /* New fields may be appended in figure versions.  The iVersion
  ** value will increment whenever this happens. */
};

</pre></blockquote></td></tr><tr><td valign="top">H11190</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
#define SQLITE_ACCESS_EXISTS    0
#define SQLITE_ACCESS_READWRITE 1
#define SQLITE_ACCESS_READ      2

</pre></blockquote></td></tr><tr><td valign="top">H11200</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
int sqlite3_vfs_unregister(sqlite3_vfs*);

</pre></blockquote></td></tr><tr><td valign="top">H11203</td><td valign="top">The <a href="c3ref/vfs_find.html">sqlite3_vfs_find(N)</a> interface returns a pointer to the
registered <a href="c3ref/vfs.html">sqlite3_vfs</a> object whose name exactly matches
the zero-terminated UTF-8 string N, or it returns NULL if
there is no match. </td></tr><tr><td valign="top">H11206</td><td valign="top">If the N parameter to <a href="c3ref/vfs_find.html">sqlite3_vfs_find(N)</a> is NULL then
the function returns a pointer to the default <a href="c3ref/vfs.html">sqlite3_vfs</a>
object if there is one, or NULL if there is no default
<a href="c3ref/vfs.html">sqlite3_vfs</a> object. </td></tr><tr><td valign="top">H11209</td><td valign="top">The <a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface registers the
well-formed <a href="c3ref/vfs.html">sqlite3_vfs</a> object P using the name given
by the zName field of the object. </td></tr><tr><td valign="top">H11212</td><td valign="top">Using the <a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface to register
the same <a href="c3ref/vfs.html">sqlite3_vfs</a> object multiple times is a harmless no-op. </td></tr><tr><td valign="top">H11215</td><td valign="top">The <a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface makes the <a href="c3ref/vfs.html">sqlite3_vfs</a>
object P the default <a href="c3ref/vfs.html">sqlite3_vfs</a> object if F is non-zero. </td></tr><tr><td valign="top">H11218</td><td valign="top">The <a href="c3ref/vfs_find.html">sqlite3_vfs_unregister(P)</a> interface unregisters the
<a href="c3ref/vfs.html">sqlite3_vfs</a> object P so that it is no longer returned by
subsequent calls to <a href="c3ref/vfs_find.html">sqlite3_vfs_find()</a>. </td></tr><tr><td valign="top">H11300</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);

</pre></blockquote></td></tr><tr><td valign="top">H11302</td><td valign="top">The <a href="c3ref/finalize.html">sqlite3_finalize(S)</a> interface destroys the
<a href="c3ref/stmt.html">prepared statement</a> S and releases all
memory and file resources held by that object. </td></tr><tr><td valign="top">H11304</td><td valign="top">If the most recent call to <a href="c3ref/step.html">sqlite3_step(S)</a> for the
<a href="c3ref/stmt.html">prepared statement</a> S returned an error,
then <a href="c3ref/finalize.html">sqlite3_finalize(S)</a> returns that same error. </td></tr><tr><td valign="top">H11310</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
#define SQLITE_FCNTL_LOCKSTATE        1

</pre></blockquote></td></tr><tr><td valign="top">H11400</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_test_control(int op, ...);

</pre></blockquote></td></tr><tr><td valign="top">H11410</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
#define SQLITE_TESTCTRL_PRNG_SAVE                5
#define SQLITE_TESTCTRL_PRNG_RESTORE             6
#define SQLITE_TESTCTRL_PRNG_RESET               7
#define SQLITE_TESTCTRL_BITVEC_TEST              8
#define SQLITE_TESTCTRL_FAULT_INSTALL            9
#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS     10

</pre></blockquote></td></tr><tr><td valign="top">H12000</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
typedef struct sqlite3 sqlite3;

</pre></blockquote></td></tr><tr><td valign="top">H12010</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_close(sqlite3 *);

</pre></blockquote></td></tr><tr><td valign="top">H12011</td><td valign="top">A successful call to <a href="c3ref/close.html">sqlite3_close(C)</a> shall destroy the
<a href="c3ref/sqlite3.html">database connection</a> object C. </td></tr><tr><td valign="top">H12012</td><td valign="top">A successful call to <a href="c3ref/close.html">sqlite3_close(C)</a> shall return SQLITE_OK. </td></tr><tr><td valign="top">H12013</td><td valign="top">A successful call to <a href="c3ref/close.html">sqlite3_close(C)</a> shall release all
memory and system resources associated with <a href="c3ref/sqlite3.html">database connection</a>
C. </td></tr><tr><td valign="top">H12014</td><td valign="top">A call to <a href="c3ref/close.html">sqlite3_close(C)</a> on a <a href="c3ref/sqlite3.html">database connection</a> C that
has one or more open <a href="c3ref/stmt.html">prepared statements</a> shall fail with
an <a href="c3ref/c_abort.html">SQLITE_BUSY</a> error code. </td></tr><tr><td valign="top">H12015</td><td valign="top">A call to <a href="c3ref/close.html">sqlite3_close(C)</a> where C is a NULL pointer shall
be a harmless no-op returning SQLITE_OK. </td></tr><tr><td valign="top">H12019</td><td valign="top">When <a href="c3ref/close.html">sqlite3_close(C)</a> is invoked on a <a href="c3ref/sqlite3.html">database connection</a> C
that has a pending transaction, the transaction shall be
rolled back. </td></tr><tr><td valign="top">H12100</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_exec(
  sqlite3*,                                  /* An open database */
  const char *sql,                           /* SQL to be evaluated */
  int (*callback)(void*,int,char**,char**),  /* Callback function */
  void *,                                    /* 1st argument to callback */
  char **errmsg                              /* Error msg written here */
);

</pre></blockquote></td></tr><tr><td valign="top">H12101</td><td valign="top">A successful invocation of <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a>
shall sequentially evaluate all of the UTF-8 encoded,
semicolon-separated SQL statements in the zero-terminated
string S within the context of the <a href="c3ref/sqlite3.html">database connection</a> D. </td></tr><tr><td valign="top">H12102</td><td valign="top">If the S parameter to <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a> is NULL then
the actions of the interface shall be the same as if the
S parameter were an empty string. </td></tr><tr><td valign="top">H12104</td><td valign="top">The return value of <a href="c3ref/exec.html">sqlite3_exec()</a> shall be <a href="c3ref/c_abort.html">SQLITE_OK</a> if all
SQL statements run successfully and to completion. </td></tr><tr><td valign="top">H12105</td><td valign="top">The return value of <a href="c3ref/exec.html">sqlite3_exec()</a> shall be an appropriate
non-zero <a href="c3ref/c_abort.html">error code</a> if any SQL statement fails. </td></tr><tr><td valign="top">H12107</td><td valign="top">If one or more of the SQL statements handed to <a href="c3ref/exec.html">sqlite3_exec()</a>
return results and the 3rd parameter is not NULL, then
the callback function specified by the 3rd parameter shall be
invoked once for each row of result. </td></tr><tr><td valign="top">H12110</td><td valign="top">If the callback returns a non-zero value then <a href="c3ref/exec.html">sqlite3_exec()</a>
shall abort the SQL statement it is currently evaluating,
skip all subsequent SQL statements, and return <a href="c3ref/c_abort.html">SQLITE_ABORT</a>. </td></tr><tr><td valign="top">H12113</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec()</a> routine shall pass its 4th parameter through
as the 1st parameter of the callback. </td></tr><tr><td valign="top">H12116</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec()</a> routine shall set the 2nd parameter of its
callback to be the number of columns in the current row of
result. </td></tr><tr><td valign="top">H12119</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec()</a> routine shall set the 3rd parameter of its
callback to be an array of pointers to strings holding the
values for each column in the current result set row as
obtained from <a href="c3ref/column_blob.html">sqlite3_column_text()</a>. </td></tr><tr><td valign="top">H12122</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec()</a> routine shall set the 4th parameter of its
callback to be an array of pointers to strings holding the
names of result columns as obtained from <a href="c3ref/column_name.html">sqlite3_column_name()</a>. </td></tr><tr><td valign="top">H12125</td><td valign="top">If the 3rd parameter to <a href="c3ref/exec.html">sqlite3_exec()</a> is NULL then
<a href="c3ref/exec.html">sqlite3_exec()</a> shall silently discard query results. </td></tr><tr><td valign="top">H12131</td><td valign="top">If an error occurs while parsing or evaluating any of the SQL
statements in the S parameter of <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a> and if
the E parameter is not NULL, then <a href="c3ref/exec.html">sqlite3_exec()</a> shall store
in *E an appropriate error message written into memory obtained
from <a href="c3ref/free.html">sqlite3_malloc()</a>. </td></tr><tr><td valign="top">H12134</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a> routine shall set the value of
*E to NULL if E is not NULL and there are no errors. </td></tr><tr><td valign="top">H12137</td><td valign="top">The <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a> function shall set the <a href="c3ref/c_abort.html">error code</a>
and message accessible via <a href="c3ref/errcode.html">sqlite3_errcode()</a>,
<a href="c3ref/errcode.html">sqlite3_extended_errcode()</a>,
<a href="c3ref/errcode.html">sqlite3_errmsg()</a>, and <a href="c3ref/errcode.html">sqlite3_errmsg16()</a>. </td></tr><tr><td valign="top">H12138</td><td valign="top">If the S parameter to <a href="c3ref/exec.html">sqlite3_exec(D,S,C,A,E)</a> is NULL or an
empty string or contains nothing other than whitespace, comments,
and/or semicolons, then results of <a href="c3ref/errcode.html">sqlite3_errcode()</a>,
<a href="c3ref/errcode.html">sqlite3_extended_errcode()</a>,
<a href="c3ref/errcode.html">sqlite3_errmsg()</a>, and <a href="c3ref/errcode.html">sqlite3_errmsg16()</a>
shall reset to indicate no errors. </td></tr><tr><td valign="top">H12200</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_extended_result_codes(sqlite3*, int onoff);

</pre></blockquote></td></tr><tr><td valign="top">H12201</td><td valign="top">Each new <a href="c3ref/sqlite3.html">database connection</a> shall have the
<a href="c3ref/c_ioerr_access.html">extended result codes</a> feature disabled by default. </td></tr><tr><td valign="top">H12202</td><td valign="top">The <a href="c3ref/extended_result_codes.html">sqlite3_extended_result_codes(D,F)</a> interface shall enable
<a href="c3ref/c_ioerr_access.html">extended result codes</a> for the  <a href="c3ref/sqlite3.html">database connection</a> D
if the F parameter is true, or disable them if F is false. </td></tr><tr><td valign="top">H12220</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);

</pre></blockquote></td></tr><tr><td valign="top">H12221</td><td valign="top">The <a href="c3ref/last_insert_rowid.html">sqlite3_last_insert_rowid()</a> function shall return the rowid
of the most recent successful <a href="lang_insert.html">INSERT</a> performed on the same
<a href="c3ref/sqlite3.html">database connection</a> and within the same or higher level
trigger context, or zero if there have been no qualifying
<a href="lang_insert.html">INSERT</a> statements. </td></tr><tr><td valign="top">H12223</td><td valign="top">The <a href="c3ref/last_insert_rowid.html">sqlite3_last_insert_rowid()</a> function shall return the
same value when called from the same trigger context
immediately before and after a <a href="lang_transaction.html">ROLLBACK</a>. </td></tr><tr><td valign="top">H12240</td><td valign="top">The sqlite3.h header file shall define the
the following interfaces:
<blockquote><pre>
int sqlite3_changes(sqlite3*);

</pre></blockquote></td></tr><tr><td valign="top">H12241</td><td valign="top">The <a href="c3ref/changes.html">sqlite3_changes()</a> function shall return the number of
row changes caused by the most recent INSERT, UPDATE,
or DELETE statement on the same database connection and
within the same or higher trigger context, or zero if there have