1.Dd January 24, 2024 2.Dt SQLITE3_VTAB_CURSOR 3 3.Os 4.Sh NAME 5.Nm sqlite3_vtab_cursor 6.Nd virtual table cursor object 7.Sh SYNOPSIS 8.In sqlite3.h 9.Vt struct sqlite3_vtab_cursor ; 10.Sh DESCRIPTION 11Every virtual table module implementation uses 12a subclass of the following structure to describe cursors that point 13into the virtual table and are used to loop through the 14virtual table. 15Cursors are created using the xOpen method of the module and are 16destroyed by the xClose method. 17Cursors are used by the xFilter, xNext, xEof, xColumn, 18and xRowid methods of the module. 19Each module implementation will define the content of a cursor structure 20to suit its own needs. 21.Pp 22This superclass exists in order to define fields of the cursor that 23are common to all implementations. 24.Sh IMPLEMENTATION NOTES 25These declarations were extracted from the 26interface documentation at line 7618. 27.Bd -literal 28struct sqlite3_vtab_cursor { 29 sqlite3_vtab *pVtab; /* Virtual table of this cursor */ 30 /* Virtual table implementations will typically add additional fields */ 31}; 32.Ed 33.Sh SEE ALSO 34.Xr sqlite3_module 3 35