Documentation Source Text
Check-in [1974081af3]
Not logged in

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

Overview
SHA1 Hash:1974081af3c880e36f3410e4a0654774cecbc8a9
Date: 2012-10-29 19:14:55
User: drh
Comment:Fix typos in the documentation of xDisconnect and xDestroy methods of virtual tables.
Tags And Properties
Changes
hide diffs unified diffs patch

Changes to pages/vtab.in

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