Updated: 2022/Sep/29

Please read Privacy Policy. It's for your privacy.

SQLITE3_VTAB(3)            Library Functions Manual            SQLITE3_VTAB(3)

NAME
     sqlite3_vtab - virtual table instance object

SYNOPSIS
     #include <sqlite3.h>

     struct sqlite3_vtab;

DESCRIPTION
     Every virtual table module implementation uses a subclass of this object
     to describe a particular instance of the virtual table.  Each subclass
     will be tailored to the specific needs of the module implementation.  The
     purpose of this superclass is to define certain fields that are common to
     all module implementations.

     Virtual tables methods can set an error message by assigning a string
     obtained from sqlite3_mprintf() to zErrMsg.  The method should take care
     that any prior string is freed by a call to sqlite3_free() prior to
     assigning a new string to zErrMsg.  After the error message is delivered
     up to the client application, the string will be automatically freed by
     sqlite3_free() and the zErrMsg field will be zeroed.

IMPLEMENTATION NOTES
     These declarations were extracted from the interface documentation at
     line 7485.

     struct sqlite3_vtab {
       const sqlite3_module *pModule;  /* The module for this virtual table */
       int nRef;                       /* Number of open cursors */
       char *zErrMsg;                  /* Error message from sqlite3_mprintf() */
       /* Virtual table implementations will typically add additional fields */
     };

SEE ALSO
     sqlite3_malloc(3), sqlite3_module(3), sqlite3_mprintf(3)

NetBSD 10.99                    August 24, 2023                   NetBSD 10.99