diff options
Diffstat (limited to 'static/netbsd/man3/sqlite3_vtab_cursor.3')
| -rw-r--r-- | static/netbsd/man3/sqlite3_vtab_cursor.3 | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_vtab_cursor.3 b/static/netbsd/man3/sqlite3_vtab_cursor.3 new file mode 100644 index 00000000..cfd35ecf --- /dev/null +++ b/static/netbsd/man3/sqlite3_vtab_cursor.3 @@ -0,0 +1,34 @@ +.Dd January 24, 2024 +.Dt SQLITE3_VTAB_CURSOR 3 +.Os +.Sh NAME +.Nm sqlite3_vtab_cursor +.Nd virtual table cursor object +.Sh SYNOPSIS +.In sqlite3.h +.Vt struct sqlite3_vtab_cursor ; +.Sh DESCRIPTION +Every virtual table module implementation uses +a subclass of the following structure to describe cursors that point +into the virtual table and are used to loop through the +virtual table. +Cursors are created using the xOpen method of the module and are +destroyed by the xClose method. +Cursors are used by the xFilter, xNext, xEof, xColumn, +and xRowid methods of the module. +Each module implementation will define the content of a cursor structure +to suit its own needs. +.Pp +This superclass exists in order to define fields of the cursor that +are common to all implementations. +.Sh IMPLEMENTATION NOTES +These declarations were extracted from the +interface documentation at line 7618. +.Bd -literal +struct sqlite3_vtab_cursor { + sqlite3_vtab *pVtab; /* Virtual table of this cursor */ + /* Virtual table implementations will typically add additional fields */ +}; +.Ed +.Sh SEE ALSO +.Xr sqlite3_module 3 |