/ Check-in [e7fdd813]
Login

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

Overview
Comment:Documentation updates. (CVS 5511)
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: e7fdd813ccdefab33aedbcf7f44e13b935dd3299
User & Date: drh 2008-07-31 14:47:55
Context
2008-07-31
17:16
Change the definition of SQLITE_CONFIG_PAGECACHE and SQLITE_CONFIG_SCRATCH to omit the magic "+4" in the buffer size calculation. (CVS 5512) check-in: e7ed0fe6 user: drh tags: trunk
14:47
Documentation updates. (CVS 5511) check-in: e7fdd813 user: drh tags: trunk
02:43
Updated omittest.tcl. Updated OMIT list. Updated for Windows. (CVS 5510) check-in: f9423993 user: shane tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

    26     26   ** on how SQLite interfaces are suppose to operate.
    27     27   **
    28     28   ** The name of this file under configuration management is "sqlite.h.in".
    29     29   ** The makefile makes some minor changes to this file (such as inserting
    30     30   ** the version number) and changes its name to "sqlite3.h" as
    31     31   ** part of the build process.
    32     32   **
    33         -** @(#) $Id: sqlite.h.in,v 1.382 2008/07/28 19:34:53 drh Exp $
           33  +** @(#) $Id: sqlite.h.in,v 1.383 2008/07/31 14:47:55 drh Exp $
    34     34   */
    35     35   #ifndef _SQLITE3_H_
    36     36   #define _SQLITE3_H_
    37     37   #include <stdarg.h>     /* Needed for the definition of va_list */
    38     38   
    39     39   /*
    40     40   ** Make sure we can call this stuff from C++.
................................................................................
   971    971   */
   972    972   int sqlite3_config(int, ...);
   973    973   
   974    974   /*
   975    975   ** CAPI3REF: Configure database connections  {H10180} <S20000>
   976    976   **
   977    977   ** The sqlite3_db_config() interface is used to make configuration
   978         -** changes to a [database connection].  
          978  +** changes to a [database connection].  The interface is similar to
          979  +** [sqlite3_config()] except that the changes apply to a single
          980  +** [database connection] (specified in the first argument).  The
          981  +** sqlite3_db_config() interface can only be used immediately after
          982  +** the database connection is created using [sqlite3_open()],
          983  +** [sqlite3_open16()], or [sqlite3_open_v2()].  
          984  +**
          985  +** The second argument to sqlite3_db_config(D,V,...)  is the
          986  +** configuration verb - an integer code that indicates what
          987  +** aspect of the [database connection] is being configured.
          988  +** Choices for this value are [SQLITE_CONFIG_LOOKASIDE].
          989  +** New verbs are likely to be added in future releases of SQLite.
   979    990   */
   980         -int sqlite3_db_config(sqlite3*, int, ...);
          991  +int sqlite3_db_config(sqlite3*, int op, ...);
   981    992   
   982    993   /*
   983    994   ** CAPI3REF: Memory Allocation Routines {H10155} <S20120>
   984    995   **
   985    996   ** An instance of this object defines the interface between SQLite
   986    997   ** and low-level memory allocation routines.
   987    998   **
................................................................................
  6081   6092   **
  6082   6093   ** This routine is threadsafe but is not atomic.  This routine can
  6083   6094   ** called while other threads are running the same or different SQLite
  6084   6095   ** interfaces.  However the values returned in *pCurrent and
  6085   6096   ** *pHighwater reflect the status of SQLite at different points in time
  6086   6097   ** and it is possible that another thread might change the parameter
  6087   6098   ** in between the times when *pCurrent and *pHighwater are written.
         6099  +**
         6100  +** See also: [sqlite3_db_status()]
  6088   6101   **
  6089   6102   ** This interface is experimental and is subject to change or
  6090   6103   ** removal in future releases of SQLite.
  6091   6104   */
  6092   6105   int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
         6106  +
         6107  +/*
         6108  +** CAPI3REF: Database Connection Status {H17201} <S60200>
         6109  +**
         6110  +** This interface is used to retrieve runtime status information 
         6111  +** about a single [database connection].  The first argument is the
         6112  +** database connection object to be interrogated.  The second argument
         6113  +** is the parameter to interrogate.  Currently, the only allowed value
         6114  +** for the second parameter is [SQLITE_DBSTATUS_LOOKASIDE_USED].
         6115  +** Additional options will likely appear in future releases of SQLite.
         6116  +**
         6117  +** The current value of the request parameter is written into *pCur
         6118  +** and the highest instantaneous value is written into *pHiwtr.  If
         6119  +** the resetFlg is true, then the highest instantaneous value is
         6120  +** reset back down to the current value.
         6121  +**
         6122  +** See also: [sqlite3_status()].
         6123  +**
         6124  +** This interface is experimental and is subject to change or
         6125  +** removal in future releases of SQLite.
         6126  +*/
  6093   6127   int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
  6094   6128   
  6095   6129   /*
  6096   6130   ** CAPI3REF: Status Parameters {H17250} <H17200>
  6097   6131   **
  6098   6132   ** These integer constants designate various run-time status parameters
  6099   6133   ** that can be returned by [sqlite3_status()].