PageRenderTime 71ms CodeModel.GetById 31ms RepoModel.GetById 1ms app.codeStats 1ms

/doc/html/sqlite-3_87_81_2sqlite3_8h_source.html

https://bitbucket.org/iesahin/otapexplorer
HTML | 4536 lines | 4534 code | 0 blank | 2 comment | 0 complexity | 0183545ee161c07d48aeb41a8cb948b8 MD5 | raw file
Possible License(s): BSD-3-Clause

Large files files are truncated, but you can click here to view the full file

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>OTAP: cli/sqlite-3.7.1/sqlite3.h Source File</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javaScript" src="search/search.js"></script>
    9. 

  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    10. 

  10. </head>
    11. 

  11. <body onload='searchBox.OnSelectItem(0);'>
    12. 

  12. <!-- Generated by Doxygen 1.7.1 -->
    13. 

  13. <script type="text/javascript"><!--
    14. 

  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    15. 

  15. --></script>
    16. 

  16. <div class="navigation" id="top">
    17. 

  17.   <div class="tabs">
    18. 

  18.     <ul class="tablist">
    19. 

  19.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    20. 

  20.       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    21. 

  21.       <li><a href="modules.html"><span>Modules</span></a></li>
    22. 

  22.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    23. 

  23.       <li><a href="annotated.html"><span>Classes</span></a></li>
    24. 

  24.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    25. 

  25.       <li id="searchli">
    26. 

  26.         <div id="MSearchBox" class="MSearchBoxInactive">
    27. 

  27.         <span class="left">
    28. 

  28.           <img id="MSearchSelect" src="search/mag_sel.png"
    29. 

  29.                onmouseover="return searchBox.OnSearchSelectShow()"
    30. 

  30.                onmouseout="return searchBox.OnSearchSelectHide()"
    31. 

  31.                alt=""/>
    32. 

  32.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    33. 

  33.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    34. 

  34.                onblur="searchBox.OnSearchFieldFocus(false)" 
    35. 

  35.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    36. 

  36.           </span><span class="right">
    37. 

  37.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    38. 

  38.           </span>
    39. 

  39.         </div>
    40. 

  40.       </li>
    41. 

  41.     </ul>
    42. 

  42.   </div>
    43. 

  43.   <div class="tabs2">
    44. 

  44.     <ul class="tablist">
    45. 

  45.       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    46. 

  46.       <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    47. 

  47.     </ul>
    48. 

  48.   </div>
    49. 

  49. <div class="header">
    50. 

  50.   <div class="headertitle">
    51. 

  51. <h1>cli/sqlite-3.7.1/sqlite3.h</h1>  </div>
    52. 

  52. </div>
    53. 

  53. <div class="contents">
    54. 

  54. <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
    55. 

  55. <a name="l00002"></a>00002 <span class="comment">** 2001 September 15</span>
    56. 

  56. <a name="l00003"></a>00003 <span class="comment">**</span>
    57. 

  57. <a name="l00004"></a>00004 <span class="comment">** The author disclaims copyright to this source code.  In place of</span>
    58. 

  58. <a name="l00005"></a>00005 <span class="comment">** a legal notice, here is a blessing:</span>
    59. 

  59. <a name="l00006"></a>00006 <span class="comment">**</span>
    60. 

  60. <a name="l00007"></a>00007 <span class="comment">**    May you do good and not evil.</span>
    61. 

  61. <a name="l00008"></a>00008 <span class="comment">**    May you find forgiveness for yourself and forgive others.</span>
    62. 

  62. <a name="l00009"></a>00009 <span class="comment">**    May you share freely, never taking more than you give.</span>
    63. 

  63. <a name="l00010"></a>00010 <span class="comment">**</span>
    64. 

  64. <a name="l00011"></a>00011 <span class="comment">*************************************************************************</span>
    65. 

  65. <a name="l00012"></a>00012 <span class="comment">** This header file defines the interface that the SQLite library</span>
    66. 

  66. <a name="l00013"></a>00013 <span class="comment">** presents to client programs.  If a C-function, structure, datatype,</span>
    67. 

  67. <a name="l00014"></a>00014 <span class="comment">** or constant definition does not appear in this file, then it is</span>
    68. 

  68. <a name="l00015"></a>00015 <span class="comment">** not a published API of SQLite, is subject to change without</span>
    69. 

  69. <a name="l00016"></a>00016 <span class="comment">** notice, and should not be referenced by programs that use SQLite.</span>
    70. 

  70. <a name="l00017"></a>00017 <span class="comment">**</span>
    71. 

  71. <a name="l00018"></a>00018 <span class="comment">** Some of the definitions that are in this file are marked as</span>
    72. 

  72. <a name="l00019"></a>00019 <span class="comment">** &quot;experimental&quot;.  Experimental interfaces are normally new</span>
    73. 

  73. <a name="l00020"></a>00020 <span class="comment">** features recently added to SQLite.  We do not anticipate changes</span>
    74. 

  74. <a name="l00021"></a>00021 <span class="comment">** to experimental interfaces but reserve the right to make minor changes</span>
    75. 

  75. <a name="l00022"></a>00022 <span class="comment">** if experience from use &quot;in the wild&quot; suggest such changes are prudent.</span>
    76. 

  76. <a name="l00023"></a>00023 <span class="comment">**</span>
    77. 

  77. <a name="l00024"></a>00024 <span class="comment">** The official C-language API documentation for SQLite is derived</span>
    78. 

  78. <a name="l00025"></a>00025 <span class="comment">** from comments in this file.  This file is the authoritative source</span>
    79. 

  79. <a name="l00026"></a>00026 <span class="comment">** on how SQLite interfaces are suppose to operate.</span>
    80. 

  80. <a name="l00027"></a>00027 <span class="comment">**</span>
    81. 

  81. <a name="l00028"></a>00028 <span class="comment">** The name of this file under configuration management is &quot;sqlite.h.in&quot;.</span>
    82. 

  82. <a name="l00029"></a>00029 <span class="comment">** The makefile makes some minor changes to this file (such as inserting</span>
    83. 

  83. <a name="l00030"></a>00030 <span class="comment">** the version number) and changes its name to &quot;sqlite3.h&quot; as</span>
    84. 

  84. <a name="l00031"></a>00031 <span class="comment">** part of the build process.</span>
    85. 

  85. <a name="l00032"></a>00032 <span class="comment">*/</span>
    86. 

  86. <a name="l00033"></a>00033 <span class="preprocessor">#ifndef _SQLITE3_H_</span>
    87. 

  87. <a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define _SQLITE3_H_</span>
    88. 

  88. <a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#include &lt;stdarg.h&gt;</span>     <span class="comment">/* Needed for the definition of va_list */</span>
    89. 

  89. <a name="l00036"></a>00036 
    90. 

  90. <a name="l00037"></a>00037 <span class="comment">/*</span>
    91. 

  91. <a name="l00038"></a>00038 <span class="comment">** Make sure we can call this stuff from C++.</span>
    92. 

  92. <a name="l00039"></a>00039 <span class="comment">*/</span>
    93. 

  93. <a name="l00040"></a>00040 <span class="preprocessor">#ifdef __cplusplus</span>
    94. 

  94. <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
    95. 

  95. <a name="l00042"></a>00042 <span class="preprocessor">#endif</span>
    96. 

  96. <a name="l00043"></a>00043 <span class="preprocessor"></span>
    97. 

  97. <a name="l00044"></a>00044 
    98. 

  98. <a name="l00045"></a>00045 <span class="comment">/*</span>
    99. 

  99. <a name="l00046"></a>00046 <span class="comment">** Add the ability to override &#39;extern&#39;</span>
    100. 

  100. <a name="l00047"></a>00047 <span class="comment">*/</span>
    101. 

  101. <a name="l00048"></a>00048 <span class="preprocessor">#ifndef SQLITE_EXTERN</span>
    102. 

  102. <a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor"># define SQLITE_EXTERN extern</span>
    103. 

  103. <a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    104. 

  104. <a name="l00051"></a>00051 <span class="preprocessor"></span>
    105. 

  105. <a name="l00052"></a>00052 <span class="preprocessor">#ifndef SQLITE_API</span>
    106. 

  106. <a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor"># define SQLITE_API</span>
    107. 

  107. <a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    108. 

  108. <a name="l00055"></a>00055 <span class="preprocessor"></span>
    109. 

  109. <a name="l00056"></a>00056 
    110. 

  110. <a name="l00057"></a>00057 <span class="comment">/*</span>
    111. 

  111. <a name="l00058"></a>00058 <span class="comment">** These no-op macros are used in front of interfaces to mark those</span>
    112. 

  112. <a name="l00059"></a>00059 <span class="comment">** interfaces as either deprecated or experimental.  New applications</span>
    113. 

  113. <a name="l00060"></a>00060 <span class="comment">** should not use deprecated interfaces - they are support for backwards</span>
    114. 

  114. <a name="l00061"></a>00061 <span class="comment">** compatibility only.  Application writers should be aware that</span>
    115. 

  115. <a name="l00062"></a>00062 <span class="comment">** experimental interfaces are subject to change in point releases.</span>
    116. 

  116. <a name="l00063"></a>00063 <span class="comment">**</span>
    117. 

  117. <a name="l00064"></a>00064 <span class="comment">** These macros used to resolve to various kinds of compiler magic that</span>
    118. 

  118. <a name="l00065"></a>00065 <span class="comment">** would generate warning messages when they were used.  But that</span>
    119. 

  119. <a name="l00066"></a>00066 <span class="comment">** compiler magic ended up generating such a flurry of bug reports</span>
    120. 

  120. <a name="l00067"></a>00067 <span class="comment">** that we have taken it all out and gone back to using simple</span>
    121. 

  121. <a name="l00068"></a>00068 <span class="comment">** noop macros.</span>
    122. 

  122. <a name="l00069"></a>00069 <span class="comment">*/</span>
    123. 

  123. <a name="l00070"></a>00070 <span class="preprocessor">#define SQLITE_DEPRECATED</span>
    124. 

  124. <a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_EXPERIMENTAL</span>
    125. 

  125. <a name="l00072"></a>00072 <span class="preprocessor"></span>
    126. 

  126. <a name="l00073"></a>00073 <span class="comment">/*</span>
    127. 

  127. <a name="l00074"></a>00074 <span class="comment">** Ensure these symbols were not defined by some previous header file.</span>
    128. 

  128. <a name="l00075"></a>00075 <span class="comment">*/</span>
    129. 

  129. <a name="l00076"></a>00076 <span class="preprocessor">#ifdef SQLITE_VERSION</span>
    130. 

  130. <a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor"># undef SQLITE_VERSION</span>
    131. 

  131. <a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    132. 

  132. <a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#ifdef SQLITE_VERSION_NUMBER</span>
    133. 

  133. <a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor"># undef SQLITE_VERSION_NUMBER</span>
    134. 

  134. <a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    135. 

  135. <a name="l00082"></a>00082 <span class="preprocessor"></span>
    136. 

  136. <a name="l00083"></a>00083 <span class="comment">/*</span>
    137. 

  137. <a name="l00084"></a>00084 <span class="comment">** CAPI3REF: Compile-Time Library Version Numbers</span>
    138. 

  138. <a name="l00085"></a>00085 <span class="comment">**</span>
    139. 

  139. <a name="l00086"></a>00086 <span class="comment">** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header</span>
    140. 

  140. <a name="l00087"></a>00087 <span class="comment">** evaluates to a string literal that is the SQLite version in the</span>
    141. 

  141. <a name="l00088"></a>00088 <span class="comment">** format &quot;X.Y.Z&quot; where X is the major version number (always 3 for</span>
    142. 

  142. <a name="l00089"></a>00089 <span class="comment">** SQLite3) and Y is the minor version number and Z is the release number.)^</span>
    143. 

  143. <a name="l00090"></a>00090 <span class="comment">** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer</span>
    144. 

  144. <a name="l00091"></a>00091 <span class="comment">** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same</span>
    145. 

  145. <a name="l00092"></a>00092 <span class="comment">** numbers used in [SQLITE_VERSION].)^</span>
    146. 

  146. <a name="l00093"></a>00093 <span class="comment">** The SQLITE_VERSION_NUMBER for any given release of SQLite will also</span>
    147. 

  147. <a name="l00094"></a>00094 <span class="comment">** be larger than the release from which it is derived.  Either Y will</span>
    148. 

  148. <a name="l00095"></a>00095 <span class="comment">** be held constant and Z will be incremented or else Y will be incremented</span>
    149. 

  149. <a name="l00096"></a>00096 <span class="comment">** and Z will be reset to zero.</span>
    150. 

  150. <a name="l00097"></a>00097 <span class="comment">**</span>
    151. 

  151. <a name="l00098"></a>00098 <span class="comment">** Since version 3.6.18, SQLite source code has been stored in the</span>
    152. 

  152. <a name="l00099"></a>00099 <span class="comment">** &lt;a href=&quot;http://www.fossil-scm.org/&quot;&gt;Fossil configuration management</span>
    153. 

  153. <a name="l00100"></a>00100 <span class="comment">** system&lt;/a&gt;.  ^The SQLITE_SOURCE_ID macro evaluates to</span>
    154. 

  154. <a name="l00101"></a>00101 <span class="comment">** a string which identifies a particular check-in of SQLite</span>
    155. 

  155. <a name="l00102"></a>00102 <span class="comment">** within its configuration management system.  ^The SQLITE_SOURCE_ID</span>
    156. 

  156. <a name="l00103"></a>00103 <span class="comment">** string contains the date and time of the check-in (UTC) and an SHA1</span>
    157. 

  157. <a name="l00104"></a>00104 <span class="comment">** hash of the entire source tree.</span>
    158. 

  158. <a name="l00105"></a>00105 <span class="comment">**</span>
    159. 

  159. <a name="l00106"></a>00106 <span class="comment">** See also: [sqlite3_libversion()],</span>
    160. 

  160. <a name="l00107"></a>00107 <span class="comment">** [sqlite3_libversion_number()], [sqlite3_sourceid()],</span>
    161. 

  161. <a name="l00108"></a>00108 <span class="comment">** [sqlite_version()] and [sqlite_source_id()].</span>
    162. 

  162. <a name="l00109"></a>00109 <span class="comment">*/</span>
    163. 

  163. <a name="l00110"></a>00110 <span class="preprocessor">#define SQLITE_VERSION        &quot;3.7.10&quot;</span>
    164. 

  164. <a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_VERSION_NUMBER 3007010</span>
    165. 

  165. <a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_SOURCE_ID      &quot;2012-01-16 13:28:40 ebd01a8deffb5024a5d7494eef800d2366d97204&quot;</span>
    166. 

  166. <a name="l00113"></a>00113 <span class="preprocessor"></span>
    167. 

  167. <a name="l00114"></a>00114 <span class="comment">/*</span>
    168. 

  168. <a name="l00115"></a>00115 <span class="comment">** CAPI3REF: Run-Time Library Version Numbers</span>
    169. 

  169. <a name="l00116"></a>00116 <span class="comment">** KEYWORDS: sqlite3_version, sqlite3_sourceid</span>
    170. 

  170. <a name="l00117"></a>00117 <span class="comment">**</span>
    171. 

  171. <a name="l00118"></a>00118 <span class="comment">** These interfaces provide the same information as the [SQLITE_VERSION],</span>
    172. 

  172. <a name="l00119"></a>00119 <span class="comment">** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros</span>
    173. 

  173. <a name="l00120"></a>00120 <span class="comment">** but are associated with the library instead of the header file.  ^(Cautious</span>
    174. 

  174. <a name="l00121"></a>00121 <span class="comment">** programmers might include assert() statements in their application to</span>
    175. 

  175. <a name="l00122"></a>00122 <span class="comment">** verify that values returned by these interfaces match the macros in</span>
    176. 

  176. <a name="l00123"></a>00123 <span class="comment">** the header, and thus insure that the application is</span>
    177. 

  177. <a name="l00124"></a>00124 <span class="comment">** compiled with matching library and header files.</span>
    178. 

  178. <a name="l00125"></a>00125 <span class="comment">**</span>
    179. 

  179. <a name="l00126"></a>00126 <span class="comment">** &lt;blockquote&gt;&lt;pre&gt;</span>
    180. 

  180. <a name="l00127"></a>00127 <span class="comment">** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );</span>
    181. 

  181. <a name="l00128"></a>00128 <span class="comment">** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );</span>
    182. 

  182. <a name="l00129"></a>00129 <span class="comment">** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );</span>
    183. 

  183. <a name="l00130"></a>00130 <span class="comment">** &lt;/pre&gt;&lt;/blockquote&gt;)^</span>
    184. 

  184. <a name="l00131"></a>00131 <span class="comment">**</span>
    185. 

  185. <a name="l00132"></a>00132 <span class="comment">** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]</span>
    186. 

  186. <a name="l00133"></a>00133 <span class="comment">** macro.  ^The sqlite3_libversion() function returns a pointer to the</span>
    187. 

  187. <a name="l00134"></a>00134 <span class="comment">** to the sqlite3_version[] string constant.  The sqlite3_libversion()</span>
    188. 

  188. <a name="l00135"></a>00135 <span class="comment">** function is provided for use in DLLs since DLL users usually do not have</span>
    189. 

  189. <a name="l00136"></a>00136 <span class="comment">** direct access to string constants within the DLL.  ^The</span>
    190. 

  190. <a name="l00137"></a>00137 <span class="comment">** sqlite3_libversion_number() function returns an integer equal to</span>
    191. 

  191. <a name="l00138"></a>00138 <span class="comment">** [SQLITE_VERSION_NUMBER].  ^The sqlite3_sourceid() function returns </span>
    192. 

  192. <a name="l00139"></a>00139 <span class="comment">** a pointer to a string constant whose value is the same as the </span>
    193. 

  193. <a name="l00140"></a>00140 <span class="comment">** [SQLITE_SOURCE_ID] C preprocessor macro.</span>
    194. 

  194. <a name="l00141"></a>00141 <span class="comment">**</span>
    195. 

  195. <a name="l00142"></a>00142 <span class="comment">** See also: [sqlite_version()] and [sqlite_source_id()].</span>
    196. 

  196. <a name="l00143"></a>00143 <span class="comment">*/</span>
    197. 

  197. <a name="l00144"></a>00144 SQLITE_API SQLITE_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> sqlite3_version[];
    198. 

  198. <a name="l00145"></a>00145 SQLITE_API <span class="keyword">const</span> <span class="keywordtype">char</span> *sqlite3_libversion(<span class="keywordtype">void</span>);
    199. 

  199. <a name="l00146"></a>00146 SQLITE_API <span class="keyword">const</span> <span class="keywordtype">char</span> *sqlite3_sourceid(<span class="keywordtype">void</span>);
    200. 

  200. <a name="l00147"></a>00147 SQLITE_API <span class="keywordtype">int</span> sqlite3_libversion_number(<span class="keywordtype">void</span>);
    201. 

  201. <a name="l00148"></a>00148 
    202. 

  202. <a name="l00149"></a>00149 <span class="comment">/*</span>
    203. 

  203. <a name="l00150"></a>00150 <span class="comment">** CAPI3REF: Run-Time Library Compilation Options Diagnostics</span>
    204. 

  204. <a name="l00151"></a>00151 <span class="comment">**</span>
    205. 

  205. <a name="l00152"></a>00152 <span class="comment">** ^The sqlite3_compileoption_used() function returns 0 or 1 </span>
    206. 

  206. <a name="l00153"></a>00153 <span class="comment">** indicating whether the specified option was defined at </span>
    207. 

  207. <a name="l00154"></a>00154 <span class="comment">** compile time.  ^The SQLITE_ prefix may be omitted from the </span>
    208. 

  208. <a name="l00155"></a>00155 <span class="comment">** option name passed to sqlite3_compileoption_used().  </span>
    209. 

  209. <a name="l00156"></a>00156 <span class="comment">**</span>
    210. 

  210. <a name="l00157"></a>00157 <span class="comment">** ^The sqlite3_compileoption_get() function allows iterating</span>
    211. 

  211. <a name="l00158"></a>00158 <span class="comment">** over the list of options that were defined at compile time by</span>
    212. 

  212. <a name="l00159"></a>00159 <span class="comment">** returning the N-th compile time option string.  ^If N is out of range,</span>
    213. 

  213. <a name="l00160"></a>00160 <span class="comment">** sqlite3_compileoption_get() returns a NULL pointer.  ^The SQLITE_ </span>
    214. 

  214. <a name="l00161"></a>00161 <span class="comment">** prefix is omitted from any strings returned by </span>
    215. 

  215. <a name="l00162"></a>00162 <span class="comment">** sqlite3_compileoption_get().</span>
    216. 

  216. <a name="l00163"></a>00163 <span class="comment">**</span>
    217. 

  217. <a name="l00164"></a>00164 <span class="comment">** ^Support for the diagnostic functions sqlite3_compileoption_used()</span>
    218. 

  218. <a name="l00165"></a>00165 <span class="comment">** and sqlite3_compileoption_get() may be omitted by specifying the </span>
    219. 

  219. <a name="l00166"></a>00166 <span class="comment">** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.</span>
    220. 

  220. <a name="l00167"></a>00167 <span class="comment">**</span>
    221. 

  221. <a name="l00168"></a>00168 <span class="comment">** See also: SQL functions [sqlite_compileoption_used()] and</span>
    222. 

  222. <a name="l00169"></a>00169 <span class="comment">** [sqlite_compileoption_get()] and the [compile_options pragma].</span>
    223. 

  223. <a name="l00170"></a>00170 <span class="comment">*/</span>
    224. 

  224. <a name="l00171"></a>00171 <span class="preprocessor">#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS</span>
    225. 

  225. <a name="l00172"></a>00172 <span class="preprocessor"></span>SQLITE_API <span class="keywordtype">int</span> sqlite3_compileoption_used(<span class="keyword">const</span> <span class="keywordtype">char</span> *zOptName);
    226. 

  226. <a name="l00173"></a>00173 SQLITE_API <span class="keyword">const</span> <span class="keywordtype">char</span> *sqlite3_compileoption_get(<span class="keywordtype">int</span> N);
    227. 

  227. <a name="l00174"></a>00174 <span class="preprocessor">#endif</span>
    228. 

  228. <a name="l00175"></a>00175 <span class="preprocessor"></span>
    229. 

  229. <a name="l00176"></a>00176 <span class="comment">/*</span>
    230. 

  230. <a name="l00177"></a>00177 <span class="comment">** CAPI3REF: Test To See If The Library Is Threadsafe</span>
    231. 

  231. <a name="l00178"></a>00178 <span class="comment">**</span>
    232. 

  232. <a name="l00179"></a>00179 <span class="comment">** ^The sqlite3_threadsafe() function returns zero if and only if</span>
    233. 

  233. <a name="l00180"></a>00180 <span class="comment">** SQLite was compiled with mutexing code omitted due to the</span>
    234. 

  234. <a name="l00181"></a>00181 <span class="comment">** [SQLITE_THREADSAFE] compile-time option being set to 0.</span>
    235. 

  235. <a name="l00182"></a>00182 <span class="comment">**</span>
    236. 

  236. <a name="l00183"></a>00183 <span class="comment">** SQLite can be compiled with or without mutexes.  When</span>
    237. 

  237. <a name="l00184"></a>00184 <span class="comment">** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes</span>
    238. 

  238. <a name="l00185"></a>00185 <span class="comment">** are enabled and SQLite is threadsafe.  When the</span>
    239. 

  239. <a name="l00186"></a>00186 <span class="comment">** [SQLITE_THREADSAFE] macro is 0, </span>
    240. 

  240. <a name="l00187"></a>00187 <span class="comment">** the mutexes are omitted.  Without the mutexes, it is not safe</span>
    241. 

  241. <a name="l00188"></a>00188 <span class="comment">** to use SQLite concurrently from more than one thread.</span>
    242. 

  242. <a name="l00189"></a>00189 <span class="comment">**</span>
    243. 

  243. <a name="l00190"></a>00190 <span class="comment">** Enabling mutexes incurs a measurable performance penalty.</span>
    244. 

  244. <a name="l00191"></a>00191 <span class="comment">** So if speed is of utmost importance, it makes sense to disable</span>
    245. 

  245. <a name="l00192"></a>00192 <span class="comment">** the mutexes.  But for maximum safety, mutexes should be enabled.</span>
    246. 

  246. <a name="l00193"></a>00193 <span class="comment">** ^The default behavior is for mutexes to be enabled.</span>
    247. 

  247. <a name="l00194"></a>00194 <span class="comment">**</span>
    248. 

  248. <a name="l00195"></a>00195 <span class="comment">** This interface can be used by an application to make sure that the</span>
    249. 

  249. <a name="l00196"></a>00196 <span class="comment">** version of SQLite that it is linking against was compiled with</span>
    250. 

  250. <a name="l00197"></a>00197 <span class="comment">** the desired setting of the [SQLITE_THREADSAFE] macro.</span>
    251. 

  251. <a name="l00198"></a>00198 <span class="comment">**</span>
    252. 

  252. <a name="l00199"></a>00199 <span class="comment">** This interface only reports on the compile-time mutex setting</span>
    253. 

  253. <a name="l00200"></a>00200 <span class="comment">** of the [SQLITE_THREADSAFE] flag.  If SQLite is compiled with</span>
    254. 

  254. <a name="l00201"></a>00201 <span class="comment">** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but</span>
    255. 

  255. <a name="l00202"></a>00202 <span class="comment">** can be fully or partially disabled using a call to [sqlite3_config()]</span>
    256. 

  256. <a name="l00203"></a>00203 <span class="comment">** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],</span>
    257. 

  257. <a name="l00204"></a>00204 <span class="comment">** or [SQLITE_CONFIG_MUTEX].  ^(The return value of the</span>
    258. 

  258. <a name="l00205"></a>00205 <span class="comment">** sqlite3_threadsafe() function shows only the compile-time setting of</span>
    259. 

  259. <a name="l00206"></a>00206 <span class="comment">** thread safety, not any run-time changes to that setting made by</span>
    260. 

  260. <a name="l00207"></a>00207 <span class="comment">** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()</span>
    261. 

  261. <a name="l00208"></a>00208 <span class="comment">** is unchanged by calls to sqlite3_config().)^</span>
    262. 

  262. <a name="l00209"></a>00209 <span class="comment">**</span>
    263. 

  263. <a name="l00210"></a>00210 <span class="comment">** See the [threading mode] documentation for additional information.</span>
    264. 

  264. <a name="l00211"></a>00211 <span class="comment">*/</span>
    265. 

  265. <a name="l00212"></a>00212 SQLITE_API <span class="keywordtype">int</span> sqlite3_threadsafe(<span class="keywordtype">void</span>);
    266. 

  266. <a name="l00213"></a>00213 
    267. 

  267. <a name="l00214"></a>00214 <span class="comment">/*</span>
    268. 

  268. <a name="l00215"></a>00215 <span class="comment">** CAPI3REF: Database Connection Handle</span>
    269. 

  269. <a name="l00216"></a>00216 <span class="comment">** KEYWORDS: {database connection} {database connections}</span>
    270. 

  270. <a name="l00217"></a>00217 <span class="comment">**</span>
    271. 

  271. <a name="l00218"></a>00218 <span class="comment">** Each open SQLite database is represented by a pointer to an instance of</span>
    272. 

  272. <a name="l00219"></a>00219 <span class="comment">** the opaque structure named &quot;sqlite3&quot;.  It is useful to think of an sqlite3</span>
    273. 

  273. <a name="l00220"></a>00220 <span class="comment">** pointer as an object.  The [sqlite3_open()], [sqlite3_open16()], and</span>
    274. 

  274. <a name="l00221"></a>00221 <span class="comment">** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]</span>
    275. 

  275. <a name="l00222"></a>00222 <span class="comment">** is its destructor.  There are many other interfaces (such as</span>
    276. 

  276. <a name="l00223"></a>00223 <span class="comment">** [sqlite3_prepare_v2()], [sqlite3_create_function()], and</span>
    277. 

  277. <a name="l00224"></a>00224 <span class="comment">** [sqlite3_busy_timeout()] to name but three) that are methods on an</span>
    278. 

  278. <a name="l00225"></a>00225 <span class="comment">** sqlite3 object.</span>
    279. 

  279. <a name="l00226"></a>00226 <span class="comment">*/</span>
    280. 

  280. <a name="l00227"></a>00227 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsqlite3.html">sqlite3</a> <a class="code" href="structsqlite3.html">sqlite3</a>;
    281. 

  281. <a name="l00228"></a>00228 
    282. 

  282. <a name="l00229"></a>00229 <span class="comment">/*</span>
    283. 

  283. <a name="l00230"></a>00230 <span class="comment">** CAPI3REF: 64-Bit Integer Types</span>
    284. 

  284. <a name="l00231"></a>00231 <span class="comment">** KEYWORDS: sqlite_int64 sqlite_uint64</span>
    285. 

  285. <a name="l00232"></a>00232 <span class="comment">**</span>
    286. 

  286. <a name="l00233"></a>00233 <span class="comment">** Because there is no cross-platform way to specify 64-bit integer types</span>
    287. 

  287. <a name="l00234"></a>00234 <span class="comment">** SQLite includes typedefs for 64-bit signed and unsigned integers.</span>
    288. 

  288. <a name="l00235"></a>00235 <span class="comment">**</span>
    289. 

  289. <a name="l00236"></a>00236 <span class="comment">** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.</span>
    290. 

  290. <a name="l00237"></a>00237 <span class="comment">** The sqlite_int64 and sqlite_uint64 types are supported for backwards</span>
    291. 

  291. <a name="l00238"></a>00238 <span class="comment">** compatibility only.</span>
    292. 

  292. <a name="l00239"></a>00239 <span class="comment">**</span>
    293. 

  293. <a name="l00240"></a>00240 <span class="comment">** ^The sqlite3_int64 and sqlite_int64 types can store integer values</span>
    294. 

  294. <a name="l00241"></a>00241 <span class="comment">** between -9223372036854775808 and +9223372036854775807 inclusive.  ^The</span>
    295. 

  295. <a name="l00242"></a>00242 <span class="comment">** sqlite3_uint64 and sqlite_uint64 types can store integer values </span>
    296. 

  296. <a name="l00243"></a>00243 <span class="comment">** between 0 and +18446744073709551615 inclusive.</span>
    297. 

  297. <a name="l00244"></a>00244 <span class="comment">*/</span>
    298. 

  298. <a name="l00245"></a>00245 <span class="preprocessor">#ifdef SQLITE_INT64_TYPE</span>
    299. 

  299. <a name="l00246"></a>00246 <span class="preprocessor"></span>  <span class="keyword">typedef</span> SQLITE_INT64_TYPE sqlite_int64;
    300. 

  300. <a name="l00247"></a>00247   <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> SQLITE_INT64_TYPE sqlite_uint64;
    301. 

  301. <a name="l00248"></a>00248 <span class="preprocessor">#elif defined(_MSC_VER) || defined(__BORLANDC__)</span>
    302. 

  302. <a name="l00249"></a>00249 <span class="preprocessor"></span>  <span class="keyword">typedef</span> __int64 sqlite_int64;
    303. 

  303. <a name="l00250"></a>00250   <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> __int64 sqlite_uint64;
    304. 

  304. <a name="l00251"></a>00251 <span class="preprocessor">#else</span>
    305. 

  305. <a name="l00252"></a>00252 <span class="preprocessor"></span>  <span class="keyword">typedef</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> sqlite_int64;
    306. 

  306. <a name="l00253"></a>00253   <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> sqlite_uint64;
    307. 

  307. <a name="l00254"></a>00254 <span class="preprocessor">#endif</span>
    308. 

  308. <a name="l00255"></a>00255 <span class="preprocessor"></span><span class="keyword">typedef</span> sqlite_int64 sqlite3_int64;
    309. 

  309. <a name="l00256"></a>00256 <span class="keyword">typedef</span> sqlite_uint64 sqlite3_uint64;
    310. 

  310. <a name="l00257"></a>00257 
    311. 

  311. <a name="l00258"></a>00258 <span class="comment">/*</span>
    312. 

  312. <a name="l00259"></a>00259 <span class="comment">** If compiling for a processor that lacks floating point support,</span>
    313. 

  313. <a name="l00260"></a>00260 <span class="comment">** substitute integer for floating-point.</span>
    314. 

  314. <a name="l00261"></a>00261 <span class="comment">*/</span>
    315. 

  315. <a name="l00262"></a>00262 <span class="preprocessor">#ifdef SQLITE_OMIT_FLOATING_POINT</span>
    316. 

  316. <a name="l00263"></a>00263 <span class="preprocessor"></span><span class="preprocessor"># define double sqlite3_int64</span>
    317. 

  317. <a name="l00264"></a>00264 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    318. 

  318. <a name="l00265"></a>00265 <span class="preprocessor"></span>
    319. 

  319. <a name="l00266"></a>00266 <span class="comment">/*</span>
    320. 

  320. <a name="l00267"></a>00267 <span class="comment">** CAPI3REF: Closing A Database Connection</span>
    321. 

  321. <a name="l00268"></a>00268 <span class="comment">**</span>
    322. 

  322. <a name="l00269"></a>00269 <span class="comment">** ^The sqlite3_close() routine is the destructor for the [sqlite3] object.</span>
    323. 

  323. <a name="l00270"></a>00270 <span class="comment">** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is</span>
    324. 

  324. <a name="l00271"></a>00271 <span class="comment">** successfully destroyed and all associated resources are deallocated.</span>
    325. 

  325. <a name="l00272"></a>00272 <span class="comment">**</span>
    326. 

  326. <a name="l00273"></a>00273 <span class="comment">** Applications must [sqlite3_finalize | finalize] all [prepared statements]</span>
    327. 

  327. <a name="l00274"></a>00274 <span class="comment">** and [sqlite3_blob_close | close] all [BLOB handles] associated with</span>
    328. 

  328. <a name="l00275"></a>00275 <span class="comment">** the [sqlite3] object prior to attempting to close the object.  ^If</span>
    329. 

  329. <a name="l00276"></a>00276 <span class="comment">** sqlite3_close() is called on a [database connection] that still has</span>
    330. 

  330. <a name="l00277"></a>00277 <span class="comment">** outstanding [prepared statements] or [BLOB handles], then it returns</span>
    331. 

  331. <a name="l00278"></a>00278 <span class="comment">** SQLITE_BUSY.</span>
    332. 

  332. <a name="l00279"></a>00279 <span class="comment">**</span>
    333. 

  333. <a name="l00280"></a>00280 <span class="comment">** ^If [sqlite3_close()] is invoked while a transaction is open,</span>
    334. 

  334. <a name="l00281"></a>00281 <span class="comment">** the transaction is automatically rolled back.</span>
    335. 

  335. <a name="l00282"></a>00282 <span class="comment">**</span>
    336. 

  336. <a name="l00283"></a>00283 <span class="comment">** The C parameter to [sqlite3_close(C)] must be either a NULL</span>
    337. 

  337. <a name="l00284"></a>00284 <span class="comment">** pointer or an [sqlite3] object pointer obtained</span>
    338. 

  338. <a name="l00285"></a>00285 <span class="comment">** from [sqlite3_open()], [sqlite3_open16()], or</span>
    339. 

  339. <a name="l00286"></a>00286 <span class="comment">** [sqlite3_open_v2()], and not previously closed.</span>
    340. 

  340. <a name="l00287"></a>00287 <span class="comment">** ^Calling sqlite3_close() with a NULL pointer argument is a </span>
    341. 

  341. <a name="l00288"></a>00288 <span class="comment">** harmless no-op.</span>
    342. 

  342. <a name="l00289"></a>00289 <span class="comment">*/</span>
    343. 

  343. <a name="l00290"></a>00290 SQLITE_API <span class="keywordtype">int</span> sqlite3_close(<a class="code" href="structsqlite3.html">sqlite3</a> *);
    344. 

  344. <a name="l00291"></a>00291 
    345. 

  345. <a name="l00292"></a>00292 <span class="comment">/*</span>
    346. 

  346. <a name="l00293"></a>00293 <span class="comment">** The type for a callback function.</span>
    347. 

  347. <a name="l00294"></a>00294 <span class="comment">** This is legacy and deprecated.  It is included for historical</span>
    348. 

  348. <a name="l00295"></a>00295 <span class="comment">** compatibility and is not documented.</span>
    349. 

  349. <a name="l00296"></a>00296 <span class="comment">*/</span>
    350. 

  350. <a name="l00297"></a>00297 <span class="keyword">typedef</span> int (*sqlite3_callback)(<span class="keywordtype">void</span>*,int,<span class="keywordtype">char</span>**, <span class="keywordtype">char</span>**);
    351. 

  351. <a name="l00298"></a>00298 
    352. 

  352. <a name="l00299"></a>00299 <span class="comment">/*</span>
    353. 

  353. <a name="l00300"></a>00300 <span class="comment">** CAPI3REF: One-Step Query Execution Interface</span>
    354. 

  354. <a name="l00301"></a>00301 <span class="comment">**</span>
    355. 

  355. <a name="l00302"></a>00302 <span class="comment">** The sqlite3_exec() interface is a convenience wrapper around</span>
    356. 

  356. <a name="l00303"></a>00303 <span class="comment">** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],</span>
    357. 

  357. <a name="l00304"></a>00304 <span class="comment">** that allows an application to run multiple statements of SQL</span>
    358. 

  358. <a name="l00305"></a>00305 <span class="comment">** without having to use a lot of C code. </span>
    359. 

  359. <a name="l00306"></a>00306 <span class="comment">**</span>
    360. 

  360. <a name="l00307"></a>00307 <span class="comment">** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,</span>
    361. 

  361. <a name="l00308"></a>00308 <span class="comment">** semicolon-separate SQL statements passed into its 2nd argument,</span>
    362. 

  362. <a name="l00309"></a>00309 <span class="comment">** in the context of the [database connection] passed in as its 1st</span>
    363. 

  363. <a name="l00310"></a>00310 <span class="comment">** argument.  ^If the callback function of the 3rd argument to</span>
    364. 

  364. <a name="l00311"></a>00311 <span class="comment">** sqlite3_exec() is not NULL, then it is invoked for each result row</span>
    365. 

  365. <a name="l00312"></a>00312 <span class="comment">** coming out of the evaluated SQL statements.  ^The 4th argument to</span>
    366. 

  366. <a name="l00313"></a>00313 <span class="comment">** sqlite3_exec() is relayed through to the 1st argument of each</span>
    367. 

  367. <a name="l00314"></a>00314 <span class="comment">** callback invocation.  ^If the callback pointer to sqlite3_exec()</span>
    368. 

  368. <a name="l00315"></a>00315 <span class="comment">** is NULL, then no callback is ever invoked and result rows are</span>
    369. 

  369. <a name="l00316"></a>00316 <span class="comment">** ignored.</span>
    370. 

  370. <a name="l00317"></a>00317 <span class="comment">**</span>
    371. 

  371. <a name="l00318"></a>00318 <span class="comment">** ^If an error occurs while evaluating the SQL statements passed into</span>
    372. 

  372. <a name="l00319"></a>00319 <span class="comment">** sqlite3_exec(), then execution of the current statement stops and</span>
    373. 

  373. <a name="l00320"></a>00320 <span class="comment">** subsequent statements are skipped.  ^If the 5th parameter to sqlite3_exec()</span>
    374. 

  374. <a name="l00321"></a>00321 <span class="comment">** is not NULL then any error message is written into memory obtained</span>
    375. 

  375. <a name="l00322"></a>00322 <span class="comment">** from [sqlite3_malloc()] and passed back through the 5th parameter.</span>
    376. 

  376. <a name="l00323"></a>00323 <span class="comment">** To avoid memory leaks, the application should invoke [sqlite3_free()]</span>
    377. 

  377. <a name="l00324"></a>00324 <span class="comment">** on error message strings returned through the 5th parameter of</span>
    378. 

  378. <a name="l00325"></a>00325 <span class="comment">** of sqlite3_exec() after the error message string is no longer needed.</span>
    379. 

  379. <a name="l00326"></a>00326 <span class="comment">** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors</span>
    380. 

  380. <a name="l00327"></a>00327 <span class="comment">** occur, then sqlite3_exec() sets the pointer in its 5th parameter to</span>
    381. 

  381. <a name="l00328"></a>00328 <span class="comment">** NULL before returning.</span>
    382. 

  382. <a name="l00329"></a>00329 <span class="comment">**</span>
    383. 

  383. <a name="l00330"></a>00330 <span class="comment">** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()</span>
    384. 

  384. <a name="l00331"></a>00331 <span class="comment">** routine returns SQLITE_ABORT without invoking the callback again and</span>
    385. 

  385. <a name="l00332"></a>00332 <span class="comment">** without running any subsequent SQL statements.</span>
    386. 

  386. <a name="l00333"></a>00333 <span class="comment">**</span>
    387. 

  387. <a name="l00334"></a>00334 <span class="comment">** ^The 2nd argument to the sqlite3_exec() callback function is the</span>
    388. 

  388. <a name="l00335"></a>00335 <span class="comment">** number of columns in the result.  ^The 3rd argument to the sqlite3_exec()</span>
    389. 

  389. <a name="l00336"></a>00336 <span class="comment">** callback is an array of pointers to strings obtained as if from</span>
    390. 

  390. <a name="l00337"></a>00337 <span class="comment">** [sqlite3_column_text()], one for each column.  ^If an element of a</span>
    391. 

  391. <a name="l00338"></a>00338 <span class="comment">** result row is NULL then the corresponding string pointer for the</span>
    392. 

  392. <a name="l00339"></a>00339 <span class="comment">** sqlite3_exec() callback is a NULL pointer.  ^The 4th argument to the</span>
    393. 

  393. <a name="l00340"></a>00340 <span class="comment">** sqlite3_exec() callback is an array of pointers to strings where each</span>
    394. 

  394. <a name="l00341"></a>00341 <span class="comment">** entry represents the name of corresponding result column as obtained</span>
    395. 

  395. <a name="l00342"></a>00342 <span class="comment">** from [sqlite3_column_name()].</span>
    396. 

  396. <a name="l00343"></a>00343 <span class="comment">**</span>
    397. 

  397. <a name="l00344"></a>00344 <span class="comment">** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer</span>
    398. 

  398. <a name="l00345"></a>00345 <span class="comment">** to an empty string, or a pointer that contains only whitespace and/or </span>
    399. 

  399. <a name="l00346"></a>00346 <span class="comment">** SQL comments, then no SQL statements are evaluated and the database</span>
    400. 

  400. <a name="l00347"></a>00347 <span class="comment">** is not changed.</span>
    401. 

  401. <a name="l00348"></a>00348 <span class="comment">**</span>
    402. 

  402. <a name="l00349"></a>00349 <span class="comment">** Restrictions:</span>
    403. 

  403. <a name="l00350"></a>00350 <span class="comment">**</span>
    404. 

  404. <a name="l00351"></a>00351 <span class="comment">** &lt;ul&gt;</span>
    405. 

  405. <a name="l00352"></a>00352 <span class="comment">** &lt;li&gt; The application must insure that the 1st parameter to sqlite3_exec()</span>
    406. 

  406. <a name="l00353"></a>00353 <span class="comment">**      is a valid and open [database connection].</span>
    407. 

  407. <a name="l00354"></a>00354 <span class="comment">** &lt;li&gt; The application must not close [database connection] specified by</span>
    408. 

  408. <a name="l00355"></a>00355 <span class="comment">**      the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.</span>
    409. 

  409. <a name="l00356"></a>00356 <span class="comment">** &lt;li&gt; The application must not modify the SQL statement text passed into</span>
    410. 

  410. <a name="l00357"></a>00357 <span class="comment">**      the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.</span>
    411. 

  411. <a name="l00358"></a>00358 <span class="comment">** &lt;/ul&gt;</span>
    412. 

  412. <a name="l00359"></a>00359 <span class="comment">*/</span>
    413. 

  413. <a name="l00360"></a>00360 SQLITE_API <span class="keywordtype">int</span> sqlite3_exec(
    414. 

  414. <a name="l00361"></a>00361   <a class="code" href="structsqlite3.html">sqlite3</a>*,                                  <span class="comment">/* An open database */</span>
    415. 

  415. <a name="l00362"></a>00362   <span class="keyword">const</span> <span class="keywordtype">char</span> *sql,                           <span class="comment">/* SQL to be evaluated */</span>
    416. 

  416. <a name="l00363"></a>00363   <span class="keywordtype">int</span> (*callback)(<span class="keywordtype">void</span>*,<span class="keywordtype">int</span>,<span class="keywordtype">char</span>**,<span class="keywordtype">char</span>**),  <span class="comment">/* Callback function */</span>
    417. 

  417. <a name="l00364"></a>00364   <span class="keywordtype">void</span> *,                                    <span class="comment">/* 1st argument to callback */</span>
    418. 

  418. <a name="l00365"></a>00365   <span class="keywordtype">char</span> **errmsg                              <span class="comment">/* Error msg written here */</span>
    419. 

  419. <a name="l00366"></a>00366 );
    420. 

  420. <a name="l00367"></a>00367 
    421. 

  421. <a name="l00368"></a>00368 <span class="comment">/*</span>
    422. 

  422. <a name="l00369"></a>00369 <span class="comment">** CAPI3REF: Result Codes</span>
    423. 

  423. <a name="l00370"></a>00370 <span class="comment">** KEYWORDS: SQLITE_OK {error code} {error codes}</span>
    424. 

  424. <a name="l00371"></a>00371 <span class="comment">** KEYWORDS: {result code} {result codes}</span>
    425. 

  425. <a name="l00372"></a>00372 <span class="comment">**</span>
    426. 

  426. <a name="l00373"></a>00373 <span class="comment">** Many SQLite functions return an integer result code from the set shown</span>
    427. 

  427. <a name="l00374"></a>00374 <span class="comment">** here in order to indicate success or failure.</span>
    428. 

  428. <a name="l00375"></a>00375 <span class="comment">**</span>
    429. 

  429. <a name="l00376"></a>00376 <span class="comment">** New error codes may be added in future versions of SQLite.</span>
    430. 

  430. <a name="l00377"></a>00377 <span class="comment">**</span>
    431. 

  431. <a name="l00378"></a>00378 <span class="comment">** See also: [SQLITE_IOERR_READ | extended result codes],</span>
    432. 

  432. <a name="l00379"></a>00379 <span class="comment">** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes].</span>
    433. 

  433. <a name="l00380"></a>00380 <span class="comment">*/</span>
    434. 

  434. <a name="l00381"></a>00381 <span class="preprocessor">#define SQLITE_OK           0   </span><span class="comment">/* Successful result */</span>
    435. 

  435. <a name="l00382"></a>00382 <span class="comment">/* beginning-of-error-codes */</span>
    436. 

  436. <a name="l00383"></a>00383 <span class="preprocessor">#define SQLITE_ERROR        1   </span><span class="comment">/* SQL error or missing database */</span>
    437. 

  437. <a name="l00384"></a>00384 <span class="preprocessor">#define SQLITE_INTERNAL     2   </span><span class="comment">/* Internal logic error in SQLite */</span>
    438. 

  438. <a name="l00385"></a>00385 <span class="preprocessor">#define SQLITE_PERM         3   </span><span class="comment">/* Access permission denied */</span>
    439. 

  439. <a name="l00386"></a>00386 <span class="preprocessor">#define SQLITE_ABORT        4   </span><span class="comment">/* Callback routine requested an abort */</span>
    440. 

  440. <a name="l00387"></a>00387 <span class="preprocessor">#define SQLITE_BUSY         5   </span><span class="comment">/* The database file is locked */</span>
    441. 

  441. <a name="l00388"></a>00388 <span class="preprocessor">#define SQLITE_LOCKED       6   </span><span class="comment">/* A table in the database is locked */</span>
    442. 

  442. <a name="l00389"></a>00389 <span class="preprocessor">#define SQLITE_NOMEM        7   </span><span class="comment">/* A malloc() failed */</span>
    443. 

  443. <a name="l00390"></a>00390 <span class="preprocessor">#define SQLITE_READONLY     8   </span><span class="comment">/* Attempt to write a readonly database */</span>
    444. 

  444. <a name="l00391"></a>00391 <span class="preprocessor">#define SQLITE_INTERRUPT    9   </span><span class="comment">/* Operation terminated by sqlite3_interrupt()*/</span>
    445. 

  445. <a name="l00392"></a>00392 <span class="preprocessor">#define SQLITE_IOERR       10   </span><span class="comment">/* Some kind of disk I/O error occurred */</span>
    446. 

  446. <a name="l00393"></a>00393 <span class="preprocessor">#define SQLITE_CORRUPT     11   </span><span class="comment">/* The database disk image is malformed */</span>
    447. 

  447. <a name="l00394"></a>00394 <span class="preprocessor">#define SQLITE_NOTFOUND    12   </span><span class="comment">/* Unknown opcode in sqlite3_file_control() */</span>
    448. 

  448. <a name="l00395"></a>00395 <span class="preprocessor">#define SQLITE_FULL        13   </span><span class="comment">/* Insertion failed because database is full */</span>
    449. 

  449. <a name="l00396"></a>00396 <span class="preprocessor">#define SQLITE_CANTOPEN    14   </span><span class="comment">/* Unable to open the database file */</span>
    450. 

  450. <a name="l00397"></a>00397 <span class="preprocessor">#define SQLITE_PROTOCOL    15   </span><span class="comment">/* Database lock protocol error */</span>
    451. 

  451. <a name="l00398"></a>00398 <span class="preprocessor">#define SQLITE_EMPTY       16   </span><span class="comment">/* Database is empty */</span>
    452. 

  452. <a name="l00399"></a>00399 <span class="preprocessor">#define SQLITE_SCHEMA      17   </span><span class="comment">/* The database schema changed */</span>
    453. 

  453. <a name="l00400"></a>00400 <span class="preprocessor">#define SQLITE_TOOBIG      18   </span><span class="comment">/* String or BLOB exceeds size limit */</span>
    454. 

  454. <a name="l00401"></a>00401 <span class="preprocessor">#define SQLITE_CONSTRAINT  19   </span><span class="comment">/* Abort due to constraint violation */</span>
    455. 

  455. <a name="l00402"></a>00402 <span class="preprocessor">#define SQLITE_MISMATCH    20   </span><span class="comment">/* Data type mismatch */</span>
    456. 

  456. <a name="l00403"></a>00403 <span class="preprocessor">#define SQLITE_MISUSE      21   </span><span class="comment">/* Library used incorrectly */</span>
    457. 

  457. <a name="l00404"></a>00404 <span class="preprocessor">#define SQLITE_NOLFS       22   </span><span class="comment">/* Uses OS features not supported on host */</span>
    458. 

  458. <a name="l00405"></a>00405 <span class="preprocessor">#define SQLITE_AUTH        23   </span><span class="comment">/* Authorization denied */</span>
    459. 

  459. <a name="l00406"></a>00406 <span class="preprocessor">#define SQLITE_FORMAT      24   </span><span class="comment">/* Auxiliary database format error */</span>
    460. 

  460. <a name="l00407"></a>00407 <span class="preprocessor">#define SQLITE_RANGE       25   </span><span class="comment">/* 2nd parameter to sqlite3_bind out of range */</span>
    461. 

  461. <a name="l00408"></a>00408 <span class="preprocessor">#define SQLITE_NOTADB      26   </span><span class="comment">/* File opened that is not a database file */</span>
    462. 

  462. <a name="l00409"></a>00409 <span class="preprocessor">#define SQLITE_ROW         100  </span><span class="comment">/* sqlite3_step() has another row ready */</span>
    463. 

  463. <a name="l00410"></a>00410 <span class="preprocessor">#define SQLITE_DONE        101  </span><span class="comment">/* sqlite3_step() has finished executing */</span>
    464. 

  464. <a name="l00411"></a>00411 <span class="comment">/* end-of-error-codes */</span>
    465. 

  465. <a name="l00412"></a>00412 
    466. 

  466. <a name="l00413"></a>00413 <span class="comment">/*</span>
    467. 

  467. <a name="l00414"></a>00414 <span class="comment">** CAPI3REF: Extended Result Codes</span>
    468. 

  468. <a name="l00415"></a>00415 <span class="comment">** KEYWORDS: {extended error code} {extended error codes}</span>
    469. 

  469. <a name="l00416"></a>00416 <span class="comment">** KEYWORDS: {extended result code} {extended result codes}</span>
    470. 

  470. <a name="l00417"></a>00417 <span class="comment">**</span>
    471. 

  471. <a name="l00418"></a>00418 <span class="comment">** In its default configuration, SQLite API routines return one of 26 integer</span>
    472. 

  472. <a name="l00419"></a>00419 <span class="comment">** [SQLITE_OK | result codes].  However, experience has shown that many of</span>
    473. 

  473. <a name="l00420"></a>00420 <span class="comment">** these result codes are too coarse-grained.  They do not provide as</span>
    474. 

  474. <a name="l00421"></a>00421 <span class="comment">** much information about problems as programmers might like.  In an effort to</span>
    475. 

  475. <a name="l00422"></a>00422 <span class="comment">** address this, newer versions of SQLite (version 3.3.8 and later) include</span>
    476. 

  476. <a name="l00423"></a>00423 <span class="comment">** support for additional result codes that provide more detailed information</span>
    477. 

  477. <a name="l00424"></a>00424 <span class="comment">** about errors. The extended result codes are enabled or disabled</span>
    478. 

  478. <a name="l00425"></a>00425 <span class="comment">** on a per database connection basis using the</span>
    479. 

  479. <a name="l00426"></a>00426 <span class="comment">** [sqlite3_extended_result_codes()] API.</span>
    480. 

  480. <a name="l00427"></a>00427 <span class="comment">**</span>
    481. 

  481. <a name="l00428"></a>00428 <span class="comment">** Some of the available extended result codes are listed here.</span>
    482. 

  482. <a name="l00429"></a>00429 <span class="comment">** One may expect the number of extended result codes will be expand</span>
    483. 

  483. <a name="l00430"></a>00430 <span class="comment">** over time.  Software that uses extended result codes should expect</span>
    484. 

  484. <a name="l00431"></a>00431 <span class="comment">** to see new result codes in future releases of SQLite.</span>
    485. 

  485. <a name="l00432"></a>00432 <span class="comment">**</span>
    486. 

  486. <a name="l00433"></a>00433 <span class="comment">** The SQLITE_OK result code will never be extended.  It will always</span>
    487. 

  487. <a name="l00434"></a>00434 <span class="comment">** be exactly zero.</span>
    488. 

  488. <a name="l00435"></a>00435 <span class="comment">*/</span>
    489. 

  489. <a name="l00436"></a>00436 <span class="preprocessor">#define SQLITE_IOERR_READ              (SQLITE_IOERR | (1&lt;&lt;8))</span>
    490. 

  490. <a name="l00437"></a>00437 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_IOERR_SHORT_READ        (SQLITE_IOERR | (2&lt;&lt;8))</span>
    491. 

  491. <a name="l00438"></a>00438 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_IOERR_WRITE             (SQLITE_IOERR | (3&lt;&lt;8))</span>
    492. 

  492. <a name="l00439"></a>00439 <span class="preprocessor"></span><span class="preprocessor">#define SQLITE_IOERR_FSYNC             (SQLITE_IOERR | (4&lt;&lt;8))</span>
    493. 

  493. <a name="l00440"></a>00440 <span class="prep…
    494.

Large files files are truncated, but you can click here to view the full file