Debian Codegraph @

www/c3ref/errcode.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>Error Codes And Messages</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_errcode sqlite3_errmsg sqlite3_errmsg16 sqlite3_error_offset sqlite3_errstr sqlite3_extended_errcode -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Error Codes And Messages</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_errcode(sqlite3 *db);
125 int sqlite3_extended_errcode(sqlite3 *db);
126 const char *sqlite3_errmsg(sqlite3*);
127 const void *sqlite3_errmsg16(sqlite3*);
128 const char *sqlite3_errstr(int);
129 int sqlite3_error_offset(sqlite3 *db);
130 </pre></blockquote>
131 <p>
132 If the most recent sqlite3_* API call associated with
133 <a href="../c3ref/sqlite3.html">database connection</a> D failed, then the sqlite3_errcode(D) interface
134 returns the numeric <a href="../rescode.html">result code</a> or <a href="../rescode.html#extrc">extended result code</a> for that
135 API call.
136 The sqlite3_extended_errcode()
137 interface is the same except that it always returns the
138 <a href="../rescode.html#extrc">extended result code</a> even when extended result codes are
139 disabled.</p>
140
141 <p>The values returned by sqlite3_errcode() and/or
142 sqlite3_extended_errcode() might change with each API call.
143 Except, there are some interfaces that are guaranteed to never
144 change the value of the error code. The error-code preserving
145 interfaces include the following:</p>
146
147 <p><ul>
148 <li> sqlite3_errcode()
149 <li> sqlite3_extended_errcode()
150 <li> sqlite3_errmsg()
151 <li> sqlite3_errmsg16()
152 <li> sqlite3_error_offset()
153 <li> sqlite3_db_handle()
154 </ul></p>
155
156 <p>The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
157 text that describes the error, as either UTF-8 or UTF-16 respectively,
158 or NULL if no error message is available.
159 (See how SQLite handles <a href="../invalidutf.html">invalid UTF</a> for exceptions to this rule.)
160 Memory to hold the error message string is managed internally.
161 The application does not need to worry about freeing the result.
162 However, the error string might be overwritten or deallocated by
163 subsequent calls to other SQLite interface functions.</p>
164
165 <p>The sqlite3_errstr(E) interface returns the English-language text
166 that describes the <a href="../rescode.html">result code</a> E, as UTF-8, or NULL if E is not a
167 result code for which a text error message is available.
168 Memory to hold the error message string is managed internally
169 and must not be freed by the application.</p>
170
171 <p>If the most recent error references a specific token in the input
172 SQL, the sqlite3_error_offset() interface returns the byte offset
173 of the start of that token. The byte offset returned by
174 sqlite3_error_offset() assumes that the input SQL is UTF-8.
175 If the most recent error does not reference a specific token in the input
176 SQL, then the sqlite3_error_offset() function returns -1.</p>
177
178 <p>When the serialized <a href="../threadsafe.html">threading mode</a> is in use, it might be the
179 case that a second error occurs on a separate thread in between
180 the time of the first error and the call to these interfaces.
181 When that happens, the second error will be reported since these
182 interfaces always report the most recent result. To avoid
183 this, each thread can obtain exclusive use of the <a href="../c3ref/sqlite3.html">database connection</a> D
184 by invoking <a href="../c3ref/mutex_alloc.html">sqlite3_mutex_enter</a>(<a href="../c3ref/db_mutex.html">sqlite3_db_mutex</a>(D)) before beginning
185 to use D and invoking <a href="../c3ref/mutex_alloc.html">sqlite3_mutex_leave</a>(<a href="../c3ref/db_mutex.html">sqlite3_db_mutex</a>(D)) after
186 all calls to the interfaces listed here are completed.</p>
187
188 <p>If an interface fails with SQLITE_MISUSE, that means the interface
189 was invoked incorrectly by the application. In that case, the
190 error code and message may or may not be set.
191 </p><p>See also lists of
192 <a href="../c3ref/objlist.html">Objects</a>,
193 <a href="../c3ref/constlist.html">Constants</a>, and
194 <a href="../c3ref/funclist.html">Functions</a>.</p>
195