diff options
Diffstat (limited to 'static/netbsd/man3/sqlite3_create_module.3')
| -rw-r--r-- | static/netbsd/man3/sqlite3_create_module.3 | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_create_module.3 b/static/netbsd/man3/sqlite3_create_module.3 new file mode 100644 index 00000000..dddefecd --- /dev/null +++ b/static/netbsd/man3/sqlite3_create_module.3 @@ -0,0 +1,75 @@ +.Dd January 24, 2024 +.Dt SQLITE3_CREATE_MODULE 3 +.Os +.Sh NAME +.Nm sqlite3_create_module , +.Nm sqlite3_create_module_v2 +.Nd register a virtual table implementation +.Sh SYNOPSIS +.In sqlite3.h +.Ft int +.Fo sqlite3_create_module +.Fa "sqlite3 *db" +.Fa "const char *zName" +.Fa "const sqlite3_module *p" +.Fa "void *pClientData" +.Fc +.Ft int +.Fo sqlite3_create_module_v2 +.Fa "sqlite3 *db" +.Fa "const char *zName" +.Fa "const sqlite3_module *p" +.Fa "void *pClientData" +.Fa "void(*xDestroy)(void*)" +.Fc +.Sh DESCRIPTION +These routines are used to register a new virtual table module +name. +Module names must be registered before creating a new virtual table +using the module and before using a preexisting virtual table +for the module. +.Pp +The module name is registered on the database connection +specified by the first parameter. +The name of the module is given by the second parameter. +The third parameter is a pointer to the implementation of the virtual table module. +The fourth parameter is an arbitrary client data pointer that is passed +through into the xCreate and xConnect methods of the +virtual table module when a new virtual table is be being created or +reinitialized. +.Pp +The sqlite3_create_module_v2() interface has a fifth parameter which +is a pointer to a destructor for the pClientData. +SQLite will invoke the destructor function (if it is not NULL) when +SQLite no longer needs the pClientData pointer. +The destructor will also be invoked if the call to sqlite3_create_module_v2() +fails. +The sqlite3_create_module() interface is equivalent to sqlite3_create_module_v2() +with a NULL destructor. +.Pp +If the third parameter (the pointer to the sqlite3_module object) is +NULL then no new module is created and any existing modules with the +same name are dropped. +.Pp +.Sh IMPLEMENTATION NOTES +These declarations were extracted from the +interface documentation at line 7530. +.Bd -literal +SQLITE_API int sqlite3_create_module( + sqlite3 *db, /* SQLite connection to register module with */ + const char *zName, /* Name of the module */ + const sqlite3_module *p, /* Methods for the module */ + void *pClientData /* Client data for xCreate/xConnect */ +); +SQLITE_API int sqlite3_create_module_v2( + sqlite3 *db, /* SQLite connection to register module with */ + const char *zName, /* Name of the module */ + const sqlite3_module *p, /* Methods for the module */ + void *pClientData, /* Client data for xCreate/xConnect */ + void(*xDestroy)(void*) /* Module destructor function */ +); +.Ed +.Sh SEE ALSO +.Xr sqlite3 3 , +.Xr sqlite3_drop_modules 3 , +.Xr sqlite3_module 3 |