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

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.417 2008/12/08 18:19:18 drh Exp $
           33  +** @(#) $Id: sqlite.h.in,v 1.418 2008/12/10 11:44:30 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++.
................................................................................
   771    771   ** or modify this field while holding a particular static mutex.
   772    772   ** The application should never modify anything within the sqlite3_vfs
   773    773   ** object once the object has been registered.
   774    774   **
   775    775   ** The zName field holds the name of the VFS module.  The name must
   776    776   ** be unique across all VFS modules.
   777    777   **
   778         -** {H11141} SQLite will guarantee that the zFilename parameter to xOpen
          778  +** SQLite will guarantee that the zFilename parameter to xOpen
   779    779   ** is either a NULL pointer or string obtained
   780    780   ** from xFullPathname().  SQLite further guarantees that
   781    781   ** the string will be valid and unchanged until xClose() is
   782         -** called. {END}  Because of the previous sentense,
          782  +** called. Because of the previous sentense,
   783    783   ** the [sqlite3_file] can safely store a pointer to the
   784    784   ** filename if it needs to remember the filename for some reason.
   785    785   ** If the zFilename parameter is xOpen is a NULL pointer then xOpen
   786    786   ** must invite its own temporary name for the file.  Whenever the 
   787    787   ** xFilename parameter is NULL it will also be the case that the
   788    788   ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
   789    789   **
   790         -** {H11142} The flags argument to xOpen() includes all bits set in
          790  +** The flags argument to xOpen() includes all bits set in
   791    791   ** the flags argument to [sqlite3_open_v2()].  Or if [sqlite3_open()]
   792    792   ** or [sqlite3_open16()] is used, then flags includes at least
   793         -** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. {END}
          793  +** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 
   794    794   ** If xOpen() opens a file read-only then it sets *pOutFlags to
   795    795   ** include [SQLITE_OPEN_READONLY].  Other bits in *pOutFlags may be set.
   796    796   **
   797         -** {H11143} SQLite will also add one of the following flags to the xOpen()
          797  +** SQLite will also add one of the following flags to the xOpen()
   798    798   ** call, depending on the object being opened:
   799    799   **
   800    800   ** <ul>
   801    801   ** <li>  [SQLITE_OPEN_MAIN_DB]
   802    802   ** <li>  [SQLITE_OPEN_MAIN_JOURNAL]
   803    803   ** <li>  [SQLITE_OPEN_TEMP_DB]
   804    804   ** <li>  [SQLITE_OPEN_TEMP_JOURNAL]
   805    805   ** <li>  [SQLITE_OPEN_TRANSIENT_DB]
   806    806   ** <li>  [SQLITE_OPEN_SUBJOURNAL]
   807    807   ** <li>  [SQLITE_OPEN_MASTER_JOURNAL]
   808         -** </ul> {END}
          808  +** </ul>
   809    809   **
   810    810   ** The file I/O implementation can use the object type flags to
   811    811   ** change the way it deals with files.  For example, an application
   812    812   ** that does not care about crash recovery or rollback might make
   813    813   ** the open of a journal file a no-op.  Writes to this journal would
   814    814   ** also be no-ops, and any attempt to read the journal would return
   815    815   ** SQLITE_IOERR.  Or the implementation might recognize that a database
................................................................................
   819    819   ** SQLite might also add one of the following flags to the xOpen method:
   820    820   **
   821    821   ** <ul>
   822    822   ** <li> [SQLITE_OPEN_DELETEONCLOSE]
   823    823   ** <li> [SQLITE_OPEN_EXCLUSIVE]
   824    824   ** </ul>
   825    825   **
   826         -** {H11145} The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
   827         -** deleted when it is closed.  {H11146} The [SQLITE_OPEN_DELETEONCLOSE]
          826  +** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
          827  +** deleted when it is closed.  The [SQLITE_OPEN_DELETEONCLOSE]
   828    828   ** will be set for TEMP  databases, journals and for subjournals.
   829    829   **
   830         -** {H11147} The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened
          830  +** The [SQLITE_OPEN_EXCLUSIVE] flag means the file should be opened
   831    831   ** for exclusive access.  This flag is set for all files except
   832    832   ** for the main database file.
   833    833   **
   834         -** {H11148} At least szOsFile bytes of memory are allocated by SQLite
          834  +** At least szOsFile bytes of memory are allocated by SQLite
   835    835   ** to hold the  [sqlite3_file] structure passed as the third
   836         -** argument to xOpen. {END}  The xOpen method does not have to
          836  +** argument to xOpen.  The xOpen method does not have to
   837    837   ** allocate the structure; it should just fill it in.
   838    838   **
   839         -** {H11149} The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
          839  +** The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
   840    840   ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
   841    841   ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
   842         -** to test whether a file is at least readable. {END}  The file can be a
          842  +** to test whether a file is at least readable.   The file can be a
   843    843   ** directory.
   844    844   **
   845         -** {H11150} SQLite will always allocate at least mxPathname+1 bytes for the
   846         -** output buffer xFullPathname. {H11151} The exact size of the output buffer
   847         -** is also passed as a parameter to both  methods. {END}  If the output buffer
          845  +** SQLite will always allocate at least mxPathname+1 bytes for the
          846  +** output buffer xFullPathname.  The exact size of the output buffer
          847  +** is also passed as a parameter to both  methods. If the output buffer
   848    848   ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
   849    849   ** handled as a fatal error by SQLite, vfs implementations should endeavor
   850    850   ** to prevent this by setting mxPathname to a sufficiently large value.
   851    851   **
   852    852   ** The xRandomness(), xSleep(), and xCurrentTime() interfaces
   853    853   ** are not strictly a part of the filesystem, but they are
   854    854   ** included in the VFS structure for completeness.
   855    855   ** The xRandomness() function attempts to return nBytes bytes
   856    856   ** of good-quality randomness into zOut.  The return value is
   857    857   ** the actual number of bytes of randomness obtained.
   858    858   ** The xSleep() method causes the calling thread to sleep for at
   859    859   ** least the number of microseconds given.  The xCurrentTime()
   860    860   ** method returns a Julian Day Number for the current date and time.
          861  +**
   861    862   */
   862    863   typedef struct sqlite3_vfs sqlite3_vfs;
   863    864   struct sqlite3_vfs {
   864    865     int iVersion;            /* Structure version number */
   865    866     int szOsFile;            /* Size of subclassed sqlite3_file */
   866    867     int mxPathname;          /* Maximum file pathname length */
   867    868     sqlite3_vfs *pNext;      /* Next registered VFS */
................................................................................
   883    884     /* New fields may be appended in figure versions.  The iVersion
   884    885     ** value will increment whenever this happens. */
   885    886   };
   886    887   
   887    888   /*
   888    889   ** CAPI3REF: Flags for the xAccess VFS method {H11190} <H11140>
   889    890   **
   890         -** {H11191} These integer constants can be used as the third parameter to
          891  +** These integer constants can be used as the third parameter to
   891    892   ** the xAccess method of an [sqlite3_vfs] object. {END}  They determine
   892    893   ** what kind of permissions the xAccess method is looking for.
   893         -** {H11192} With SQLITE_ACCESS_EXISTS, the xAccess method
          894  +** With SQLITE_ACCESS_EXISTS, the xAccess method
   894    895   ** simply checks whether the file exists.
   895         -** {H11193} With SQLITE_ACCESS_READWRITE, the xAccess method
          896  +** With SQLITE_ACCESS_READWRITE, the xAccess method
   896    897   ** checks whether the file is both readable and writable.
   897         -** {H11194} With SQLITE_ACCESS_READ, the xAccess method
          898  +** With SQLITE_ACCESS_READ, the xAccess method
   898    899   ** checks whether the file is readable.
   899    900   */
   900    901   #define SQLITE_ACCESS_EXISTS    0
   901    902   #define SQLITE_ACCESS_READWRITE 1
   902    903   #define SQLITE_ACCESS_READ      2
   903    904   
   904    905   /*