summaryrefslogtreecommitdiffstats
path: root/www/c3ref/errcode.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/c3ref/errcode.html')
-rw-r--r--www/c3ref/errcode.html194
1 files changed, 194 insertions, 0 deletions
diff --git a/www/c3ref/errcode.html b/www/c3ref/errcode.html
new file mode 100644
index 0000000..cfdfdce
--- /dev/null
+++ b/www/c3ref/errcode.html
@@ -0,0 +1,194 @@
+<!DOCTYPE html>
+<html><head>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<link href="../sqlite.css" rel="stylesheet">
+<title>Error Codes And Messages</title>
+<!-- path=../ -->
+</head>
+<body>
+<div class=nosearch>
+<a href="../index.html">
+<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
+</a>
+<div><!-- IE hack to prevent disappearing logo --></div>
+<div class="tagline desktoponly">
+Small. Fast. Reliable.<br>Choose any three.
+</div>
+<div class="menu mainmenu">
+<ul>
+<li><a href="../index.html">Home</a>
+<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
+<li class='wideonly'><a href='../about.html'>About</a>
+<li class='desktoponly'><a href="../docs.html">Documentation</a>
+<li class='desktoponly'><a href="../download.html">Download</a>
+<li class='wideonly'><a href='../copyright.html'>License</a>
+<li class='desktoponly'><a href="../support.html">Support</a>
+<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
+<li class='search' id='search_menubutton'>
+<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
+</ul>
+</div>
+<div class="menu submenu" id="submenu">
+<ul>
+<li><a href='../about.html'>About</a>
+<li><a href='../docs.html'>Documentation</a>
+<li><a href='../download.html'>Download</a>
+<li><a href='../support.html'>Support</a>
+<li><a href='../prosupport.html'>Purchase</a>
+</ul>
+</div>
+<div class="searchmenu" id="searchmenu">
+<form method="GET" action="../search">
+<select name="s" id="searchtype">
+<option value="d">Search Documentation</option>
+<option value="c">Search Changelog</option>
+</select>
+<input type="text" name="q" id="searchbox" value="">
+<input type="submit" value="Go">
+</form>
+</div>
+</div>
+<script>
+function toggle_div(nm) {
+var w = document.getElementById(nm);
+if( w.style.display=="block" ){
+w.style.display = "none";
+}else{
+w.style.display = "block";
+}
+}
+function toggle_search() {
+var w = document.getElementById("searchmenu");
+if( w.style.display=="block" ){
+w.style.display = "none";
+} else {
+w.style.display = "block";
+setTimeout(function(){
+document.getElementById("searchbox").focus()
+}, 30);
+}
+}
+function div_off(nm){document.getElementById(nm).style.display="none";}
+window.onbeforeunload = function(e){div_off("submenu");}
+/* Disable the Search feature if we are not operating from CGI, since */
+/* Search is accomplished using CGI and will not work without it. */
+if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
+document.getElementById("search_menubutton").style.display = "none";
+}
+/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
+function hideorshow(btn,obj){
+var x = document.getElementById(obj);
+var b = document.getElementById(btn);
+if( x.style.display!='none' ){
+x.style.display = 'none';
+b.innerHTML='show';
+}else{
+x.style.display = '';
+b.innerHTML='hide';
+}
+return false;
+}
+var antiRobot = 0;
+function antiRobotGo(){
+if( antiRobot!=3 ) return;
+antiRobot = 7;
+var j = document.getElementById("mtimelink");
+if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
+}
+function antiRobotDefense(){
+document.body.onmousedown=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousedown=null;
+}
+document.body.onmousemove=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousemove=null;
+}
+setTimeout(function(){
+antiRobot |= 1;
+antiRobotGo();
+}, 100)
+antiRobotGo();
+}
+antiRobotDefense();
+</script>
+<!-- keywords: sqlite3_errcode sqlite3_errmsg sqlite3_errmsg16 sqlite3_error_offset sqlite3_errstr sqlite3_extended_errcode -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Error Codes And Messages</h2>
+</div>
+<blockquote><pre>
+int sqlite3_errcode(sqlite3 *db);
+int sqlite3_extended_errcode(sqlite3 *db);
+const char *sqlite3_errmsg(sqlite3*);
+const void *sqlite3_errmsg16(sqlite3*);
+const char *sqlite3_errstr(int);
+int sqlite3_error_offset(sqlite3 *db);
+</pre></blockquote>
+<p>
+If the most recent sqlite3_* API call associated with
+<a href="../c3ref/sqlite3.html">database connection</a> D failed, then the sqlite3_errcode(D) interface
+returns the numeric <a href="../rescode.html">result code</a> or <a href="../rescode.html#extrc">extended result code</a> for that
+API call.
+The sqlite3_extended_errcode()
+interface is the same except that it always returns the
+<a href="../rescode.html#extrc">extended result code</a> even when extended result codes are
+disabled.</p>
+
+<p>The values returned by sqlite3_errcode() and/or
+sqlite3_extended_errcode() might change with each API call.
+Except, there are some interfaces that are guaranteed to never
+change the value of the error code. The error-code preserving
+interfaces include the following:</p>
+
+<p><ul>
+<li> sqlite3_errcode()
+<li> sqlite3_extended_errcode()
+<li> sqlite3_errmsg()
+<li> sqlite3_errmsg16()
+<li> sqlite3_error_offset()
+</ul></p>
+
+<p>The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
+text that describes the error, as either UTF-8 or UTF-16 respectively,
+or NULL if no error message is available.
+(See how SQLite handles <a href="../invalidutf.html">invalid UTF</a> for exceptions to this rule.)
+Memory to hold the error message string is managed internally.
+The application does not need to worry about freeing the result.
+However, the error string might be overwritten or deallocated by
+subsequent calls to other SQLite interface functions.</p>
+
+<p>The sqlite3_errstr(E) interface returns the English-language text
+that describes the <a href="../rescode.html">result code</a> E, as UTF-8, or NULL if E is not an
+result code for which a text error message is available.
+Memory to hold the error message string is managed internally
+and must not be freed by the application.</p>
+
+<p>If the most recent error references a specific token in the input
+SQL, the sqlite3_error_offset() interface returns the byte offset
+of the start of that token. The byte offset returned by
+sqlite3_error_offset() assumes that the input SQL is UTF8.
+If the most recent error does not reference a specific token in the input
+SQL, then the sqlite3_error_offset() function returns -1.</p>
+
+<p>When the serialized <a href="../threadsafe.html">threading mode</a> is in use, it might be the
+case that a second error occurs on a separate thread in between
+the time of the first error and the call to these interfaces.
+When that happens, the second error will be reported since these
+interfaces always report the most recent result. To avoid
+this, each thread can obtain exclusive use of the <a href="../c3ref/sqlite3.html">database connection</a> D
+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
+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
+all calls to the interfaces listed here are completed.</p>
+
+<p>If an interface fails with SQLITE_MISUSE, that means the interface
+was invoked incorrectly by the application. In that case, the
+error code and message may or may not be set.
+</p><p>See also lists of
+ <a href="../c3ref/objlist.html">Objects</a>,
+ <a href="../c3ref/constlist.html">Constants</a>, and
+ <a href="../c3ref/funclist.html">Functions</a>.</p>
+