xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_vtab_cursor.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
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.Vt struct sqlite3_vtab_cursor ;
9.Sh DESCRIPTION
10Every virtual table module implementation uses
11a subclass of the following structure to describe cursors that point
12into the virtual table and are used to loop through the
13virtual table.
14Cursors are created using the  xOpen method of the module and
15are destroyed by the  xClose method.
16Cursors are used by the xFilter, xNext, xEof, xColumn,
17and xRowid methods of the module.
18Each module implementation will define the content of a cursor structure
19to suit its own needs.
20.Pp
21This superclass exists in order to define fields of the cursor that
22are common to all implementations.
23.Sh SEE ALSO
24.Xr sqlite3_module 3
25