/ Check-in [07b2fdd1]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Minor tweaks to the interface documentation - adding hyperlinks.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 07b2fdd1cebbdbde5098a662eea65a0c9e8b5442
User & Date: drh 2010-06-15 12:09:06
Context
2010-06-15
14:06
Merge in [2c5e48a485]. Merge in [2c5e48a485]. Merge in [2c5e48a485]. check-in: 03c0f4fd user: dan tags: trunk
12:09
Minor tweaks to the interface documentation - adding hyperlinks. check-in: 07b2fdd1 user: drh tags: trunk
11:21
Updates to comments and testcase() macros in wal.c. check-in: 4d90cc0b user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

  5810   5810   ** the associated write-lock on the database released, so the implementation 
  5811   5811   ** may read, write or [checkpoint] the database as required.
  5812   5812   **
  5813   5813   ** ^The first parameter passed to the callback function when it is invoked
  5814   5814   ** is a copy of the third parameter passed to sqlite3_wal_hook() when
  5815   5815   ** registering the callback. ^The second is a copy of the database handle.
  5816   5816   ** ^The third parameter is the name of the database that was written to -
  5817         -** either "main" or the name of an ATTACHed database. ^The fourth parameter
         5817  +** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
  5818   5818   ** is the number of pages currently in the write-ahead log file,
  5819   5819   ** including those that were just committed.
  5820   5820   **
  5821         -** The callback function should normally return SQLITE_OK.  ^If an error
         5821  +** The callback function should normally return [SQLITE_OK].  ^If an error
  5822   5822   ** code is returned, that error will propagate back up through the
  5823   5823   ** SQLite code base to cause the statement that provoked the callback
  5824   5824   ** to report an error, though the commit will have still occurred. If the
  5825         -** callback returns SQLITE_ROW or SQLITE_DONE, or if it returns a value
         5825  +** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
  5826   5826   ** that does not correspond to any valid SQLite error code, the results
  5827   5827   ** are undefined.
  5828   5828   **
  5829   5829   ** A single database handle may have at most a single write-ahead log callback 
  5830   5830   ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
  5831         -** previously registered write-ahead log callback. Note that the
         5831  +** previously registered write-ahead log callback. ^Note that the
  5832   5832   ** [sqlite3_wal_autocheckpoint()] interface and the
  5833   5833   ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
  5834   5834   ** those overwrite any prior [sqlite3_wal_hook()] settings.
  5835   5835   */
  5836   5836   void *sqlite3_wal_hook(
  5837   5837     sqlite3*, 
  5838   5838     int(*)(void *,sqlite3*,const char*,int),