Documentation Source Text

Check-in [2ee890a53a]
Login

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

Overview
Comment:Fix missing "const" in the documentation of the argv parameters to the xCreate and xConnect methods in the sqlite3_module object.
Timelines: family | ancestors | descendants | both | branch-3.24
Files: files | file ages | folders
SHA3-256: 2ee890a53a686b0848b9b233e27eca33d42423f968ad074acf4a3fdca47af778
User & Date: drh 2018-06-15 19:12:24
Context
2018-06-26
18:24
Mention that UPSERT does not work for virtual tables. check-in: 887762cf99 user: drh tags: branch-3.24
2018-06-15
19:12
Fix missing "const" in the documentation of the argv parameters to the xCreate and xConnect methods in the sqlite3_module object. check-in: 2ee890a53a user: drh tags: branch-3.24
2018-06-09
22:13
Fix typos in the compile.html page. check-in: 10c05df9fb user: drh tags: branch-3.24
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/vtab.in.

   261    261   destructor for client data pointer.  The module structure is what defines
   262    262   the behavior of a virtual table.  The module structure looks like this:
   263    263   
   264    264   <codeblock>  
   265    265     struct sqlite3_module {
   266    266       int iVersion;
   267    267       int (*xCreate)(sqlite3*, void *pAux,
   268         -                 int argc, char **argv,
          268  +                 int argc, char *const*argv,
   269    269                    sqlite3_vtab **ppVTab,
   270    270                    char **pzErr);
   271    271       int (*xConnect)(sqlite3*, void *pAux,
   272         -                 int argc, char **argv,
          272  +                 int argc, char *const*argv,
   273    273                    sqlite3_vtab **ppVTab,
   274    274                    char **pzErr);
   275    275       int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
   276    276       int (*xDisconnect)(sqlite3_vtab *pVTab);
   277    277       int (*xDestroy)(sqlite3_vtab *pVTab);
   278    278       int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
   279    279       int (*xClose)(sqlite3_vtab_cursor*);
................................................................................
   350    350   <h1>Virtual Table Methods</h1>
   351    351   
   352    352   <tcl>hd_fragment xcreate {sqlite3_module.xCreate} {xCreate}</tcl>
   353    353   <h2>The xCreate Method</h2>
   354    354   
   355    355   <codeblock>
   356    356     int (*xCreate)(sqlite3 *db, void *pAux,
   357         -               int argc, char **argv,
          357  +               int argc, char *const*argv,
   358    358                  sqlite3_vtab **ppVTab,
   359    359                  char **pzErr);
   360    360   </codeblock>
   361    361   
   362    362   <p>The xCreate method is called to create a new instance of a virtual table 
   363    363   in response to a [CREATE VIRTUAL TABLE] statement.
   364    364   If the xCreate method is the same pointer as the [xConnect] method, then the
................................................................................
   549    549   
   550    550   <tcl>############################################################# xConnect
   551    551   hd_fragment xconnect {sqlite3_module.xConnect} {xConnect}</tcl>
   552    552   <h2>The xConnect Method</h2>
   553    553   
   554    554   <codeblock>
   555    555     int (*xConnect)(sqlite3*, void *pAux,
   556         -               int argc, char **argv,
          556  +               int argc, char *const*argv,
   557    557                  sqlite3_vtab **ppVTab,
   558    558                  char **pzErr);
   559    559   </codeblock>
   560    560   
   561    561   <p>The xConnect method is very similar to [xCreate]. 
   562    562   It has the same parameters and constructs a new [sqlite3_vtab] structure 
   563    563   just like xCreate.