xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_vtab.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.Dd March 11, 2017
2.Dt SQLITE3_VTAB 3
3.Os
4.Sh NAME
5.Nm sqlite3_vtab
6.Nd Virtual Table Instance Object
7.Sh SYNOPSIS
8.Vt struct sqlite3_vtab ;
9.Sh DESCRIPTION
10Every virtual table module implementation uses
11a subclass of this object to describe a particular instance of the
12virtual table.
13Each subclass will be tailored to the specific needs of the module
14implementation.
15The purpose of this superclass is to define certain fields that are
16common to all module implementations.
17.Pp
18Virtual tables methods can set an error message by assigning a string
19obtained from sqlite3_mprintf() to zErrMsg.
20The method should take care that any prior string is freed by a call
21to sqlite3_free() prior to assigning a new string to
22zErrMsg.
23After the error message is delivered up to the client application,
24the string will be automatically freed by sqlite3_free() and the zErrMsg
25field will be zeroed.
26.Sh SEE ALSO
27.Xr sqlite3_malloc 3 ,
28.Xr sqlite3_mprintf 3 ,
29.Xr sqlite3_module 3
30