Debian Codegraph @

www/c3ref/exec.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>One-Step Query Execution Interface</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_exec -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>One-Step Query Execution Interface</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_exec(
125 sqlite3*, /* An open database */
126 const char *sql, /* SQL to be evaluated */
127 int (*callback)(void*,int,char**,char**), /* Callback function */
128 void *, /* 1st argument to callback */
129 char **errmsg /* Error msg written here */
130 );
131 </pre></blockquote>
132 <p>
133 The sqlite3_exec() interface is a convenience wrapper around
134 <a href="../c3ref/prepare.html">sqlite3_prepare_v2()</a>, <a href="../c3ref/step.html">sqlite3_step()</a>, and <a href="../c3ref/finalize.html">sqlite3_finalize()</a>,
135 that allows an application to run multiple statements of SQL
136 without having to use a lot of C code.</p>
137
138 <p>The sqlite3_exec() interface runs zero or more UTF-8 encoded,
139 semicolon-separated SQL statements passed into its 2nd argument,
140 in the context of the <a href="../c3ref/sqlite3.html">database connection</a> passed in as its 1st
141 argument. If the callback function of the 3rd argument to
142 sqlite3_exec() is not NULL, then it is invoked for each result row
143 coming out of the evaluated SQL statements. The 4th argument to
144 sqlite3_exec() is relayed through to the 1st argument of each
145 callback invocation. If the callback pointer to sqlite3_exec()
146 is NULL, then no callback is ever invoked and result rows are
147 ignored.</p>
148
149 <p>If an error occurs while evaluating the SQL statements passed into
150 sqlite3_exec(), then execution of the current statement stops and
151 subsequent statements are skipped. If the 5th parameter to sqlite3_exec()
152 is not NULL then any error message is written into memory obtained
153 from <a href="../c3ref/free.html">sqlite3_malloc()</a> and passed back through the 5th parameter.
154 To avoid memory leaks, the application should invoke <a href="../c3ref/free.html">sqlite3_free()</a>
155 on error message strings returned through the 5th parameter of
156 sqlite3_exec() after the error message string is no longer needed.
157 If the 5th parameter to sqlite3_exec() is not NULL and no errors
158 occur, then sqlite3_exec() sets the pointer in its 5th parameter to
159 NULL before returning.</p>
160
161 <p>If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
162 routine returns SQLITE_ABORT without invoking the callback again and
163 without running any subsequent SQL statements.</p>
164
165 <p>The 2nd argument to the sqlite3_exec() callback function is the
166 number of columns in the result. The 3rd argument to the sqlite3_exec()
167 callback is an array of pointers to strings obtained as if from
168 <a href="../c3ref/column_blob.html">sqlite3_column_text()</a>, one for each column. If an element of a
169 result row is NULL then the corresponding string pointer for the
170 sqlite3_exec() callback is a NULL pointer. The 4th argument to the
171 sqlite3_exec() callback is an array of pointers to strings where each
172 entry represents the name of a corresponding result column as obtained
173 from <a href="../c3ref/column_name.html">sqlite3_column_name()</a>.</p>
174
175 <p>If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
176 to an empty string, or a pointer that contains only whitespace and/or
177 SQL comments, then no SQL statements are evaluated and the database
178 is not changed.</p>
179
180 <p>Restrictions:</p>
181
182 <p><ul>
183 <li> The application must ensure that the 1st parameter to sqlite3_exec()
184 is a valid and open <a href="../c3ref/sqlite3.html">database connection</a>.
185 <li> The application must not close the <a href="../c3ref/sqlite3.html">database connection</a> specified by
186 the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
187 <li> The application must not modify the SQL statement text passed into
188 the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
189 <li> The application must not dereference the arrays or string pointers
190 passed as the 3rd and 4th callback parameters after it returns.
191 </ul>
192 </p><p>See also lists of
193 <a href="../c3ref/objlist.html">Objects</a>,
194 <a href="../c3ref/constlist.html">Constants</a>, and
195 <a href="../c3ref/funclist.html">Functions</a>.</p>
196