Debian Codegraph @

www/c3ref/vtab_in_first.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>Find all elements on the right-hand side of an IN constraint.</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_vtab_in_first sqlite3_vtab_in_next -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Find all elements on the right-hand side of an IN constraint.</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut);
125 int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);
126 </pre></blockquote>
127 <p>
128 These interfaces are only useful from within the
129 <a href="../vtab.html#xfilter">xFilter() method</a> of a <a href="../vtab.html">virtual table</a> implementation.
130 The result of invoking these interfaces from any other context
131 is undefined and probably harmful.</p>
132
133 <p>The X parameter in a call to sqlite3_vtab_in_first(X,P) or
134 sqlite3_vtab_in_next(X,P) should be one of the parameters to the
135 xFilter method which invokes these routines, and specifically
136 a parameter that was previously selected for all-at-once IN constraint
137 processing using the <a href="../c3ref/vtab_in.html">sqlite3_vtab_in()</a> interface in the
138 <a href="../vtab.html#xbestindex">xBestIndex method</a>. If the X parameter is not
139 an xFilter argument that was selected for all-at-once IN constraint
140 processing, then these routines return <a href="../rescode.html#error">SQLITE_ERROR</a>.</p>
141
142 <p>Use these routines to access all values on the right-hand side
143 of the IN constraint using code like the following:</p>
144
145 <p><blockquote><pre>
146 &nbsp; for(rc=sqlite3_vtab_in_first(pList, &pVal);
147 &nbsp; rc==SQLITE_OK && pVal;
148 &nbsp; rc=sqlite3_vtab_in_next(pList, &pVal)
149 &nbsp; ){
150 &nbsp; // do something with pVal
151 &nbsp; }
152 &nbsp; if( rc!=SQLITE_DONE ){
153 &nbsp; // an error has occurred
154 &nbsp; }
155 </pre></blockquote></p>
156
157 <p>On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P)
158 routines return SQLITE_OK and set *P to point to the first or next value
159 on the RHS of the IN constraint. If there are no more values on the
160 right hand side of the IN constraint, then *P is set to NULL and these
161 routines return <a href="../rescode.html#done">SQLITE_DONE</a>. The return value might be
162 some other value, such as SQLITE_NOMEM, in the event of a malfunction.</p>
163
164 <p>The *ppOut values returned by these routines are only valid until the
165 next call to either of these routines or until the end of the xFilter
166 method from which these routines were called. If the virtual table
167 implementation needs to retain the *ppOut values for longer, it must make
168 copies. The *ppOut values are <a href="../c3ref/value.html">protected</a>.
169 </p><p>See also lists of
170 <a href="../c3ref/objlist.html">Objects</a>,
171 <a href="../c3ref/constlist.html">Constants</a>, and
172 <a href="../c3ref/funclist.html">Functions</a>.</p>
173