Documentation Source Text

Check-in [1974081af3]
Login

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

Overview
Comment:Fix typos in the documentation of xDisconnect and xDestroy methods of virtual tables.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:1974081af3c880e36f3410e4a0654774cecbc8a9
User & Date: drh 2012-10-29 19:14:55
Context
2012-10-30
18:15
Import the download page changes from the 3.7.14 branch. check-in: 1bbb35f908 user: drh tags: trunk
2012-10-29
19:14
Fix typos in the documentation of xDisconnect and xDestroy methods of virtual tables. check-in: 1974081af3 user: drh tags: trunk
13:15
Fix the name of the command-line tool in the whentouse.html page. check-in: bb4847adbb user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/vtab.in.

   667    667   
   668    668   This method undoes the work of [xConnect].
   669    669   
   670    670   <p>This method is a destructor for a connection to the virtual table.
   671    671   Contrast this method with [xDestroy].  The xDestroy is a destructor
   672    672   for the entire virtual table.
   673    673   
   674         -<p>The xDestroy method is required for every virtual table implementation,
   675         -though it is acceptable for the [xDisconnect] and xDestroy methods to be
          674  +<p>The xDisconnect method is required for every virtual table implementation,
          675  +though it is acceptable for the xDisconnect and [xDestroy] methods to be
   676    676   the same function if that makes sense for the particular virtual table.
   677    677   
   678    678   <tcl>########################################################## xDestroy
   679    679   hd_fragment {sqlite3_module.xDestroy} {xDestroy}</tcl>
   680    680   <h3>2.5 The xDestroy Method</h3>
   681    681   
   682    682   <blockquote><pre>
................................................................................
   687    687   the [xDisconnect] method, and it also destroys the underlying 
   688    688   table implementation. This method undoes the work of [xCreate].
   689    689   
   690    690   <p>The [xDisconnect] method is called whenever a database connection
   691    691   that uses a virtual table is closed. The xDestroy method is only 
   692    692   called when a [DROP TABLE] statement is executed against the virtual table.
   693    693   
   694         -<p>The xDisconnect method is required for every virtual table implementation,
   695         -though it is acceptable for the xDisconnect and [xDestroy] methods to be
          694  +<p>The xDestroy method is required for every virtual table implementation,
          695  +though it is acceptable for the [xDisconnect] and xDestroy methods to be
   696    696   the same function if that makes sense for the particular virtual table.
   697    697   
   698    698   <tcl>########################################################## xOpen
   699    699   hd_fragment xopen {sqlite3_module.xOpen}</tcl>
   700    700   <h3>2.6 The xOpen Method</h3>
   701    701   
   702    702   <blockquote><pre>