Debian Codegraph @

www/c3ref/create_module.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta name="viewport" content="width=device-width, initial-scale=1.0">
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
5 <link href="../sqlite.css" rel="stylesheet">
6 <title>Register A Virtual Table Implementation</title>
7 <!-- path=../ -->
8 </head>
9 <body>
10 <div class=nosearch>
11 <a href="../index.html">
12 <img class="logo" src="../images/sqlite370_banner.svg" alt="SQLite" border="0">
13 </a>
14 <div><!-- IE hack to prevent disappearing logo --></div>
15 <div class="tagline desktoponly">
16 Small. Fast. Reliable.<br>Choose any three.
17 </div>
18 <div class="menu mainmenu">
19 <ul>
20 <li><a href="../index.html">Home</a>
21 <li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
22 <li class='wideonly'><a href='../about.html'>About</a>
23 <li class='desktoponly'><a href="../docs.html">Documentation</a>
24 <li class='desktoponly'><a href="../download.html">Download</a>
25 <li class='wideonly'><a href='../copyright.html'>License</a>
26 <li class='desktoponly'><a href="../support.html">Support</a>
27 <li class='desktoponly'><a href="../prosupport.html">Purchase</a>
28 <li class='search' id='search_menubutton'>
29 <a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
30 </ul>
31 </div>
32 <div class="menu submenu" id="submenu">
33 <ul>
34 <li><a href='../about.html'>About</a>
35 <li><a href='../docs.html'>Documentation</a>
36 <li><a href='../download.html'>Download</a>
37 <li><a href='../support.html'>Support</a>
38 <li><a href='../prosupport.html'>Purchase</a>
39 </ul>
40 </div>
41 <div class="searchmenu" id="searchmenu">
42 <form method="GET" action="../search">
43 <select name="s" id="searchtype">
44 <option value="d">Search Documentation</option>
45 <option value="c">Search Changelog</option>
46 </select>
47 <input type="text" name="q" id="searchbox" value="">
48 <input type="submit" value="Go">
49 </form>
50 </div>
51 </div>
52 <script>
53 function toggle_div(nm) {
54 var w = document.getElementById(nm);
55 if( w.style.display=="block" ){
56 w.style.display = "none";
57 }else{
58 w.style.display = "block";
59 }
60 }
61 function toggle_search() {
62 var w = document.getElementById("searchmenu");
63 if( w.style.display=="block" ){
64 w.style.display = "none";
65 } else {
66 w.style.display = "block";
67 setTimeout(function(){
68 document.getElementById("searchbox").focus()
69 }, 30);
70 }
71 }
72 function div_off(nm){document.getElementById(nm).style.display="none";}
73 window.onbeforeunload = function(e){div_off("submenu");}
74 /* Disable the Search feature if we are not operating from CGI, since */
75 /* Search is accomplished using CGI and will not work without it. */
76 if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
77 document.getElementById("search_menubutton").style.display = "none";
78 }
79 /* Used by the Hide/Show button beside syntax diagrams, to toggle the */
80 function hideorshow(btn,obj){
81 var x = document.getElementById(obj);
82 var b = document.getElementById(btn);
83 if( x.style.display!='none' ){
84 x.style.display = 'none';
85 b.innerHTML='show';
86 }else{
87 x.style.display = '';
88 b.innerHTML='hide';
89 }
90 return false;
91 }
92 var antiRobot = 0;
93 function antiRobotGo(){
94 if( antiRobot!=3 ) return;
95 antiRobot = 7;
96 var j = document.getElementById("mtimelink");
97 if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
98 }
99 function antiRobotDefense(){
100 document.body.onmousedown=function(){
101 antiRobot |= 2;
102 antiRobotGo();
103 document.body.onmousedown=null;
104 }
105 document.body.onmousemove=function(){
106 antiRobot |= 2;
107 antiRobotGo();
108 document.body.onmousemove=null;
109 }
110 setTimeout(function(){
111 antiRobot |= 1;
112 antiRobotGo();
113 }, 100)
114 antiRobotGo();
115 }
116 antiRobotDefense();
117 </script>
118 <!-- keywords: sqlite3_create_module sqlite3_create_module_v2 -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Register A Virtual Table Implementation</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_create_module(
125 sqlite3 *db, /* SQLite connection to register module with */
126 const char *zName, /* Name of the module */
127 const sqlite3_module *p, /* Methods for the module */
128 void *pClientData /* Client data for xCreate/xConnect */
129 );
130 int sqlite3_create_module_v2(
131 sqlite3 *db, /* SQLite connection to register module with */
132 const char *zName, /* Name of the module */
133 const sqlite3_module *p, /* Methods for the module */
134 void *pClientData, /* Client data for xCreate/xConnect */
135 void(*xDestroy)(void*) /* Module destructor function */
136 );
137 </pre></blockquote>
138 <p>
139 These routines are used to register a new <a href="../c3ref/module.html">virtual table module</a> name.
140 Module names must be registered before
141 creating a new <a href="../vtab.html">virtual table</a> using the module and before using a
142 preexisting <a href="../vtab.html">virtual table</a> for the module.</p>
143
144 <p>The module name is registered on the <a href="../c3ref/sqlite3.html">database connection</a> specified
145 by the first parameter. The name of the module is given by the
146 second parameter. The third parameter is a pointer to
147 the implementation of the <a href="../c3ref/module.html">virtual table module</a>. The fourth
148 parameter is an arbitrary client data pointer that is passed through
149 into the <a href="../vtab.html#xcreate">xCreate</a> and <a href="../vtab.html#xconnect">xConnect</a> methods of the virtual table module
150 when a new virtual table is being created or reinitialized.</p>
151
152 <p>The sqlite3_create_module_v2() interface has a fifth parameter which
153 is a pointer to a destructor for the pClientData. SQLite will
154 invoke the destructor function (if it is not NULL) when SQLite
155 no longer needs the pClientData pointer. The destructor will also
156 be invoked if the call to sqlite3_create_module_v2() fails.
157 The sqlite3_create_module()
158 interface is equivalent to sqlite3_create_module_v2() with a NULL
159 destructor.</p>
160
161 <p>If the third parameter (the pointer to the sqlite3_module object) is
162 NULL then no new module is created and any existing modules with the
163 same name are dropped.</p>
164
165 <p>See also: <a href="../c3ref/drop_modules.html">sqlite3_drop_modules()</a>
166 </p><p>See also lists of
167 <a href="../c3ref/objlist.html">Objects</a>,
168 <a href="../c3ref/constlist.html">Constants</a>, and
169 <a href="../c3ref/funclist.html">Functions</a>.</p>
170