Kezdőlap Felfedezés Súgó
Bejelentkezés
mirror
/
fmdb
2
0
Másolás 0
Fájlok Problémák 0 Beolvasztási kérések 0 Wiki
Fa: a47ed5789b
Branch-ok Tag-ek
fmdb
/
html
/
Categories
/
FMDatabase+FMDatabaseAdditions.html

FMDatabase+FMDatabaseAdditions.html 38 KB
Előzmények Nyers

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455 
  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. 	<head>
    4. 

  4. 		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
    5. 

  5. 		<title>FMDatabase(FMDatabaseAdditions) Category Reference</title>
    6. 

  6. 		<meta id="xcode-display" name="xcode-display" content="render"/>
    7. 

  7. 		<meta name="viewport" content="width=550" />
    8. 

  8. 		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
    9. 

  9. 		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
    10. 

  10. 		<meta name="generator" content="appledoc 2.1 (build 858)" />
    11. 

  11. 	</head>
    12. 

  12. 	<body>
    13. 

  13. 		<header id="top_header">
    14. 

  14. 			<div id="library" class="hideInXcode">
    15. 

  15. 				<h1><a id="libraryTitle" href="../index.html">FMDB </a></h1>
    16. 

  16. 				<a id="developerHome" href="../index.html">ccgus</a>
    17. 

  17. 			</div>
    18. 

  18. 			
    19. 

  19. 			<div id="title" role="banner">
    20. 

  20. 				<h1 class="hideInXcode">FMDatabase(FMDatabaseAdditions) Category Reference</h1>
    21. 

  21. 			</div>
    22. 

  22. 			<ul id="headerButtons" role="toolbar">
    23. 

  23. 				<li id="toc_button">
    24. 

  24. 					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
    25. 

  25. 				</li>
    26. 

  26. 				<li id="jumpto_button" role="navigation">
    27. 

  27. 					<select id="jumpTo">
    28. 

  28. 	<option value="top">Jump To&#133;</option>
    29. 

  29. 	
    30. 

  30. 	<option value="overview">Overview</option>
    31. 

  31. 	
    32. 

  32. 	
    33. 

  33. 	
    34. 

  34. 	
    35. 

  35. 	<option value="tasks">Tasks</option>
    36. 

  36. 	
    37. 

  37. 	
    38. 

  38. 	
    39. 

  39. 	
    40. 

  40. 	
    41. 

  41. 	
    42. 

  42. 	
    43. 

  43. 	
    44. 

  44. 	
    45. 

  45. 	<option value="instance_methods">Instance Methods</option>
    46. 

  46. 	
    47. 

  47. 	<option value="//api/name/applicationID">&nbsp;&nbsp;&nbsp;&nbsp;- applicationID</option>
    48. 

  48. 	
    49. 

  49. 	<option value="//api/name/applicationIDString">&nbsp;&nbsp;&nbsp;&nbsp;- applicationIDString</option>
    50. 

  50. 	
    51. 

  51. 	<option value="//api/name/boolForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- boolForQuery:</option>
    52. 

  52. 	
    53. 

  53. 	<option value="//api/name/columnExists:columnName:">&nbsp;&nbsp;&nbsp;&nbsp;- columnExists:columnName:</option>
    54. 

  54. 	
    55. 

  55. 	<option value="//api/name/columnExists:inTableWithName:">&nbsp;&nbsp;&nbsp;&nbsp;- columnExists:inTableWithName:</option>
    56. 

  56. 	
    57. 

  57. 	<option value="//api/name/dataForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- dataForQuery:</option>
    58. 

  58. 	
    59. 

  59. 	<option value="//api/name/dateForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- dateForQuery:</option>
    60. 

  60. 	
    61. 

  61. 	<option value="//api/name/doubleForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- doubleForQuery:</option>
    62. 

  62. 	
    63. 

  63. 	<option value="//api/name/getSchema">&nbsp;&nbsp;&nbsp;&nbsp;- getSchema</option>
    64. 

  64. 	
    65. 

  65. 	<option value="//api/name/getTableSchema:">&nbsp;&nbsp;&nbsp;&nbsp;- getTableSchema:</option>
    66. 

  66. 	
    67. 

  67. 	<option value="//api/name/intForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- intForQuery:</option>
    68. 

  68. 	
    69. 

  69. 	<option value="//api/name/longForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- longForQuery:</option>
    70. 

  70. 	
    71. 

  71. 	<option value="//api/name/setApplicationID:">&nbsp;&nbsp;&nbsp;&nbsp;- setApplicationID:</option>
    72. 

  72. 	
    73. 

  73. 	<option value="//api/name/setApplicationIDString:">&nbsp;&nbsp;&nbsp;&nbsp;- setApplicationIDString:</option>
    74. 

  74. 	
    75. 

  75. 	<option value="//api/name/stringForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- stringForQuery:</option>
    76. 

  76. 	
    77. 

  77. 	<option value="//api/name/tableExists:">&nbsp;&nbsp;&nbsp;&nbsp;- tableExists:</option>
    78. 

  78. 	
    79. 

  79. 	<option value="//api/name/validateSQL:error:">&nbsp;&nbsp;&nbsp;&nbsp;- validateSQL:error:</option>
    80. 

  80. 	
    81. 

  81. 	
    82. 

  82. 	
    83. 

  83. </select>
    84. 

  84. 				</li>
    85. 

  85. 			</ul>
    86. 

  86. 		</header>
    87. 

  87. 		<nav id="tocContainer" class="isShowingTOC">
    88. 

  88. 			<ul id="toc" role="tree">
    89. 

  89. 				
    90. 

  90. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
    91. 

  91. 

  92. 

  93. 

  94. 

  95. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
    96. 

  96. 	
    97. 

  97. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Return results of SQL to variable">Return results of SQL to variable</a></span></li>
    98. 

  98. 	
    99. 

  99. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Schema related operations">Schema related operations</a></span></li>
    100. 

  100. 	
    101. 

  101. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Application identifier tasks">Application identifier tasks</a></span></li>
    102. 

  102. 	
    103. 

  103. </ul></li>
    104. 

  104. 

  105. 

  106. 

  107. 

  108. 

  109. 

  110. 

  111. 

  112. 

  113. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
    114. 

  114. 	
    115. 

  115. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationID">applicationID</a></span></li>
    116. 

  116. 	
    117. 

  117. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationIDString">applicationIDString</a></span></li>
    118. 

  118. 	
    119. 

  119. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForQuery:">boolForQuery:</a></span></li>
    120. 

  120. 	
    121. 

  121. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:columnName:">columnExists:columnName:</a></span></li>
    122. 

  122. 	
    123. 

  123. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:inTableWithName:">columnExists:inTableWithName:</a></span></li>
    124. 

  124. 	
    125. 

  125. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForQuery:">dataForQuery:</a></span></li>
    126. 

  126. 	
    127. 

  127. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForQuery:">dateForQuery:</a></span></li>
    128. 

  128. 	
    129. 

  129. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForQuery:">doubleForQuery:</a></span></li>
    130. 

  130. 	
    131. 

  131. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSchema">getSchema</a></span></li>
    132. 

  132. 	
    133. 

  133. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getTableSchema:">getTableSchema:</a></span></li>
    134. 

  134. 	
    135. 

  135. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForQuery:">intForQuery:</a></span></li>
    136. 

  136. 	
    137. 

  137. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForQuery:">longForQuery:</a></span></li>
    138. 

  138. 	
    139. 

  139. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationID:">setApplicationID:</a></span></li>
    140. 

  140. 	
    141. 

  141. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationIDString:">setApplicationIDString:</a></span></li>
    142. 

  142. 	
    143. 

  143. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForQuery:">stringForQuery:</a></span></li>
    144. 

  144. 	
    145. 

  145. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/tableExists:">tableExists:</a></span></li>
    146. 

  146. 	
    147. 

  147. 	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/validateSQL:error:">validateSQL:error:</a></span></li>
    148. 

  148. 	
    149. 

  149. </ul></li>
    150. 

  150. 

  151. 

  152. 			</ul>
    153. 

  153. 		</nav>
    154. 

  154. 		<article>
    155. 

  155. 			<div id="contents" class="isShowingTOC" role="main">
    156. 

  156. 				<a title="FMDatabase(FMDatabaseAdditions) Category Reference" name="top"></a>
    157. 

  157. 				<div class="main-navigation navigation-top">
    158. 

  158. 					<ul>
    159. 

  159. 	<li><a href="../index.html">Index</a></li>
    160. 

  160. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    161. 

  161. </ul>
    162. 

  162. 				</div>
    163. 

  163. 				<div id="header">
    164. 

  164. 					<div class="section-header">
    165. 

  165. 						<h1 class="title title-header">FMDatabase(FMDatabaseAdditions) Category Reference</h1>
    166. 

  166. 					</div>		
    167. 

  167. 				</div>
    168. 

  168. 				<div id="container">	
    169. 

  169. 					
    170. 

  170. 					<div class="section section-specification"><table cellspacing="0"><tbody>
    171. 

  171. 						<tr>
    172. 

  172. 	<td class="specification-title">Declared in</td>
    173. 

  173. 	<td class="specification-value">FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td>
    174. 

  174. </tr>
    175. 

  175. 						</tbody></table></div>
    176. 

  176. 					
    177. 

  177. 					
    178. 

  178. 					
    179. 

  179. 					
    180. 

  180. 					<div class="section section-overview">
    181. 

  181. 						<a title="Overview" name="overview"></a>
    182. 

  182. 						<h2 class="subtitle subtitle-overview">Overview</h2>
    183. 

  183. 						<p>Category of additions for <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> class.</p>
    184. 

  184. 

  185. <h3>See also</h3>
    186. 

  186. 

  187. <ul>
    188. 

  188. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
    189. 

  189. </ul>
    190. 

  190. 

  191. 					</div>
    192. 

  192. 					
    193. 

  193. 					
    194. 

  194. 					
    195. 

  195. 					
    196. 

  196. 					
    197. 

  197. 					<div class="section section-tasks">
    198. 

  198. 						<a title="Tasks" name="tasks"></a>
    199. 

  199. 						<h2 class="subtitle subtitle-tasks">Tasks</h2>
    200. 

  200. 						
    201. 

  201. 						
    202. 

  202. 						<a title="Return results of SQL to variable" name="task_Return results of SQL to variable"></a>
    203. 

  203. 						<h3 class="subsubtitle task-title">Return results of SQL to variable</h3>
    204. 

  204. 

  205. 						<ul class="task-list">
    206. 

  206. 							<li>
    207. 

  207. 	<span class="tooltip">
    208. 

  208. 		<code><a href="#//api/name/intForQuery:">&ndash;&nbsp;intForQuery:</a></code>
    209. 

  209. 		<span class="tooltip"><p>Return <code>int</code> value for query</p></span>
    210. 

  210. 	</span>
    211. 

  211. 	
    212. 

  212. 	
    213. 

  213. </li><li>
    214. 

  214. 	<span class="tooltip">
    215. 

  215. 		<code><a href="#//api/name/longForQuery:">&ndash;&nbsp;longForQuery:</a></code>
    216. 

  216. 		<span class="tooltip"><p>Return <code>long</code> value for query</p></span>
    217. 

  217. 	</span>
    218. 

  218. 	
    219. 

  219. 	
    220. 

  220. </li><li>
    221. 

  221. 	<span class="tooltip">
    222. 

  222. 		<code><a href="#//api/name/boolForQuery:">&ndash;&nbsp;boolForQuery:</a></code>
    223. 

  223. 		<span class="tooltip"><p>Return <code>BOOL</code> value for query</p></span>
    224. 

  224. 	</span>
    225. 

  225. 	
    226. 

  226. 	
    227. 

  227. </li><li>
    228. 

  228. 	<span class="tooltip">
    229. 

  229. 		<code><a href="#//api/name/doubleForQuery:">&ndash;&nbsp;doubleForQuery:</a></code>
    230. 

  230. 		<span class="tooltip"><p>Return <code>double</code> value for query</p></span>
    231. 

  231. 	</span>
    232. 

  232. 	
    233. 

  233. 	
    234. 

  234. </li><li>
    235. 

  235. 	<span class="tooltip">
    236. 

  236. 		<code><a href="#//api/name/stringForQuery:">&ndash;&nbsp;stringForQuery:</a></code>
    237. 

  237. 		<span class="tooltip"><p>Return <code>NSString</code> value for query</p></span>
    238. 

  238. 	</span>
    239. 

  239. 	
    240. 

  240. 	
    241. 

  241. </li><li>
    242. 

  242. 	<span class="tooltip">
    243. 

  243. 		<code><a href="#//api/name/dataForQuery:">&ndash;&nbsp;dataForQuery:</a></code>
    244. 

  244. 		<span class="tooltip"><p>Return <code>NSData</code> value for query</p></span>
    245. 

  245. 	</span>
    246. 

  246. 	
    247. 

  247. 	
    248. 

  248. </li><li>
    249. 

  249. 	<span class="tooltip">
    250. 

  250. 		<code><a href="#//api/name/dateForQuery:">&ndash;&nbsp;dateForQuery:</a></code>
    251. 

  251. 		<span class="tooltip"><p>Return <code>NSDate</code> value for query</p></span>
    252. 

  252. 	</span>
    253. 

  253. 	
    254. 

  254. 	
    255. 

  255. </li>
    256. 

  256. 						</ul>
    257. 

  257. 						
    258. 

  258. 						
    259. 

  259. 						<a title="Schema related operations" name="task_Schema related operations"></a>
    260. 

  260. 						<h3 class="subsubtitle task-title">Schema related operations</h3>
    261. 

  261. 

  262. 						<ul class="task-list">
    263. 

  263. 							<li>
    264. 

  264. 	<span class="tooltip">
    265. 

  265. 		<code><a href="#//api/name/tableExists:">&ndash;&nbsp;tableExists:</a></code>
    266. 

  266. 		<span class="tooltip"><p>Does table exist in database?</p></span>
    267. 

  267. 	</span>
    268. 

  268. 	
    269. 

  269. 	
    270. 

  270. </li><li>
    271. 

  271. 	<span class="tooltip">
    272. 

  272. 		<code><a href="#//api/name/getSchema">&ndash;&nbsp;getSchema</a></code>
    273. 

  273. 		<span class="tooltip"><p>The schema of the database.</p></span>
    274. 

  274. 	</span>
    275. 

  275. 	
    276. 

  276. 	
    277. 

  277. </li><li>
    278. 

  278. 	<span class="tooltip">
    279. 

  279. 		<code><a href="#//api/name/getTableSchema:">&ndash;&nbsp;getTableSchema:</a></code>
    280. 

  280. 		<span class="tooltip"><p>The schema of the database.</p></span>
    281. 

  281. 	</span>
    282. 

  282. 	
    283. 

  283. 	
    284. 

  284. </li><li>
    285. 

  285. 	<span class="tooltip">
    286. 

  286. 		<code><a href="#//api/name/columnExists:inTableWithName:">&ndash;&nbsp;columnExists:inTableWithName:</a></code>
    287. 

  287. 		<span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span>
    288. 

  288. 	</span>
    289. 

  289. 	
    290. 

  290. 	
    291. 

  291. </li><li>
    292. 

  292. 	<span class="tooltip">
    293. 

  293. 		<code><a href="#//api/name/columnExists:columnName:">&ndash;&nbsp;columnExists:columnName:</a></code>
    294. 

  294. 		<span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span>
    295. 

  295. 	</span>
    296. 

  296. 	
    297. 

  297. 	
    298. 

  298. </li><li>
    299. 

  299. 	<span class="tooltip">
    300. 

  300. 		<code><a href="#//api/name/validateSQL:error:">&ndash;&nbsp;validateSQL:error:</a></code>
    301. 

  301. 		<span class="tooltip"><p>Validate SQL statement</p></span>
    302. 

  302. 	</span>
    303. 

  303. 	
    304. 

  304. 	
    305. 

  305. </li>
    306. 

  306. 						</ul>
    307. 

  307. 						
    308. 

  308. 						
    309. 

  309. 						<a title="Application identifier tasks" name="task_Application identifier tasks"></a>
    310. 

  310. 						<h3 class="subsubtitle task-title">Application identifier tasks</h3>
    311. 

  311. 

  312. 						<ul class="task-list">
    313. 

  313. 							<li>
    314. 

  314. 	<span class="tooltip">
    315. 

  315. 		<code><a href="#//api/name/applicationID">&ndash;&nbsp;applicationID</a></code>
    316. 

  316. 		<span class="tooltip"><p>Retrieve application ID</p></span>
    317. 

  317. 	</span>
    318. 

  318. 	
    319. 

  319. 	
    320. 

  320. </li><li>
    321. 

  321. 	<span class="tooltip">
    322. 

  322. 		<code><a href="#//api/name/setApplicationID:">&ndash;&nbsp;setApplicationID:</a></code>
    323. 

  323. 		<span class="tooltip"><p>Set the application ID</p></span>
    324. 

  324. 	</span>
    325. 

  325. 	
    326. 

  326. 	
    327. 

  327. </li><li>
    328. 

  328. 	<span class="tooltip">
    329. 

  329. 		<code><a href="#//api/name/applicationIDString">&ndash;&nbsp;applicationIDString</a></code>
    330. 

  330. 		<span class="tooltip"><p>Retrieve application ID string</p></span>
    331. 

  331. 	</span>
    332. 

  332. 	
    333. 

  333. 	
    334. 

  334. </li><li>
    335. 

  335. 	<span class="tooltip">
    336. 

  336. 		<code><a href="#//api/name/setApplicationIDString:">&ndash;&nbsp;setApplicationIDString:</a></code>
    337. 

  337. 		<span class="tooltip"><p>Set the application ID string</p></span>
    338. 

  338. 	</span>
    339. 

  339. 	
    340. 

  340. 	
    341. 

  341. </li>
    342. 

  342. 						</ul>
    343. 

  343. 						
    344. 

  344. 					</div>
    345. 

  345. 					
    346. 

  346. 					
    347. 

  347. 					
    348. 

  348. 					
    349. 

  349. 					
    350. 

  350. 					
    351. 

  351. 					
    352. 

  352. 					
    353. 

  353. 					
    354. 

  354. 					<div class="section section-methods">
    355. 

  355. 						<a title="Instance Methods" name="instance_methods"></a>
    356. 

  356. 						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
    357. 

  357. 						
    358. 

  358. 						<div class="section-method">
    359. 

  359. 	<a name="//api/name/applicationID" title="applicationID"></a>
    360. 

  360. 	<h3 class="subsubtitle method-title">applicationID</h3>
    361. 

  361. 	
    362. 

  362. 	
    363. 

  363. 	
    364. 

  364. 	<div class="method-subsection brief-description">
    365. 

  365. 		<p>Retrieve application ID</p>
    366. 

  366. 	</div>		
    367. 

  367. 	
    368. 

  368.     
    369. 

  369. 

  370. 	<div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div>
    371. 

  371. 

  372.     
    373. 

  373. 	
    374. 

  374. 	
    375. 

  375. 	
    376. 

  376. 	<div class="method-subsection return">
    377. 

  377. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    378. 

  378. 		<p>The <code>uint32_t</code> numeric value of the application ID.</p>
    379. 

  379. 	</div>
    380. 

  380. 	
    381. 

  381. 	
    382. 

  382. 	
    383. 

  383. 	
    384. 

  384. 	
    385. 

  385. 	
    386. 

  386. 	
    387. 

  387. 	
    388. 

  388. 	
    389. 

  389. 	<div class="method-subsection see-also-section">
    390. 

  390. 		<h4 class="method-subtitle">See Also</h4>
    391. 

  391. 		<ul>
    392. 

  392. 			
    393. 

  393. 			<li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li>
    394. 

  394. 			
    395. 

  395. 		</ul>
    396. 

  396. 	</div>
    397. 

  397. 	
    398. 

  398. 	
    399. 

  399. 	
    400. 

  400. 	<div class="method-subsection declared-in-section">
    401. 

  401. 		<h4 class="method-subtitle">Declared In</h4>
    402. 

  402. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    403. 

  403. 	</div>				
    404. 

  404. 	
    405. 

  405. 	
    406. 

  406. </div>
    407. 

  407. 						
    408. 

  408. 						<div class="section-method">
    409. 

  409. 	<a name="//api/name/applicationIDString" title="applicationIDString"></a>
    410. 

  410. 	<h3 class="subsubtitle method-title">applicationIDString</h3>
    411. 

  411. 	
    412. 

  412. 	
    413. 

  413. 	
    414. 

  414. 	<div class="method-subsection brief-description">
    415. 

  415. 		<p>Retrieve application ID string</p>
    416. 

  416. 	</div>		
    417. 

  417. 	
    418. 

  418.     
    419. 

  419. 

  420. 	<div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div>
    421. 

  421. 

  422.     
    423. 

  423. 	
    424. 

  424. 	
    425. 

  425. 	
    426. 

  426. 	<div class="method-subsection return">
    427. 

  427. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    428. 

  428. 		<p>The <code>NSString</code> value of the application ID.</p>
    429. 

  429. 	</div>
    430. 

  430. 	
    431. 

  431. 	
    432. 

  432. 	
    433. 

  433. 	
    434. 

  434. 	
    435. 

  435. 	
    436. 

  436. 	
    437. 

  437. 	
    438. 

  438. 	
    439. 

  439. 	<div class="method-subsection see-also-section">
    440. 

  440. 		<h4 class="method-subtitle">See Also</h4>
    441. 

  441. 		<ul>
    442. 

  442. 			
    443. 

  443. 			<li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li>
    444. 

  444. 			
    445. 

  445. 		</ul>
    446. 

  446. 	</div>
    447. 

  447. 	
    448. 

  448. 	
    449. 

  449. 	
    450. 

  450. 	<div class="method-subsection declared-in-section">
    451. 

  451. 		<h4 class="method-subtitle">Declared In</h4>
    452. 

  452. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    453. 

  453. 	</div>				
    454. 

  454. 	
    455. 

  455. 	
    456. 

  456. </div>
    457. 

  457. 						
    458. 

  458. 						<div class="section-method">
    459. 

  459. 	<a name="//api/name/boolForQuery:" title="boolForQuery:"></a>
    460. 

  460. 	<h3 class="subsubtitle method-title">boolForQuery:</h3>
    461. 

  461. 	
    462. 

  462. 	
    463. 

  463. 	
    464. 

  464. 	<div class="method-subsection brief-description">
    465. 

  465. 		<p>Return <code>BOOL</code> value for query</p>
    466. 

  466. 	</div>		
    467. 

  467. 	
    468. 

  468.     
    469. 

  469. 

  470. 	<div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    471. 

  471. 

  472.     
    473. 

  473. 	
    474. 

  474. 	<div class="method-subsection arguments-section parameters">
    475. 

  475. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    476. 

  476. 		
    477. 

  477. 		<dl class="argument-def parameter-def">
    478. 

  478. 			<dt><em>query</em></dt>
    479. 

  479. 			<dd><p>The SQL query to be performed.</p></dd>
    480. 

  480. 		</dl>
    481. 

  481. 		
    482. 

  482. 		<dl class="argument-def parameter-def">
    483. 

  483. 			<dt><em>...</em></dt>
    484. 

  484. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    485. 

  485. 		</dl>
    486. 

  486. 		
    487. 

  487. 	</div>
    488. 

  488. 	
    489. 

  489. 	
    490. 

  490. 	
    491. 

  491. 	<div class="method-subsection return">
    492. 

  492. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    493. 

  493. 		<p><code>BOOL</code> value.</p>
    494. 

  494. 	</div>
    495. 

  495. 	
    496. 

  496. 	
    497. 

  497. 	
    498. 

  498. 	
    499. 

  499. 	
    500. 

  500. 	
    501. 

  501. 	
    502. 

  502. 	
    503. 

  503. 	
    504. 

  504. 	
    505. 

  505. 	
    506. 

  506. 	<div class="method-subsection declared-in-section">
    507. 

  507. 		<h4 class="method-subtitle">Declared In</h4>
    508. 

  508. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    509. 

  509. 	</div>				
    510. 

  510. 	
    511. 

  511. 	
    512. 

  512. </div>
    513. 

  513. 						
    514. 

  514. 						<div class="section-method">
    515. 

  515. 	<a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a>
    516. 

  516. 	<h3 class="subsubtitle method-title">columnExists:columnName:</h3>
    517. 

  517. 	
    518. 

  518. 	
    519. 

  519. 	
    520. 

  520. 	<div class="method-subsection brief-description">
    521. 

  521. 		<p>Test to see if particular column exists for particular table in database</p>
    522. 

  522. 	</div>		
    523. 

  523. 	
    524. 

  524.     
    525. 

  525. 

  526. 	<div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>tableName</em> columnName:(NSString *)<em>columnName</em></code></div>
    527. 

  527. 

  528.     
    529. 

  529. 	
    530. 

  530. 	<div class="method-subsection arguments-section parameters">
    531. 

  531. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    532. 

  532. 		
    533. 

  533. 		<dl class="argument-def parameter-def">
    534. 

  534. 			<dt><em>tableName</em></dt>
    535. 

  535. 			<dd><p>The name of the table.</p></dd>
    536. 

  536. 		</dl>
    537. 

  537. 		
    538. 

  538. 		<dl class="argument-def parameter-def">
    539. 

  539. 			<dt><em>columnName</em></dt>
    540. 

  540. 			<dd><p>The name of the column.</p></dd>
    541. 

  541. 		</dl>
    542. 

  542. 		
    543. 

  543. 	</div>
    544. 

  544. 	
    545. 

  545. 	
    546. 

  546. 	
    547. 

  547. 	<div class="method-subsection return">
    548. 

  548. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    549. 

  549. 		<p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
    550. 

  550. 	</div>
    551. 

  551. 	
    552. 

  552. 	
    553. 

  553. 	
    554. 

  554. 	
    555. 

  555. 	
    556. 

  556. 	<div class="method-subsection discussion-section">
    557. 

  557. 		<h4 class="method-subtitle">Discussion</h4>
    558. 

  558. 		<div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</p></div>
    559. 

  559. 	</div>
    560. 

  560. 	
    561. 

  561. 	
    562. 

  562. 	
    563. 

  563. 	
    564. 

  564. 	
    565. 

  565. 	<div class="method-subsection see-also-section">
    566. 

  566. 		<h4 class="method-subtitle">See Also</h4>
    567. 

  567. 		<ul>
    568. 

  568. 			
    569. 

  569. 			<li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li>
    570. 

  570. 			
    571. 

  571. 		</ul>
    572. 

  572. 	</div>
    573. 

  573. 	
    574. 

  574. 	
    575. 

  575. 	
    576. 

  576. 	<div class="method-subsection declared-in-section">
    577. 

  577. 		<h4 class="method-subtitle">Declared In</h4>
    578. 

  578. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    579. 

  579. 	</div>				
    580. 

  580. 	
    581. 

  581. 	
    582. 

  582. </div>
    583. 

  583. 						
    584. 

  584. 						<div class="section-method">
    585. 

  585. 	<a name="//api/name/columnExists:inTableWithName:" title="columnExists:inTableWithName:"></a>
    586. 

  586. 	<h3 class="subsubtitle method-title">columnExists:inTableWithName:</h3>
    587. 

  587. 	
    588. 

  588. 	
    589. 

  589. 	
    590. 

  590. 	<div class="method-subsection brief-description">
    591. 

  591. 		<p>Test to see if particular column exists for particular table in database</p>
    592. 

  592. 	</div>		
    593. 

  593. 	
    594. 

  594.     
    595. 

  595. 

  596. 	<div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>columnName</em> inTableWithName:(NSString *)<em>tableName</em></code></div>
    597. 

  597. 

  598.     
    599. 

  599. 	
    600. 

  600. 	<div class="method-subsection arguments-section parameters">
    601. 

  601. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    602. 

  602. 		
    603. 

  603. 		<dl class="argument-def parameter-def">
    604. 

  604. 			<dt><em>columnName</em></dt>
    605. 

  605. 			<dd><p>The name of the column.</p></dd>
    606. 

  606. 		</dl>
    607. 

  607. 		
    608. 

  608. 		<dl class="argument-def parameter-def">
    609. 

  609. 			<dt><em>tableName</em></dt>
    610. 

  610. 			<dd><p>The name of the table.</p></dd>
    611. 

  611. 		</dl>
    612. 

  612. 		
    613. 

  613. 	</div>
    614. 

  614. 	
    615. 

  615. 	
    616. 

  616. 	
    617. 

  617. 	<div class="method-subsection return">
    618. 

  618. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    619. 

  619. 		<p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
    620. 

  620. 	</div>
    621. 

  621. 	
    622. 

  622. 	
    623. 

  623. 	
    624. 

  624. 	
    625. 

  625. 	
    626. 

  626. 	
    627. 

  627. 	
    628. 

  628. 	
    629. 

  629. 	
    630. 

  630. 	
    631. 

  631. 	
    632. 

  632. 	<div class="method-subsection declared-in-section">
    633. 

  633. 		<h4 class="method-subtitle">Declared In</h4>
    634. 

  634. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    635. 

  635. 	</div>				
    636. 

  636. 	
    637. 

  637. 	
    638. 

  638. </div>
    639. 

  639. 						
    640. 

  640. 						<div class="section-method">
    641. 

  641. 	<a name="//api/name/dataForQuery:" title="dataForQuery:"></a>
    642. 

  642. 	<h3 class="subsubtitle method-title">dataForQuery:</h3>
    643. 

  643. 	
    644. 

  644. 	
    645. 

  645. 	
    646. 

  646. 	<div class="method-subsection brief-description">
    647. 

  647. 		<p>Return <code>NSData</code> value for query</p>
    648. 

  648. 	</div>		
    649. 

  649. 	
    650. 

  650.     
    651. 

  651. 

  652. 	<div class="method-subsection method-declaration"><code>- (NSData *)dataForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    653. 

  653. 

  654.     
    655. 

  655. 	
    656. 

  656. 	<div class="method-subsection arguments-section parameters">
    657. 

  657. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    658. 

  658. 		
    659. 

  659. 		<dl class="argument-def parameter-def">
    660. 

  660. 			<dt><em>query</em></dt>
    661. 

  661. 			<dd><p>The SQL query to be performed.</p></dd>
    662. 

  662. 		</dl>
    663. 

  663. 		
    664. 

  664. 		<dl class="argument-def parameter-def">
    665. 

  665. 			<dt><em>...</em></dt>
    666. 

  666. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    667. 

  667. 		</dl>
    668. 

  668. 		
    669. 

  669. 	</div>
    670. 

  670. 	
    671. 

  671. 	
    672. 

  672. 	
    673. 

  673. 	<div class="method-subsection return">
    674. 

  674. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    675. 

  675. 		<p><code>NSData</code> value.</p>
    676. 

  676. 	</div>
    677. 

  677. 	
    678. 

  678. 	
    679. 

  679. 	
    680. 

  680. 	
    681. 

  681. 	
    682. 

  682. 	
    683. 

  683. 	
    684. 

  684. 	
    685. 

  685. 	
    686. 

  686. 	
    687. 

  687. 	
    688. 

  688. 	<div class="method-subsection declared-in-section">
    689. 

  689. 		<h4 class="method-subtitle">Declared In</h4>
    690. 

  690. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    691. 

  691. 	</div>				
    692. 

  692. 	
    693. 

  693. 	
    694. 

  694. </div>
    695. 

  695. 						
    696. 

  696. 						<div class="section-method">
    697. 

  697. 	<a name="//api/name/dateForQuery:" title="dateForQuery:"></a>
    698. 

  698. 	<h3 class="subsubtitle method-title">dateForQuery:</h3>
    699. 

  699. 	
    700. 

  700. 	
    701. 

  701. 	
    702. 

  702. 	<div class="method-subsection brief-description">
    703. 

  703. 		<p>Return <code>NSDate</code> value for query</p>
    704. 

  704. 	</div>		
    705. 

  705. 	
    706. 

  706.     
    707. 

  707. 

  708. 	<div class="method-subsection method-declaration"><code>- (NSDate *)dateForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    709. 

  709. 

  710.     
    711. 

  711. 	
    712. 

  712. 	<div class="method-subsection arguments-section parameters">
    713. 

  713. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    714. 

  714. 		
    715. 

  715. 		<dl class="argument-def parameter-def">
    716. 

  716. 			<dt><em>query</em></dt>
    717. 

  717. 			<dd><p>The SQL query to be performed.</p></dd>
    718. 

  718. 		</dl>
    719. 

  719. 		
    720. 

  720. 		<dl class="argument-def parameter-def">
    721. 

  721. 			<dt><em>...</em></dt>
    722. 

  722. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    723. 

  723. 		</dl>
    724. 

  724. 		
    725. 

  725. 	</div>
    726. 

  726. 	
    727. 

  727. 	
    728. 

  728. 	
    729. 

  729. 	<div class="method-subsection return">
    730. 

  730. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    731. 

  731. 		<p><code>NSDate</code> value.</p>
    732. 

  732. 	</div>
    733. 

  733. 	
    734. 

  734. 	
    735. 

  735. 	
    736. 

  736. 	
    737. 

  737. 	
    738. 

  738. 	
    739. 

  739. 	
    740. 

  740. 	
    741. 

  741. 	
    742. 

  742. 	
    743. 

  743. 	
    744. 

  744. 	<div class="method-subsection declared-in-section">
    745. 

  745. 		<h4 class="method-subtitle">Declared In</h4>
    746. 

  746. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    747. 

  747. 	</div>				
    748. 

  748. 	
    749. 

  749. 	
    750. 

  750. </div>
    751. 

  751. 						
    752. 

  752. 						<div class="section-method">
    753. 

  753. 	<a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a>
    754. 

  754. 	<h3 class="subsubtitle method-title">doubleForQuery:</h3>
    755. 

  755. 	
    756. 

  756. 	
    757. 

  757. 	
    758. 

  758. 	<div class="method-subsection brief-description">
    759. 

  759. 		<p>Return <code>double</code> value for query</p>
    760. 

  760. 	</div>		
    761. 

  761. 	
    762. 

  762.     
    763. 

  763. 

  764. 	<div class="method-subsection method-declaration"><code>- (double)doubleForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    765. 

  765. 

  766.     
    767. 

  767. 	
    768. 

  768. 	<div class="method-subsection arguments-section parameters">
    769. 

  769. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    770. 

  770. 		
    771. 

  771. 		<dl class="argument-def parameter-def">
    772. 

  772. 			<dt><em>query</em></dt>
    773. 

  773. 			<dd><p>The SQL query to be performed.</p></dd>
    774. 

  774. 		</dl>
    775. 

  775. 		
    776. 

  776. 		<dl class="argument-def parameter-def">
    777. 

  777. 			<dt><em>...</em></dt>
    778. 

  778. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    779. 

  779. 		</dl>
    780. 

  780. 		
    781. 

  781. 	</div>
    782. 

  782. 	
    783. 

  783. 	
    784. 

  784. 	
    785. 

  785. 	<div class="method-subsection return">
    786. 

  786. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    787. 

  787. 		<p><code>double</code> value.</p>
    788. 

  788. 	</div>
    789. 

  789. 	
    790. 

  790. 	
    791. 

  791. 	
    792. 

  792. 	
    793. 

  793. 	
    794. 

  794. 	
    795. 

  795. 	
    796. 

  796. 	
    797. 

  797. 	
    798. 

  798. 	
    799. 

  799. 	
    800. 

  800. 	<div class="method-subsection declared-in-section">
    801. 

  801. 		<h4 class="method-subtitle">Declared In</h4>
    802. 

  802. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    803. 

  803. 	</div>				
    804. 

  804. 	
    805. 

  805. 	
    806. 

  806. </div>
    807. 

  807. 						
    808. 

  808. 						<div class="section-method">
    809. 

  809. 	<a name="//api/name/getSchema" title="getSchema"></a>
    810. 

  810. 	<h3 class="subsubtitle method-title">getSchema</h3>
    811. 

  811. 	
    812. 

  812. 	
    813. 

  813. 	
    814. 

  814. 	<div class="method-subsection brief-description">
    815. 

  815. 		<p>The schema of the database.</p>
    816. 

  816. 	</div>		
    817. 

  817. 	
    818. 

  818.     
    819. 

  819. 

  820. 	<div class="method-subsection method-declaration"><code>- (FMResultSet *)getSchema</code></div>
    821. 

  821. 

  822.     
    823. 

  823. 	
    824. 

  824. 	
    825. 

  825. 	
    826. 

  826. 	<div class="method-subsection return">
    827. 

  827. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    828. 

  828. 		<p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
    829. 

  829. 	</div>
    830. 

  830. 	
    831. 

  831. 	
    832. 

  832. 	
    833. 

  833. 	
    834. 

  834. 	
    835. 

  835. 	<div class="method-subsection discussion-section">
    836. 

  836. 		<h4 class="method-subtitle">Discussion</h4>
    837. 

  837. 		<p>This will be the schema for the entire database. For each entity, each row of the result set will include the following fields:</p>
    838. 

  838. 

  839. <ul>
    840. 

  840. <li><code>type</code> - The type of entity (e.g. table, index, view, or trigger)</li>
    841. 

  841. <li><code>name</code> - The name of the object</li>
    842. 

  842. <li><code>tbl_name</code> - The name of the table to which the object references</li>
    843. 

  843. <li><code>rootpage</code> - The page number of the root b-tree page for tables and indices</li>
    844. 

  844. <li><code>sql</code> - The SQL that created the entity</li>
    845. 

  845. </ul>
    846. 

  846. 

  847. 	</div>
    848. 

  848. 	
    849. 

  849. 	
    850. 

  850. 	
    851. 

  851. 	
    852. 

  852. 	
    853. 

  853. 	<div class="method-subsection see-also-section">
    854. 

  854. 		<h4 class="method-subtitle">See Also</h4>
    855. 

  855. 		<ul>
    856. 

  856. 			
    857. 

  857. 			<li><code><p><a href="http://www.sqlite.org/fileformat.html">SQLite File Format</a></p></code></li>
    858. 

  858. 			
    859. 

  859. 		</ul>
    860. 

  860. 	</div>
    861. 

  861. 	
    862. 

  862. 	
    863. 

  863. 	
    864. 

  864. 	<div class="method-subsection declared-in-section">
    865. 

  865. 		<h4 class="method-subtitle">Declared In</h4>
    866. 

  866. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    867. 

  867. 	</div>				
    868. 

  868. 	
    869. 

  869. 	
    870. 

  870. </div>
    871. 

  871. 						
    872. 

  872. 						<div class="section-method">
    873. 

  873. 	<a name="//api/name/getTableSchema:" title="getTableSchema:"></a>
    874. 

  874. 	<h3 class="subsubtitle method-title">getTableSchema:</h3>
    875. 

  875. 	
    876. 

  876. 	
    877. 

  877. 	
    878. 

  878. 	<div class="method-subsection brief-description">
    879. 

  879. 		<p>The schema of the database.</p>
    880. 

  880. 	</div>		
    881. 

  881. 	
    882. 

  882.     
    883. 

  883. 

  884. 	<div class="method-subsection method-declaration"><code>- (FMResultSet *)getTableSchema:(NSString *)<em>tableName</em></code></div>
    885. 

  885. 

  886.     
    887. 

  887. 	
    888. 

  888. 	<div class="method-subsection arguments-section parameters">
    889. 

  889. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    890. 

  890. 		
    891. 

  891. 		<dl class="argument-def parameter-def">
    892. 

  892. 			<dt><em>tableName</em></dt>
    893. 

  893. 			<dd><p>The name of the table for whom the schema will be returned.</p></dd>
    894. 

  894. 		</dl>
    895. 

  895. 		
    896. 

  896. 	</div>
    897. 

  897. 	
    898. 

  898. 	
    899. 

  899. 	
    900. 

  900. 	<div class="method-subsection return">
    901. 

  901. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    902. 

  902. 		<p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
    903. 

  903. 	</div>
    904. 

  904. 	
    905. 

  905. 	
    906. 

  906. 	
    907. 

  907. 	
    908. 

  908. 	
    909. 

  909. 	<div class="method-subsection discussion-section">
    910. 

  910. 		<h4 class="method-subtitle">Discussion</h4>
    911. 

  911. 		<p>This will be the schema for a particular table as report by SQLite <code>PRAGMA</code>, for example:</p>
    912. 

  912. 

  913. <pre><code>PRAGMA table_info('employees')
    914. 

  914. </code></pre>
    915. 

  915. 

  916. <p>This will report:</p>
    917. 

  917. 

  918. <ul>
    919. 

  919. <li><code>cid</code> - The column ID number</li>
    920. 

  920. <li><code>name</code> - The name of the column</li>
    921. 

  921. <li><code>type</code> - The data type specified for the column</li>
    922. 

  922. <li><code>notnull</code> - whether the field is defined as NOT NULL (i.e. values required)</li>
    923. 

  923. <li><code>dflt_value</code> - The default value for the column</li>
    924. 

  924. <li><code>pk</code> - Whether the field is part of the primary key of the table</li>
    925. 

  925. </ul>
    926. 

  926. 

  927. 	</div>
    928. 

  928. 	
    929. 

  929. 	
    930. 

  930. 	
    931. 

  931. 	
    932. 

  932. 	
    933. 

  933. 	<div class="method-subsection see-also-section">
    934. 

  934. 		<h4 class="method-subtitle">See Also</h4>
    935. 

  935. 		<ul>
    936. 

  936. 			
    937. 

  937. 			<li><code><p><a href="http://www.sqlite.org/pragma.html#pragma_table_info">table_info</a></p></code></li>
    938. 

  938. 			
    939. 

  939. 		</ul>
    940. 

  940. 	</div>
    941. 

  941. 	
    942. 

  942. 	
    943. 

  943. 	
    944. 

  944. 	<div class="method-subsection declared-in-section">
    945. 

  945. 		<h4 class="method-subtitle">Declared In</h4>
    946. 

  946. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    947. 

  947. 	</div>				
    948. 

  948. 	
    949. 

  949. 	
    950. 

  950. </div>
    951. 

  951. 						
    952. 

  952. 						<div class="section-method">
    953. 

  953. 	<a name="//api/name/intForQuery:" title="intForQuery:"></a>
    954. 

  954. 	<h3 class="subsubtitle method-title">intForQuery:</h3>
    955. 

  955. 	
    956. 

  956. 	
    957. 

  957. 	
    958. 

  958. 	<div class="method-subsection brief-description">
    959. 

  959. 		<p>Return <code>int</code> value for query</p>
    960. 

  960. 	</div>		
    961. 

  961. 	
    962. 

  962.     
    963. 

  963. 

  964. 	<div class="method-subsection method-declaration"><code>- (int)intForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    965. 

  965. 

  966.     
    967. 

  967. 	
    968. 

  968. 	<div class="method-subsection arguments-section parameters">
    969. 

  969. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    970. 

  970. 		
    971. 

  971. 		<dl class="argument-def parameter-def">
    972. 

  972. 			<dt><em>query</em></dt>
    973. 

  973. 			<dd><p>The SQL query to be performed.</p></dd>
    974. 

  974. 		</dl>
    975. 

  975. 		
    976. 

  976. 		<dl class="argument-def parameter-def">
    977. 

  977. 			<dt><em>...</em></dt>
    978. 

  978. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    979. 

  979. 		</dl>
    980. 

  980. 		
    981. 

  981. 	</div>
    982. 

  982. 	
    983. 

  983. 	
    984. 

  984. 	
    985. 

  985. 	<div class="method-subsection return">
    986. 

  986. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    987. 

  987. 		<p><code>int</code> value.</p>
    988. 

  988. 	</div>
    989. 

  989. 	
    990. 

  990. 	
    991. 

  991. 	
    992. 

  992. 	
    993. 

  993. 	
    994. 

  994. 	
    995. 

  995. 	
    996. 

  996. 	
    997. 

  997. 	
    998. 

  998. 	
    999. 

  999. 	
    1000. 

  1000. 	<div class="method-subsection declared-in-section">
    1001. 

  1001. 		<h4 class="method-subtitle">Declared In</h4>
    1002. 

  1002. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1003. 

  1003. 	</div>				
    1004. 

  1004. 	
    1005. 

  1005. 	
    1006. 

  1006. </div>
    1007. 

  1007. 						
    1008. 

  1008. 						<div class="section-method">
    1009. 

  1009. 	<a name="//api/name/longForQuery:" title="longForQuery:"></a>
    1010. 

  1010. 	<h3 class="subsubtitle method-title">longForQuery:</h3>
    1011. 

  1011. 	
    1012. 

  1012. 	
    1013. 

  1013. 	
    1014. 

  1014. 	<div class="method-subsection brief-description">
    1015. 

  1015. 		<p>Return <code>long</code> value for query</p>
    1016. 

  1016. 	</div>		
    1017. 

  1017. 	
    1018. 

  1018.     
    1019. 

  1019. 

  1020. 	<div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    1021. 

  1021. 

  1022.     
    1023. 

  1023. 	
    1024. 

  1024. 	<div class="method-subsection arguments-section parameters">
    1025. 

  1025. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1026. 

  1026. 		
    1027. 

  1027. 		<dl class="argument-def parameter-def">
    1028. 

  1028. 			<dt><em>query</em></dt>
    1029. 

  1029. 			<dd><p>The SQL query to be performed.</p></dd>
    1030. 

  1030. 		</dl>
    1031. 

  1031. 		
    1032. 

  1032. 		<dl class="argument-def parameter-def">
    1033. 

  1033. 			<dt><em>...</em></dt>
    1034. 

  1034. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    1035. 

  1035. 		</dl>
    1036. 

  1036. 		
    1037. 

  1037. 	</div>
    1038. 

  1038. 	
    1039. 

  1039. 	
    1040. 

  1040. 	
    1041. 

  1041. 	<div class="method-subsection return">
    1042. 

  1042. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    1043. 

  1043. 		<p><code>long</code> value.</p>
    1044. 

  1044. 	</div>
    1045. 

  1045. 	
    1046. 

  1046. 	
    1047. 

  1047. 	
    1048. 

  1048. 	
    1049. 

  1049. 	
    1050. 

  1050. 	
    1051. 

  1051. 	
    1052. 

  1052. 	
    1053. 

  1053. 	
    1054. 

  1054. 	
    1055. 

  1055. 	
    1056. 

  1056. 	<div class="method-subsection declared-in-section">
    1057. 

  1057. 		<h4 class="method-subtitle">Declared In</h4>
    1058. 

  1058. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1059. 

  1059. 	</div>				
    1060. 

  1060. 	
    1061. 

  1061. 	
    1062. 

  1062. </div>
    1063. 

  1063. 						
    1064. 

  1064. 						<div class="section-method">
    1065. 

  1065. 	<a name="//api/name/setApplicationID:" title="setApplicationID:"></a>
    1066. 

  1066. 	<h3 class="subsubtitle method-title">setApplicationID:</h3>
    1067. 

  1067. 	
    1068. 

  1068. 	
    1069. 

  1069. 	
    1070. 

  1070. 	<div class="method-subsection brief-description">
    1071. 

  1071. 		<p>Set the application ID</p>
    1072. 

  1072. 	</div>		
    1073. 

  1073. 	
    1074. 

  1074.     
    1075. 

  1075. 

  1076. 	<div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div>
    1077. 

  1077. 

  1078.     
    1079. 

  1079. 	
    1080. 

  1080. 	<div class="method-subsection arguments-section parameters">
    1081. 

  1081. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1082. 

  1082. 		
    1083. 

  1083. 		<dl class="argument-def parameter-def">
    1084. 

  1084. 			<dt><em>appID</em></dt>
    1085. 

  1085. 			<dd><p>The <code>uint32_t</code> numeric value of the application ID.</p></dd>
    1086. 

  1086. 		</dl>
    1087. 

  1087. 		
    1088. 

  1088. 	</div>
    1089. 

  1089. 	
    1090. 

  1090. 	
    1091. 

  1091. 	
    1092. 

  1092. 	
    1093. 

  1093. 	
    1094. 

  1094. 	
    1095. 

  1095. 	
    1096. 

  1096. 	
    1097. 

  1097. 	
    1098. 

  1098. 	
    1099. 

  1099. 	
    1100. 

  1100. 	<div class="method-subsection see-also-section">
    1101. 

  1101. 		<h4 class="method-subtitle">See Also</h4>
    1102. 

  1102. 		<ul>
    1103. 

  1103. 			
    1104. 

  1104. 			<li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li>
    1105. 

  1105. 			
    1106. 

  1106. 		</ul>
    1107. 

  1107. 	</div>
    1108. 

  1108. 	
    1109. 

  1109. 	
    1110. 

  1110. 	
    1111. 

  1111. 	<div class="method-subsection declared-in-section">
    1112. 

  1112. 		<h4 class="method-subtitle">Declared In</h4>
    1113. 

  1113. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1114. 

  1114. 	</div>				
    1115. 

  1115. 	
    1116. 

  1116. 	
    1117. 

  1117. </div>
    1118. 

  1118. 						
    1119. 

  1119. 						<div class="section-method">
    1120. 

  1120. 	<a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a>
    1121. 

  1121. 	<h3 class="subsubtitle method-title">setApplicationIDString:</h3>
    1122. 

  1122. 	
    1123. 

  1123. 	
    1124. 

  1124. 	
    1125. 

  1125. 	<div class="method-subsection brief-description">
    1126. 

  1126. 		<p>Set the application ID string</p>
    1127. 

  1127. 	</div>		
    1128. 

  1128. 	
    1129. 

  1129.     
    1130. 

  1130. 

  1131. 	<div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div>
    1132. 

  1132. 

  1133.     
    1134. 

  1134. 	
    1135. 

  1135. 	<div class="method-subsection arguments-section parameters">
    1136. 

  1136. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1137. 

  1137. 		
    1138. 

  1138. 		<dl class="argument-def parameter-def">
    1139. 

  1139. 			<dt><em>string</em></dt>
    1140. 

  1140. 			<dd><p>The <code>NSString</code> value of the application ID.</p></dd>
    1141. 

  1141. 		</dl>
    1142. 

  1142. 		
    1143. 

  1143. 	</div>
    1144. 

  1144. 	
    1145. 

  1145. 	
    1146. 

  1146. 	
    1147. 

  1147. 	
    1148. 

  1148. 	
    1149. 

  1149. 	
    1150. 

  1150. 	
    1151. 

  1151. 	
    1152. 

  1152. 	
    1153. 

  1153. 	
    1154. 

  1154. 	
    1155. 

  1155. 	<div class="method-subsection see-also-section">
    1156. 

  1156. 		<h4 class="method-subtitle">See Also</h4>
    1157. 

  1157. 		<ul>
    1158. 

  1158. 			
    1159. 

  1159. 			<li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li>
    1160. 

  1160. 			
    1161. 

  1161. 		</ul>
    1162. 

  1162. 	</div>
    1163. 

  1163. 	
    1164. 

  1164. 	
    1165. 

  1165. 	
    1166. 

  1166. 	<div class="method-subsection declared-in-section">
    1167. 

  1167. 		<h4 class="method-subtitle">Declared In</h4>
    1168. 

  1168. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1169. 

  1169. 	</div>				
    1170. 

  1170. 	
    1171. 

  1171. 	
    1172. 

  1172. </div>
    1173. 

  1173. 						
    1174. 

  1174. 						<div class="section-method">
    1175. 

  1175. 	<a name="//api/name/stringForQuery:" title="stringForQuery:"></a>
    1176. 

  1176. 	<h3 class="subsubtitle method-title">stringForQuery:</h3>
    1177. 

  1177. 	
    1178. 

  1178. 	
    1179. 

  1179. 	
    1180. 

  1180. 	<div class="method-subsection brief-description">
    1181. 

  1181. 		<p>Return <code>NSString</code> value for query</p>
    1182. 

  1182. 	</div>		
    1183. 

  1183. 	
    1184. 

  1184.     
    1185. 

  1185. 

  1186. 	<div class="method-subsection method-declaration"><code>- (NSString *)stringForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
    1187. 

  1187. 

  1188.     
    1189. 

  1189. 	
    1190. 

  1190. 	<div class="method-subsection arguments-section parameters">
    1191. 

  1191. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1192. 

  1192. 		
    1193. 

  1193. 		<dl class="argument-def parameter-def">
    1194. 

  1194. 			<dt><em>query</em></dt>
    1195. 

  1195. 			<dd><p>The SQL query to be performed.</p></dd>
    1196. 

  1196. 		</dl>
    1197. 

  1197. 		
    1198. 

  1198. 		<dl class="argument-def parameter-def">
    1199. 

  1199. 			<dt><em>...</em></dt>
    1200. 

  1200. 			<dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
    1201. 

  1201. 		</dl>
    1202. 

  1202. 		
    1203. 

  1203. 	</div>
    1204. 

  1204. 	
    1205. 

  1205. 	
    1206. 

  1206. 	
    1207. 

  1207. 	<div class="method-subsection return">
    1208. 

  1208. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    1209. 

  1209. 		<p><code>NSString</code> value.</p>
    1210. 

  1210. 	</div>
    1211. 

  1211. 	
    1212. 

  1212. 	
    1213. 

  1213. 	
    1214. 

  1214. 	
    1215. 

  1215. 	
    1216. 

  1216. 	
    1217. 

  1217. 	
    1218. 

  1218. 	
    1219. 

  1219. 	
    1220. 

  1220. 	
    1221. 

  1221. 	
    1222. 

  1222. 	<div class="method-subsection declared-in-section">
    1223. 

  1223. 		<h4 class="method-subtitle">Declared In</h4>
    1224. 

  1224. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1225. 

  1225. 	</div>				
    1226. 

  1226. 	
    1227. 

  1227. 	
    1228. 

  1228. </div>
    1229. 

  1229. 						
    1230. 

  1230. 						<div class="section-method">
    1231. 

  1231. 	<a name="//api/name/tableExists:" title="tableExists:"></a>
    1232. 

  1232. 	<h3 class="subsubtitle method-title">tableExists:</h3>
    1233. 

  1233. 	
    1234. 

  1234. 	
    1235. 

  1235. 	
    1236. 

  1236. 	<div class="method-subsection brief-description">
    1237. 

  1237. 		<p>Does table exist in database?</p>
    1238. 

  1238. 	</div>		
    1239. 

  1239. 	
    1240. 

  1240.     
    1241. 

  1241. 

  1242. 	<div class="method-subsection method-declaration"><code>- (BOOL)tableExists:(NSString *)<em>tableName</em></code></div>
    1243. 

  1243. 

  1244.     
    1245. 

  1245. 	
    1246. 

  1246. 	<div class="method-subsection arguments-section parameters">
    1247. 

  1247. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1248. 

  1248. 		
    1249. 

  1249. 		<dl class="argument-def parameter-def">
    1250. 

  1250. 			<dt><em>tableName</em></dt>
    1251. 

  1251. 			<dd><p>The name of the table being looked for.</p></dd>
    1252. 

  1252. 		</dl>
    1253. 

  1253. 		
    1254. 

  1254. 	</div>
    1255. 

  1255. 	
    1256. 

  1256. 	
    1257. 

  1257. 	
    1258. 

  1258. 	<div class="method-subsection return">
    1259. 

  1259. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    1260. 

  1260. 		<p><code>YES</code> if table found; <code>NO</code> if not found.</p>
    1261. 

  1261. 	</div>
    1262. 

  1262. 	
    1263. 

  1263. 	
    1264. 

  1264. 	
    1265. 

  1265. 	
    1266. 

  1266. 	
    1267. 

  1267. 	
    1268. 

  1268. 	
    1269. 

  1269. 	
    1270. 

  1270. 	
    1271. 

  1271. 	
    1272. 

  1272. 	
    1273. 

  1273. 	<div class="method-subsection declared-in-section">
    1274. 

  1274. 		<h4 class="method-subtitle">Declared In</h4>
    1275. 

  1275. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1276. 

  1276. 	</div>				
    1277. 

  1277. 	
    1278. 

  1278. 	
    1279. 

  1279. </div>
    1280. 

  1280. 						
    1281. 

  1281. 						<div class="section-method">
    1282. 

  1282. 	<a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a>
    1283. 

  1283. 	<h3 class="subsubtitle method-title">validateSQL:error:</h3>
    1284. 

  1284. 	
    1285. 

  1285. 	
    1286. 

  1286. 	
    1287. 

  1287. 	<div class="method-subsection brief-description">
    1288. 

  1288. 		<p>Validate SQL statement</p>
    1289. 

  1289. 	</div>		
    1290. 

  1290. 	
    1291. 

  1291.     
    1292. 

  1292. 

  1293. 	<div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div>
    1294. 

  1294. 

  1295.     
    1296. 

  1296. 	
    1297. 

  1297. 	<div class="method-subsection arguments-section parameters">
    1298. 

  1298. 		<h4 class="method-subtitle parameter-title">Parameters</h4>
    1299. 

  1299. 		
    1300. 

  1300. 		<dl class="argument-def parameter-def">
    1301. 

  1301. 			<dt><em>sql</em></dt>
    1302. 

  1302. 			<dd><p>The SQL statement being validated.</p></dd>
    1303. 

  1303. 		</dl>
    1304. 

  1304. 		
    1305. 

  1305. 		<dl class="argument-def parameter-def">
    1306. 

  1306. 			<dt><em>error</em></dt>
    1307. 

  1307. 			<dd><p>This is a pointer to a <code>NSError</code> object that will receive the autoreleased <code>NSError</code> object if there was any error. If this is <code>nil</code>, no <code>NSError</code> result will be returned.</p></dd>
    1308. 

  1308. 		</dl>
    1309. 

  1309. 		
    1310. 

  1310. 	</div>
    1311. 

  1311. 	
    1312. 

  1312. 	
    1313. 

  1313. 	
    1314. 

  1314. 	<div class="method-subsection return">
    1315. 

  1315. 		<h4 class="method-subtitle parameter-title">Return Value</h4>
    1316. 

  1316. 		<p><code>YES</code> if validation succeeded without incident; <code>NO</code> otherwise.</p>
    1317. 

  1317. 	</div>
    1318. 

  1318. 	
    1319. 

  1319. 	
    1320. 

  1320. 	
    1321. 

  1321. 	
    1322. 

  1322. 	
    1323. 

  1323. 	<div class="method-subsection discussion-section">
    1324. 

  1324. 		<h4 class="method-subtitle">Discussion</h4>
    1325. 

  1325. 		<p>This validates SQL statement by performing <code>sqlite3_prepare_v2</code>, but not returning the results, but instead immediately calling <code>sqlite3_finalize</code>.</p>
    1326. 

  1326. 	</div>
    1327. 

  1327. 	
    1328. 

  1328. 	
    1329. 

  1329. 	
    1330. 

  1330. 	
    1331. 

  1331. 	
    1332. 

  1332. 	
    1333. 

  1333. 	
    1334. 

  1334. 	<div class="method-subsection declared-in-section">
    1335. 

  1335. 		<h4 class="method-subtitle">Declared In</h4>
    1336. 

  1336. 		<code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
    1337. 

  1337. 	</div>				
    1338. 

  1338. 	
    1339. 

  1339. 	
    1340. 

  1340. </div>
    1341. 

  1341. 						
    1342. 

  1342. 					</div>
    1343. 

  1343. 					
    1344. 

  1344. 					
    1345. 

  1345. 				</div>
    1346. 

  1346. 				<div class="main-navigation navigation-bottom">
    1347. 

  1347. 					<ul>
    1348. 

  1348. 	<li><a href="../index.html">Index</a></li>
    1349. 

  1349. 	<li><a href="../hierarchy.html">Hierarchy</a></li>
    1350. 

  1350. </ul>
    1351. 

  1351. 				</div>
    1352. 

  1352. 				<div id="footer">
    1353. 

  1353. 					<hr />
    1354. 

  1354. 					<div class="footer-copyright">
    1355. 

  1355. 						<p><span class="copyright">&copy; 2013 ccgus. All rights reserved. (Last updated: 2013-08-06)</span><br />
    1356. 

  1356. 						
    1357. 

  1357. 						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
    1358. 

  1358. 						
    1359. 

  1359. 					</div>
    1360. 

  1360. 				</div>
    1361. 

  1361. 			</div>
    1362. 

  1362. 		</article>
    1363. 

  1363. 		<script type="text/javascript">
    1364. 

  1364. 			function jumpToChange()
    1365. 

  1365. 			{
    1366. 

  1366. 				window.location.hash = this.options[this.selectedIndex].value;
    1367. 

  1367. 			}
    1368. 

  1368. 			
    1369. 

  1369. 			function toggleTOC()
    1370. 

  1370. 			{
    1371. 

  1371. 				var contents = document.getElementById('contents');
    1372. 

  1372. 				var tocContainer = document.getElementById('tocContainer');
    1373. 

  1373. 				
    1374. 

  1374. 				if (this.getAttribute('class') == 'open')
    1375. 

  1375. 				{
    1376. 

  1376. 					this.setAttribute('class', '');
    1377. 

  1377. 					contents.setAttribute('class', '');
    1378. 

  1378. 					tocContainer.setAttribute('class', '');
    1379. 

  1379. 					
    1380. 

  1380. 					window.name = "hideTOC";
    1381. 

  1381. 				}
    1382. 

  1382. 				else
    1383. 

  1383. 				{
    1384. 

  1384. 					this.setAttribute('class', 'open');
    1385. 

  1385. 					contents.setAttribute('class', 'isShowingTOC');
    1386. 

  1386. 					tocContainer.setAttribute('class', 'isShowingTOC');
    1387. 

  1387. 					
    1388. 

  1388. 					window.name = "";
    1389. 

  1389. 				}
    1390. 

  1390. 				return false;
    1391. 

  1391. 			}
    1392. 

  1392. 			
    1393. 

  1393. 			function toggleTOCEntryChildren(e)
    1394. 

  1394. 			{
    1395. 

  1395. 				e.stopPropagation();
    1396. 

  1396. 				var currentClass = this.getAttribute('class');
    1397. 

  1397. 				if (currentClass == 'children') {
    1398. 

  1398. 					this.setAttribute('class', 'children open');
    1399. 

  1399. 				}
    1400. 

  1400. 				else if (currentClass == 'children open') {
    1401. 

  1401. 					this.setAttribute('class', 'children');
    1402. 

  1402. 				}
    1403. 

  1403. 				return false;
    1404. 

  1404. 			}
    1405. 

  1405. 			
    1406. 

  1406. 			function tocEntryClick(e)
    1407. 

  1407. 			{
    1408. 

  1408. 				e.stopPropagation();
    1409. 

  1409. 				return true;
    1410. 

  1410. 			}
    1411. 

  1411. 			
    1412. 

  1412. 			function init()
    1413. 

  1413. 			{
    1414. 

  1414. 				var selectElement = document.getElementById('jumpTo');
    1415. 

  1415. 				selectElement.addEventListener('change', jumpToChange, false);
    1416. 

  1416. 				
    1417. 

  1417. 				var tocButton = document.getElementById('table_of_contents');
    1418. 

  1418. 				tocButton.addEventListener('click', toggleTOC, false);
    1419. 

  1419. 				
    1420. 

  1420. 				var taskTreeItem = document.getElementById('task_treeitem');
    1421. 

  1421. 				if (taskTreeItem.getElementsByTagName('li').length > 0)
    1422. 

  1422. 				{
    1423. 

  1423. 					taskTreeItem.setAttribute('class', 'children');
    1424. 

  1424. 					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
    1425. 

  1425. 				}
    1426. 

  1426. 				
    1427. 

  1427. 				var tocList = document.getElementById('toc');
    1428. 

  1428. 				
    1429. 

  1429. 				var tocEntries = tocList.getElementsByTagName('li');
    1430. 

  1430. 				for (var i = 0; i < tocEntries.length; i++) {
    1431. 

  1431. 					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
    1432. 

  1432. 				}
    1433. 

  1433. 				
    1434. 

  1434. 				var tocLinks = tocList.getElementsByTagName('a');
    1435. 

  1435. 				for (var i = 0; i < tocLinks.length; i++) {
    1436. 

  1436. 					tocLinks[i].addEventListener('click', tocEntryClick, false);
    1437. 

  1437. 				}
    1438. 

  1438. 				
    1439. 

  1439. 				if (window.name == "hideTOC") {
    1440. 

  1440. 					toggleTOC.call(tocButton);
    1441. 

  1441. 				}
    1442. 

  1442. 			}
    1443. 

  1443. 			
    1444. 

  1444. 			window.onload = init;
    1445. 

  1445. 			
    1446. 

  1446. 			// If showing in Xcode, hide the TOC and Header
    1447. 

  1447. 			if (navigator.userAgent.match(/xcode/i)) {
    1448. 

  1448. 				document.getElementById("contents").className = "hideInXcode"
    1449. 

  1449. 				document.getElementById("tocContainer").className = "hideInXcode"
    1450. 

  1450. 				document.getElementById("top_header").className = "hideInXcode"
    1451. 

  1451. 			}
    1452. 

  1452. 			
    1453. 

  1453. 		</script>
    1454. 

  1454. 	</body>
    1455. 

  1455. </html>
    1456.