FMStatement.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FMStatement Class Reference</title>
  6. <link rel="stylesheet" href="../css/style.css">
  7. <meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
  8. <meta name="generator" content="appledoc 2.2.1 (build 1334)">
  9. </head>
  10. <body class="appledoc">
  11. <header>
  12. <div class="container" class="hide-in-xcode">
  13. <h1 id="library-title">
  14. <a href="../index.html">FMDB </a>
  15. </h1>
  16. <p id="developer-home">
  17. <a href="../index.html">ccgus</a>
  18. </p>
  19. </div>
  20. </header>
  21. <aside>
  22. <div class="container">
  23. <nav>
  24. <ul id="header-buttons" role="toolbar">
  25. <li><a href="../index.html">Index</a></li>
  26. <li><a href="../hierarchy.html">Hierarchy</a></li>
  27. <li id="on-this-page" role="navigation">
  28. <label>
  29. On This Page
  30. <div class="chevron">
  31. <div class="chevy chevron-left"></div>
  32. <div class="chevy chevron-right"></div>
  33. </div>
  34. <select id="jump-to">
  35. <option value="top">Jump To&#133;</option>
  36. <option value="overview">Overview</option>
  37. <option value="tasks">Tasks</option>
  38. <optgroup label="Properties">
  39. <option value="//api/name/inUse">inUse</option>
  40. <option value="//api/name/query">query</option>
  41. <option value="//api/name/statement">statement</option>
  42. <option value="//api/name/useCount">useCount</option>
  43. </optgroup>
  44. <optgroup label="Instance Methods">
  45. <option value="//api/name/close">- close</option>
  46. <option value="//api/name/reset">- reset</option>
  47. </optgroup>
  48. </select>
  49. </label>
  50. </li>
  51. </ul>
  52. </nav>
  53. </div>
  54. </aside>
  55. <article>
  56. <div id="overview_contents" class="container">
  57. <div id="content">
  58. <main role="main">
  59. <h1 class="title">FMStatement Class Reference</h1>
  60. <div class="section section-specification"><table cellspacing="0"><tbody>
  61. <tr>
  62. <th>Inherits from</th>
  63. <td>NSObject</td>
  64. </tr><tr>
  65. <th>Declared in</th>
  66. <td>FMDatabase.h</td>
  67. </tr>
  68. </tbody></table></div>
  69. <div class="section section-overview">
  70. <a title="Overview" name="overview"></a>
  71. <h2 class="subtitle subtitle-overview">Overview</h2>
  72. <p>Objective-C wrapper for <code>sqlite3_stmt</code></p>
  73. <p>This is a wrapper for a SQLite <code>sqlite3_stmt</code>. Generally when using FMDB you will not need to interact directly with <code>FMStatement</code>, but rather with <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> and <a href="../Classes/FMResultSet.html"><code>FMResultSet</code></a> only.</p>
  74. <h3>See also</h3>
  75. <ul>
  76. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
  77. <li><a href="../Classes/FMResultSet.html"><code>FMResultSet</code></a></li>
  78. <li><a href="http://www.sqlite.org/c3ref/stmt.html"><code>sqlite3_stmt</code></a></li>
  79. </ul>
  80. </div>
  81. <div class="section section-tasks">
  82. <a title="Tasks" name="tasks"></a>
  83. <a title="Properties" name="task_Properties"></a>
  84. <h2 class="task-title">Properties</h2>
  85. <div class="task-list">
  86. <div class="section-method">
  87. <a name="//api/name/useCount" title="useCount"></a>
  88. <h3 class="method-title"><code><a href="#//api/name/useCount">&nbsp;&nbsp;useCount</a></code>
  89. </h3>
  90. <div class="method-info">
  91. <div class="pointy-thing"></div>
  92. <div class="method-info-container">
  93. <div class="method-subsection brief-description">
  94. <p>Usage count</p>
  95. </div>
  96. <div class="method-subsection method-declaration"><code>@property (atomic, assign) long useCount</code></div>
  97. <div class="method-subsection discussion-section">
  98. <h4 class="method-subtitle">Discussion</h4>
  99. <p>Usage count</p>
  100. </div>
  101. <div class="method-subsection declared-in-section">
  102. <h4 class="method-subtitle">Declared In</h4>
  103. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  104. </div>
  105. </div>
  106. </div>
  107. </div><div class="section-method">
  108. <a name="//api/name/query" title="query"></a>
  109. <h3 class="method-title"><code><a href="#//api/name/query">&nbsp;&nbsp;query</a></code>
  110. </h3>
  111. <div class="method-info">
  112. <div class="pointy-thing"></div>
  113. <div class="method-info-container">
  114. <div class="method-subsection brief-description">
  115. <p>SQL statement</p>
  116. </div>
  117. <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div>
  118. <div class="method-subsection discussion-section">
  119. <h4 class="method-subtitle">Discussion</h4>
  120. <p>SQL statement</p>
  121. </div>
  122. <div class="method-subsection declared-in-section">
  123. <h4 class="method-subtitle">Declared In</h4>
  124. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  125. </div>
  126. </div>
  127. </div>
  128. </div><div class="section-method">
  129. <a name="//api/name/statement" title="statement"></a>
  130. <h3 class="method-title"><code><a href="#//api/name/statement">&nbsp;&nbsp;statement</a></code>
  131. </h3>
  132. <div class="method-info">
  133. <div class="pointy-thing"></div>
  134. <div class="method-info-container">
  135. <div class="method-subsection brief-description">
  136. <p>SQLite sqlite3_stmt</p>
  137. </div>
  138. <div class="method-subsection method-declaration"><code>@property (atomic, assign) sqlite3_stmt *statement</code></div>
  139. <div class="method-subsection discussion-section">
  140. <h4 class="method-subtitle">Discussion</h4>
  141. <p>SQLite sqlite3_stmt</p>
  142. </div>
  143. <div class="method-subsection see-also-section">
  144. <h4 class="method-subtitle">See Also</h4>
  145. <ul>
  146. <li><code><p><a href="http://www.sqlite.org/c3ref/stmt.html"><code>sqlite3_stmt</code></a></p></code></li>
  147. </ul>
  148. </div>
  149. <div class="method-subsection declared-in-section">
  150. <h4 class="method-subtitle">Declared In</h4>
  151. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  152. </div>
  153. </div>
  154. </div>
  155. </div><div class="section-method">
  156. <a name="//api/name/inUse" title="inUse"></a>
  157. <h3 class="method-title"><code><a href="#//api/name/inUse">&nbsp;&nbsp;inUse</a></code>
  158. </h3>
  159. <div class="method-info">
  160. <div class="pointy-thing"></div>
  161. <div class="method-info-container">
  162. <div class="method-subsection brief-description">
  163. <p>Indication of whether the statement is in use</p>
  164. </div>
  165. <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL inUse</code></div>
  166. <div class="method-subsection discussion-section">
  167. <h4 class="method-subtitle">Discussion</h4>
  168. <p>Indication of whether the statement is in use</p>
  169. </div>
  170. <div class="method-subsection declared-in-section">
  171. <h4 class="method-subtitle">Declared In</h4>
  172. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  173. </div>
  174. </div>
  175. </div>
  176. </div>
  177. </div>
  178. <a title="Closing and Resetting" name="task_Closing and Resetting"></a>
  179. <h2 class="task-title">Closing and Resetting</h2>
  180. <div class="task-list">
  181. <div class="section-method">
  182. <a name="//api/name/close" title="close"></a>
  183. <h3 class="method-title"><code><a href="#//api/name/close">&ndash;&nbsp;close</a></code>
  184. </h3>
  185. <div class="method-info">
  186. <div class="pointy-thing"></div>
  187. <div class="method-info-container">
  188. <div class="method-subsection brief-description">
  189. <p>Close statement</p>
  190. </div>
  191. <div class="method-subsection method-declaration"><code>- (void)close</code></div>
  192. <div class="method-subsection discussion-section">
  193. <h4 class="method-subtitle">Discussion</h4>
  194. <p>Close statement</p>
  195. </div>
  196. <div class="method-subsection declared-in-section">
  197. <h4 class="method-subtitle">Declared In</h4>
  198. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  199. </div>
  200. </div>
  201. </div>
  202. </div><div class="section-method">
  203. <a name="//api/name/reset" title="reset"></a>
  204. <h3 class="method-title"><code><a href="#//api/name/reset">&ndash;&nbsp;reset</a></code>
  205. </h3>
  206. <div class="method-info">
  207. <div class="pointy-thing"></div>
  208. <div class="method-info-container">
  209. <div class="method-subsection brief-description">
  210. <p>Reset statement</p>
  211. </div>
  212. <div class="method-subsection method-declaration"><code>- (void)reset</code></div>
  213. <div class="method-subsection discussion-section">
  214. <h4 class="method-subtitle">Discussion</h4>
  215. <p>Reset statement</p>
  216. </div>
  217. <div class="method-subsection declared-in-section">
  218. <h4 class="method-subtitle">Declared In</h4>
  219. <p><code class="declared-in-ref">FMDatabase.h</code></p>
  220. </div>
  221. </div>
  222. </div>
  223. </div>
  224. </div>
  225. </div>
  226. </main>
  227. <footer>
  228. <div class="footer-copyright">
  229. <p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-11-10</p>
  230. <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
  231. </div>
  232. </footer>
  233. </div>
  234. </div>
  235. </article>
  236. <script src="../js/script.js"></script>
  237. </body>
  238. </html>