FMResultSet.html 74 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
  5. <title>FMResultSet Class Reference</title>
  6. <meta id="xcode-display" name="xcode-display" content="render"/>
  7. <meta name="viewport" content="width=550" />
  8. <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
  9. <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
  10. <meta name="generator" content="appledoc 2.1 (build 858)" />
  11. </head>
  12. <body>
  13. <header id="top_header">
  14. <div id="library" class="hideInXcode">
  15. <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1>
  16. <a id="developerHome" href="../index.html">ccgus</a>
  17. </div>
  18. <div id="title" role="banner">
  19. <h1 class="hideInXcode">FMResultSet Class Reference</h1>
  20. </div>
  21. <ul id="headerButtons" role="toolbar">
  22. <li id="toc_button">
  23. <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
  24. </li>
  25. <li id="jumpto_button" role="navigation">
  26. <select id="jumpTo">
  27. <option value="top">Jump To&#133;</option>
  28. <option value="overview">Overview</option>
  29. <option value="tasks">Tasks</option>
  30. <option value="properties">Properties</option>
  31. <option value="//api/name/query">&nbsp;&nbsp;&nbsp;&nbsp;query</option>
  32. <option value="//api/name/statement">&nbsp;&nbsp;&nbsp;&nbsp;statement</option>
  33. <option value="class_methods">Class Methods</option>
  34. <option value="//api/name/resultSetWithStatement:usingParentDatabase:">&nbsp;&nbsp;&nbsp;&nbsp;+ resultSetWithStatement:usingParentDatabase:</option>
  35. <option value="instance_methods">Instance Methods</option>
  36. <option value="//api/name/UTF8StringForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- UTF8StringForColumnIndex:</option>
  37. <option value="//api/name/UTF8StringForColumnName:">&nbsp;&nbsp;&nbsp;&nbsp;- UTF8StringForColumnName:</option>
  38. <option value="//api/name/boolForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- boolForColumn:</option>
  39. <option value="//api/name/boolForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- boolForColumnIndex:</option>
  40. <option value="//api/name/close">&nbsp;&nbsp;&nbsp;&nbsp;- close</option>
  41. <option value="//api/name/columnCount">&nbsp;&nbsp;&nbsp;&nbsp;- columnCount</option>
  42. <option value="//api/name/columnIndexForName:">&nbsp;&nbsp;&nbsp;&nbsp;- columnIndexForName:</option>
  43. <option value="//api/name/columnIndexIsNull:">&nbsp;&nbsp;&nbsp;&nbsp;- columnIndexIsNull:</option>
  44. <option value="//api/name/columnIsNull:">&nbsp;&nbsp;&nbsp;&nbsp;- columnIsNull:</option>
  45. <option value="//api/name/columnNameForIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- columnNameForIndex:</option>
  46. <option value="//api/name/columnNameToIndexMap">&nbsp;&nbsp;&nbsp;&nbsp;- columnNameToIndexMap</option>
  47. <option value="//api/name/dataForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- dataForColumn:</option>
  48. <option value="//api/name/dataForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- dataForColumnIndex:</option>
  49. <option value="//api/name/dataNoCopyForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- dataNoCopyForColumn:</option>
  50. <option value="//api/name/dataNoCopyForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- dataNoCopyForColumnIndex:</option>
  51. <option value="//api/name/dateForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- dateForColumn:</option>
  52. <option value="//api/name/dateForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- dateForColumnIndex:</option>
  53. <option value="//api/name/doubleForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- doubleForColumn:</option>
  54. <option value="//api/name/doubleForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- doubleForColumnIndex:</option>
  55. <option value="//api/name/hasAnotherRow">&nbsp;&nbsp;&nbsp;&nbsp;- hasAnotherRow</option>
  56. <option value="//api/name/intForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- intForColumn:</option>
  57. <option value="//api/name/intForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- intForColumnIndex:</option>
  58. <option value="//api/name/kvcMagic:">&nbsp;&nbsp;&nbsp;&nbsp;- kvcMagic:</option>
  59. <option value="//api/name/longForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- longForColumn:</option>
  60. <option value="//api/name/longForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- longForColumnIndex:</option>
  61. <option value="//api/name/longLongIntForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- longLongIntForColumn:</option>
  62. <option value="//api/name/longLongIntForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- longLongIntForColumnIndex:</option>
  63. <option value="//api/name/next">&nbsp;&nbsp;&nbsp;&nbsp;- next</option>
  64. <option value="//api/name/objectAtIndexedSubscript:">&nbsp;&nbsp;&nbsp;&nbsp;- objectAtIndexedSubscript:</option>
  65. <option value="//api/name/objectForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- objectForColumnIndex:</option>
  66. <option value="//api/name/objectForColumnName:">&nbsp;&nbsp;&nbsp;&nbsp;- objectForColumnName:</option>
  67. <option value="//api/name/objectForKeyedSubscript:">&nbsp;&nbsp;&nbsp;&nbsp;- objectForKeyedSubscript:</option>
  68. <option value="//api/name/resultDict">&nbsp;&nbsp;&nbsp;&nbsp;- resultDict</option>
  69. <option value="//api/name/resultDictionary">&nbsp;&nbsp;&nbsp;&nbsp;- resultDictionary</option>
  70. <option value="//api/name/stringForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- stringForColumn:</option>
  71. <option value="//api/name/stringForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- stringForColumnIndex:</option>
  72. <option value="//api/name/unsignedLongLongIntForColumn:">&nbsp;&nbsp;&nbsp;&nbsp;- unsignedLongLongIntForColumn:</option>
  73. <option value="//api/name/unsignedLongLongIntForColumnIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- unsignedLongLongIntForColumnIndex:</option>
  74. </select>
  75. </li>
  76. </ul>
  77. </header>
  78. <nav id="tocContainer" class="isShowingTOC">
  79. <ul id="toc" role="tree">
  80. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
  81. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
  82. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Properties">Properties</a></span></li>
  83. </ul></li>
  84. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
  85. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/query">query</a></span></li>
  86. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/statement">statement</a></span></li>
  87. </ul></li>
  88. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
  89. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">resultSetWithStatement:usingParentDatabase:</a></span></li>
  90. </ul></li>
  91. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
  92. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/UTF8StringForColumnIndex:">UTF8StringForColumnIndex:</a></span></li>
  93. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/UTF8StringForColumnName:">UTF8StringForColumnName:</a></span></li>
  94. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForColumn:">boolForColumn:</a></span></li>
  95. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForColumnIndex:">boolForColumnIndex:</a></span></li>
  96. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li>
  97. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnCount">columnCount</a></span></li>
  98. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIndexForName:">columnIndexForName:</a></span></li>
  99. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIndexIsNull:">columnIndexIsNull:</a></span></li>
  100. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIsNull:">columnIsNull:</a></span></li>
  101. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnNameForIndex:">columnNameForIndex:</a></span></li>
  102. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnNameToIndexMap">columnNameToIndexMap</a></span></li>
  103. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForColumn:">dataForColumn:</a></span></li>
  104. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForColumnIndex:">dataForColumnIndex:</a></span></li>
  105. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataNoCopyForColumn:">dataNoCopyForColumn:</a></span></li>
  106. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataNoCopyForColumnIndex:">dataNoCopyForColumnIndex:</a></span></li>
  107. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForColumn:">dateForColumn:</a></span></li>
  108. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForColumnIndex:">dateForColumnIndex:</a></span></li>
  109. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForColumn:">doubleForColumn:</a></span></li>
  110. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForColumnIndex:">doubleForColumnIndex:</a></span></li>
  111. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hasAnotherRow">hasAnotherRow</a></span></li>
  112. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForColumn:">intForColumn:</a></span></li>
  113. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForColumnIndex:">intForColumnIndex:</a></span></li>
  114. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/kvcMagic:">kvcMagic:</a></span></li>
  115. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForColumn:">longForColumn:</a></span></li>
  116. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForColumnIndex:">longForColumnIndex:</a></span></li>
  117. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longLongIntForColumn:">longLongIntForColumn:</a></span></li>
  118. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longLongIntForColumnIndex:">longLongIntForColumnIndex:</a></span></li>
  119. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/next">next</a></span></li>
  120. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectAtIndexedSubscript:">objectAtIndexedSubscript:</a></span></li>
  121. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForColumnIndex:">objectForColumnIndex:</a></span></li>
  122. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForColumnName:">objectForColumnName:</a></span></li>
  123. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForKeyedSubscript:">objectForKeyedSubscript:</a></span></li>
  124. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultDict">resultDict</a></span></li>
  125. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultDictionary">resultDictionary</a></span></li>
  126. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForColumn:">stringForColumn:</a></span></li>
  127. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForColumnIndex:">stringForColumnIndex:</a></span></li>
  128. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/unsignedLongLongIntForColumn:">unsignedLongLongIntForColumn:</a></span></li>
  129. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/unsignedLongLongIntForColumnIndex:">unsignedLongLongIntForColumnIndex:</a></span></li>
  130. </ul></li>
  131. </ul>
  132. </nav>
  133. <article>
  134. <div id="contents" class="isShowingTOC" role="main">
  135. <a title="FMResultSet Class Reference" name="top"></a>
  136. <div class="main-navigation navigation-top">
  137. <ul>
  138. <li><a href="../index.html">Index</a></li>
  139. <li><a href="../hierarchy.html">Hierarchy</a></li>
  140. </ul>
  141. </div>
  142. <div id="header">
  143. <div class="section-header">
  144. <h1 class="title title-header">FMResultSet Class Reference</h1>
  145. </div>
  146. </div>
  147. <div id="container">
  148. <div class="section section-specification"><table cellspacing="0"><tbody>
  149. <tr>
  150. <td class="specification-title">Inherits from</td>
  151. <td class="specification-value">NSObject</td>
  152. </tr><tr>
  153. <td class="specification-title">Declared in</td>
  154. <td class="specification-value">FMResultSet.h<br />FMResultSet.m</td>
  155. </tr>
  156. </tbody></table></div>
  157. <div class="section section-overview">
  158. <a title="Overview" name="overview"></a>
  159. <h2 class="subtitle subtitle-overview">Overview</h2>
  160. <p>Represents the results of executing a query on an <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a>.</p>
  161. <h3>See also</h3>
  162. <ul>
  163. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
  164. </ul>
  165. </div>
  166. <div class="section section-tasks">
  167. <a title="Tasks" name="tasks"></a>
  168. <h2 class="subtitle subtitle-tasks">Tasks</h2>
  169. <h3 class="subsubtitle task-title">Other Methods</h3>
  170. <ul class="task-list">
  171. <li>
  172. <span class="tooltip">
  173. <code><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">+&nbsp;resultSetWithStatement:usingParentDatabase:</a></code>
  174. <span class="tooltip"><p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p></span>
  175. </span>
  176. </li><li>
  177. <span class="tooltip">
  178. <code><a href="#//api/name/close">&ndash;&nbsp;close</a></code>
  179. <span class="tooltip"><p>Close result set</p></span>
  180. </span>
  181. </li><li>
  182. <span class="tooltip">
  183. <code><a href="#//api/name/columnCount">&ndash;&nbsp;columnCount</a></code>
  184. <span class="tooltip"><p>How many columns in result set</p></span>
  185. </span>
  186. </li><li>
  187. <span class="tooltip">
  188. <code><a href="#//api/name/columnNameToIndexMap">&ndash;&nbsp;columnNameToIndexMap</a></code>
  189. <span class="tooltip"><p><code>NSMutableDictionary</code> mapping column names to numeric index</p></span>
  190. </span>
  191. </li><li>
  192. <span class="tooltip">
  193. <code><a href="#//api/name/kvcMagic:">&ndash;&nbsp;kvcMagic:</a></code>
  194. <span class="tooltip"><p>Performs <code>setValue</code> to yield support for key value observing.</p></span>
  195. </span>
  196. </li><li>
  197. <span class="tooltip">
  198. <code><a href="#//api/name/resultDict">&ndash;&nbsp;resultDict</a></code>
  199. <span class="tooltip"><p>Returns a dictionary of the row results</p></span>
  200. </span>
  201. </li><li>
  202. <span class="tooltip">
  203. <code><a href="#//api/name/resultDictionary">&ndash;&nbsp;resultDictionary</a></code>
  204. <span class="tooltip"><p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p></span>
  205. </span>
  206. </li><li>
  207. <span class="tooltip">
  208. <code><a href="#//api/name/next">&ndash;&nbsp;next</a></code>
  209. <span class="tooltip"><p>Retrieve next row for result set.</p></span>
  210. </span>
  211. </li><li>
  212. <span class="tooltip">
  213. <code><a href="#//api/name/hasAnotherRow">&ndash;&nbsp;hasAnotherRow</a></code>
  214. <span class="tooltip"><p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p></span>
  215. </span>
  216. </li><li>
  217. <span class="tooltip">
  218. <code><a href="#//api/name/columnIndexForName:">&ndash;&nbsp;columnIndexForName:</a></code>
  219. <span class="tooltip"><p>Column index for column name</p></span>
  220. </span>
  221. </li><li>
  222. <span class="tooltip">
  223. <code><a href="#//api/name/intForColumn:">&ndash;&nbsp;intForColumn:</a></code>
  224. <span class="tooltip"><p>Result set integer value for column.</p></span>
  225. </span>
  226. </li><li>
  227. <span class="tooltip">
  228. <code><a href="#//api/name/intForColumnIndex:">&ndash;&nbsp;intForColumnIndex:</a></code>
  229. <span class="tooltip"><p>Result set integer value for column.</p></span>
  230. </span>
  231. </li><li>
  232. <span class="tooltip">
  233. <code><a href="#//api/name/longForColumn:">&ndash;&nbsp;longForColumn:</a></code>
  234. <span class="tooltip"><p>Result set <code>long</code> value for column.</p></span>
  235. </span>
  236. </li><li>
  237. <span class="tooltip">
  238. <code><a href="#//api/name/longForColumnIndex:">&ndash;&nbsp;longForColumnIndex:</a></code>
  239. <span class="tooltip"><p>Result set long value for column.</p></span>
  240. </span>
  241. </li><li>
  242. <span class="tooltip">
  243. <code><a href="#//api/name/longLongIntForColumn:">&ndash;&nbsp;longLongIntForColumn:</a></code>
  244. <span class="tooltip"><p>Result set <code>long long int</code> value for column.</p></span>
  245. </span>
  246. </li><li>
  247. <span class="tooltip">
  248. <code><a href="#//api/name/longLongIntForColumnIndex:">&ndash;&nbsp;longLongIntForColumnIndex:</a></code>
  249. <span class="tooltip"><p>Result set <code>long long int</code> value for column.</p></span>
  250. </span>
  251. </li><li>
  252. <span class="tooltip">
  253. <code><a href="#//api/name/unsignedLongLongIntForColumn:">&ndash;&nbsp;unsignedLongLongIntForColumn:</a></code>
  254. <span class="tooltip"><p>Result set <code>unsigned long long int</code> value for column.</p></span>
  255. </span>
  256. </li><li>
  257. <span class="tooltip">
  258. <code><a href="#//api/name/unsignedLongLongIntForColumnIndex:">&ndash;&nbsp;unsignedLongLongIntForColumnIndex:</a></code>
  259. <span class="tooltip"><p>Result set <code>unsigned long long int</code> value for column.</p></span>
  260. </span>
  261. </li><li>
  262. <span class="tooltip">
  263. <code><a href="#//api/name/boolForColumn:">&ndash;&nbsp;boolForColumn:</a></code>
  264. <span class="tooltip"><p>Result set <code>BOOL</code> value for column.</p></span>
  265. </span>
  266. </li><li>
  267. <span class="tooltip">
  268. <code><a href="#//api/name/boolForColumnIndex:">&ndash;&nbsp;boolForColumnIndex:</a></code>
  269. <span class="tooltip"><p>Result set <code>BOOL</code> value for column.</p></span>
  270. </span>
  271. </li><li>
  272. <span class="tooltip">
  273. <code><a href="#//api/name/doubleForColumn:">&ndash;&nbsp;doubleForColumn:</a></code>
  274. <span class="tooltip"><p>Result set <code>double</code> value for column.</p></span>
  275. </span>
  276. </li><li>
  277. <span class="tooltip">
  278. <code><a href="#//api/name/doubleForColumnIndex:">&ndash;&nbsp;doubleForColumnIndex:</a></code>
  279. <span class="tooltip"><p>Result set <code>double</code> value for column.</p></span>
  280. </span>
  281. </li><li>
  282. <span class="tooltip">
  283. <code><a href="#//api/name/stringForColumnIndex:">&ndash;&nbsp;stringForColumnIndex:</a></code>
  284. <span class="tooltip"><p>Result set <code>NSString</code> value for column.</p></span>
  285. </span>
  286. </li><li>
  287. <span class="tooltip">
  288. <code><a href="#//api/name/stringForColumn:">&ndash;&nbsp;stringForColumn:</a></code>
  289. <span class="tooltip"><p>Result set <code>NSString</code> value for column.</p></span>
  290. </span>
  291. </li><li>
  292. <span class="tooltip">
  293. <code><a href="#//api/name/dateForColumn:">&ndash;&nbsp;dateForColumn:</a></code>
  294. <span class="tooltip"><p>Result set <code>NSDate</code> value for column.</p></span>
  295. </span>
  296. </li><li>
  297. <span class="tooltip">
  298. <code><a href="#//api/name/dateForColumnIndex:">&ndash;&nbsp;dateForColumnIndex:</a></code>
  299. <span class="tooltip"><p>Result set <code>NSDate</code> value for column.</p></span>
  300. </span>
  301. </li><li>
  302. <span class="tooltip">
  303. <code><a href="#//api/name/dataForColumn:">&ndash;&nbsp;dataForColumn:</a></code>
  304. <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span>
  305. </span>
  306. </li><li>
  307. <span class="tooltip">
  308. <code><a href="#//api/name/dataForColumnIndex:">&ndash;&nbsp;dataForColumnIndex:</a></code>
  309. <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span>
  310. </span>
  311. </li><li>
  312. <span class="tooltip">
  313. <code><a href="#//api/name/dataNoCopyForColumn:">&ndash;&nbsp;dataNoCopyForColumn:</a></code>
  314. <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span>
  315. </span>
  316. </li><li>
  317. <span class="tooltip">
  318. <code><a href="#//api/name/dataNoCopyForColumnIndex:">&ndash;&nbsp;dataNoCopyForColumnIndex:</a></code>
  319. <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span>
  320. </span>
  321. </li><li>
  322. <span class="tooltip">
  323. <code><a href="#//api/name/columnIndexIsNull:">&ndash;&nbsp;columnIndexIsNull:</a></code>
  324. <span class="tooltip"><p>Is the column <code>NULL</code>?</p></span>
  325. </span>
  326. </li><li>
  327. <span class="tooltip">
  328. <code><a href="#//api/name/columnIsNull:">&ndash;&nbsp;columnIsNull:</a></code>
  329. <span class="tooltip"><p>Is the column <code>NULL</code>?</p></span>
  330. </span>
  331. </li><li>
  332. <span class="tooltip">
  333. <code><a href="#//api/name/UTF8StringForColumnIndex:">&ndash;&nbsp;UTF8StringForColumnIndex:</a></code>
  334. <span class="tooltip"><p>Result set <code>(const unsigned char *)</code> value for column.</p></span>
  335. </span>
  336. </li><li>
  337. <span class="tooltip">
  338. <code><a href="#//api/name/UTF8StringForColumnName:">&ndash;&nbsp;UTF8StringForColumnName:</a></code>
  339. <span class="tooltip"><p>Result set <code>(const unsigned char *)</code> value for column.</p></span>
  340. </span>
  341. </li><li>
  342. <span class="tooltip">
  343. <code><a href="#//api/name/objectForColumnIndex:">&ndash;&nbsp;objectForColumnIndex:</a></code>
  344. <span class="tooltip"><p>Result set object for column.</p></span>
  345. </span>
  346. </li><li>
  347. <span class="tooltip">
  348. <code><a href="#//api/name/objectForColumnName:">&ndash;&nbsp;objectForColumnName:</a></code>
  349. <span class="tooltip"><p>Result set object for column.</p></span>
  350. </span>
  351. </li><li>
  352. <span class="tooltip">
  353. <code><a href="#//api/name/columnNameForIndex:">&ndash;&nbsp;columnNameForIndex:</a></code>
  354. <span class="tooltip"><p>Column name for column index</p></span>
  355. </span>
  356. </li><li>
  357. <span class="tooltip">
  358. <code><a href="#//api/name/objectAtIndexedSubscript:">&ndash;&nbsp;objectAtIndexedSubscript:</a></code>
  359. <span class="tooltip"><p>Result set object for column.</p></span>
  360. </span>
  361. </li><li>
  362. <span class="tooltip">
  363. <code><a href="#//api/name/objectForKeyedSubscript:">&ndash;&nbsp;objectForKeyedSubscript:</a></code>
  364. <span class="tooltip"><p>Result set object for column.</p></span>
  365. </span>
  366. </li>
  367. </ul>
  368. <a title="Properties" name="task_Properties"></a>
  369. <h3 class="subsubtitle task-title">Properties</h3>
  370. <ul class="task-list">
  371. <li>
  372. <span class="tooltip">
  373. <code><a href="#//api/name/query">&nbsp;&nbsp;query</a></code>
  374. <span class="tooltip"><p>Executed query</p></span>
  375. </span>
  376. <span class="task-item-suffix">property</span>
  377. </li><li>
  378. <span class="tooltip">
  379. <code><a href="#//api/name/statement">&nbsp;&nbsp;statement</a></code>
  380. <span class="tooltip"><p><code>FMStatement</code> used by result set.</p></span>
  381. </span>
  382. <span class="task-item-suffix">property</span>
  383. </li>
  384. </ul>
  385. </div>
  386. <div class="section section-methods">
  387. <a title="Properties" name="properties"></a>
  388. <h2 class="subtitle subtitle-methods">Properties</h2>
  389. <div class="section-method">
  390. <a name="//api/name/query" title="query"></a>
  391. <h3 class="subsubtitle method-title">query</h3>
  392. <div class="method-subsection brief-description">
  393. <p>Executed query</p>
  394. </div>
  395. <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div>
  396. <div class="method-subsection declared-in-section">
  397. <h4 class="method-subtitle">Declared In</h4>
  398. <code class="declared-in-ref">FMResultSet.h</code><br />
  399. </div>
  400. </div>
  401. <div class="section-method">
  402. <a name="//api/name/statement" title="statement"></a>
  403. <h3 class="subsubtitle method-title">statement</h3>
  404. <div class="method-subsection brief-description">
  405. <p><code>FMStatement</code> used by result set.</p>
  406. </div>
  407. <div class="method-subsection method-declaration"><code>@property (atomic, retain) FMStatement *statement</code></div>
  408. <div class="method-subsection declared-in-section">
  409. <h4 class="method-subtitle">Declared In</h4>
  410. <code class="declared-in-ref">FMResultSet.h</code><br />
  411. </div>
  412. </div>
  413. </div>
  414. <div class="section section-methods">
  415. <a title="Class Methods" name="class_methods"></a>
  416. <h2 class="subtitle subtitle-methods">Class Methods</h2>
  417. <div class="section-method">
  418. <a name="//api/name/resultSetWithStatement:usingParentDatabase:" title="resultSetWithStatement:usingParentDatabase:"></a>
  419. <h3 class="subsubtitle method-title">resultSetWithStatement:usingParentDatabase:</h3>
  420. <div class="method-subsection brief-description">
  421. <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p>
  422. </div>
  423. <div class="method-subsection method-declaration"><code>+ (instancetype)resultSetWithStatement:(FMStatement *)<em>statement</em> usingParentDatabase:(FMDatabase *)<em>aDB</em></code></div>
  424. <div class="method-subsection arguments-section parameters">
  425. <h4 class="method-subtitle parameter-title">Parameters</h4>
  426. <dl class="argument-def parameter-def">
  427. <dt><em>statement</em></dt>
  428. <dd><p>A <a href="../Classes/FMStatement.html"><code>FMStatement</code></a> to be performed</p></dd>
  429. </dl>
  430. <dl class="argument-def parameter-def">
  431. <dt><em>aDB</em></dt>
  432. <dd><p>A <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> to be used</p></dd>
  433. </dl>
  434. </div>
  435. <div class="method-subsection return">
  436. <h4 class="method-subtitle parameter-title">Return Value</h4>
  437. <p>A <code>FMResultSet</code> on success; <code>nil</code> on failure</p>
  438. </div>
  439. <div class="method-subsection declared-in-section">
  440. <h4 class="method-subtitle">Declared In</h4>
  441. <code class="declared-in-ref">FMResultSet.h</code><br />
  442. </div>
  443. </div>
  444. </div>
  445. <div class="section section-methods">
  446. <a title="Instance Methods" name="instance_methods"></a>
  447. <h2 class="subtitle subtitle-methods">Instance Methods</h2>
  448. <div class="section-method">
  449. <a name="//api/name/UTF8StringForColumnIndex:" title="UTF8StringForColumnIndex:"></a>
  450. <h3 class="subsubtitle method-title">UTF8StringForColumnIndex:</h3>
  451. <div class="method-subsection brief-description">
  452. <p>Result set <code>(const unsigned char *)</code> value for column.</p>
  453. </div>
  454. <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnIndex:(int)<em>columnIdx</em></code></div>
  455. <div class="method-subsection arguments-section parameters">
  456. <h4 class="method-subtitle parameter-title">Parameters</h4>
  457. <dl class="argument-def parameter-def">
  458. <dt><em>columnIdx</em></dt>
  459. <dd><p>Zero-based index for column.</p></dd>
  460. </dl>
  461. </div>
  462. <div class="method-subsection return">
  463. <h4 class="method-subtitle parameter-title">Return Value</h4>
  464. <p><code>(const unsigned char *)</code> value of the result set&rsquo;s column.</p>
  465. </div>
  466. <div class="method-subsection declared-in-section">
  467. <h4 class="method-subtitle">Declared In</h4>
  468. <code class="declared-in-ref">FMResultSet.h</code><br />
  469. </div>
  470. </div>
  471. <div class="section-method">
  472. <a name="//api/name/UTF8StringForColumnName:" title="UTF8StringForColumnName:"></a>
  473. <h3 class="subsubtitle method-title">UTF8StringForColumnName:</h3>
  474. <div class="method-subsection brief-description">
  475. <p>Result set <code>(const unsigned char *)</code> value for column.</p>
  476. </div>
  477. <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnName:(NSString *)<em>columnName</em></code></div>
  478. <div class="method-subsection arguments-section parameters">
  479. <h4 class="method-subtitle parameter-title">Parameters</h4>
  480. <dl class="argument-def parameter-def">
  481. <dt><em>columnName</em></dt>
  482. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  483. </dl>
  484. </div>
  485. <div class="method-subsection return">
  486. <h4 class="method-subtitle parameter-title">Return Value</h4>
  487. <p><code>(const unsigned char *)</code> value of the result set&rsquo;s column.</p>
  488. </div>
  489. <div class="method-subsection declared-in-section">
  490. <h4 class="method-subtitle">Declared In</h4>
  491. <code class="declared-in-ref">FMResultSet.h</code><br />
  492. </div>
  493. </div>
  494. <div class="section-method">
  495. <a name="//api/name/boolForColumn:" title="boolForColumn:"></a>
  496. <h3 class="subsubtitle method-title">boolForColumn:</h3>
  497. <div class="method-subsection brief-description">
  498. <p>Result set <code>BOOL</code> value for column.</p>
  499. </div>
  500. <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumn:(NSString *)<em>columnName</em></code></div>
  501. <div class="method-subsection arguments-section parameters">
  502. <h4 class="method-subtitle parameter-title">Parameters</h4>
  503. <dl class="argument-def parameter-def">
  504. <dt><em>columnName</em></dt>
  505. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  506. </dl>
  507. </div>
  508. <div class="method-subsection return">
  509. <h4 class="method-subtitle parameter-title">Return Value</h4>
  510. <p><code>BOOL</code> value of the result set&rsquo;s column.</p>
  511. </div>
  512. <div class="method-subsection declared-in-section">
  513. <h4 class="method-subtitle">Declared In</h4>
  514. <code class="declared-in-ref">FMResultSet.h</code><br />
  515. </div>
  516. </div>
  517. <div class="section-method">
  518. <a name="//api/name/boolForColumnIndex:" title="boolForColumnIndex:"></a>
  519. <h3 class="subsubtitle method-title">boolForColumnIndex:</h3>
  520. <div class="method-subsection brief-description">
  521. <p>Result set <code>BOOL</code> value for column.</p>
  522. </div>
  523. <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumnIndex:(int)<em>columnIdx</em></code></div>
  524. <div class="method-subsection arguments-section parameters">
  525. <h4 class="method-subtitle parameter-title">Parameters</h4>
  526. <dl class="argument-def parameter-def">
  527. <dt><em>columnIdx</em></dt>
  528. <dd><p>Zero-based index for column.</p></dd>
  529. </dl>
  530. </div>
  531. <div class="method-subsection return">
  532. <h4 class="method-subtitle parameter-title">Return Value</h4>
  533. <p><code>BOOL</code> value of the result set&rsquo;s column.</p>
  534. </div>
  535. <div class="method-subsection declared-in-section">
  536. <h4 class="method-subtitle">Declared In</h4>
  537. <code class="declared-in-ref">FMResultSet.h</code><br />
  538. </div>
  539. </div>
  540. <div class="section-method">
  541. <a name="//api/name/close" title="close"></a>
  542. <h3 class="subsubtitle method-title">close</h3>
  543. <div class="method-subsection brief-description">
  544. <p>Close result set</p>
  545. </div>
  546. <div class="method-subsection method-declaration"><code>- (void)close</code></div>
  547. <div class="method-subsection declared-in-section">
  548. <h4 class="method-subtitle">Declared In</h4>
  549. <code class="declared-in-ref">FMResultSet.h</code><br />
  550. </div>
  551. </div>
  552. <div class="section-method">
  553. <a name="//api/name/columnCount" title="columnCount"></a>
  554. <h3 class="subsubtitle method-title">columnCount</h3>
  555. <div class="method-subsection brief-description">
  556. <p>How many columns in result set</p>
  557. </div>
  558. <div class="method-subsection method-declaration"><code>- (int)columnCount</code></div>
  559. <div class="method-subsection return">
  560. <h4 class="method-subtitle parameter-title">Return Value</h4>
  561. <p>Integer value of the number of columns.</p>
  562. </div>
  563. <div class="method-subsection declared-in-section">
  564. <h4 class="method-subtitle">Declared In</h4>
  565. <code class="declared-in-ref">FMResultSet.h</code><br />
  566. </div>
  567. </div>
  568. <div class="section-method">
  569. <a name="//api/name/columnIndexForName:" title="columnIndexForName:"></a>
  570. <h3 class="subsubtitle method-title">columnIndexForName:</h3>
  571. <div class="method-subsection brief-description">
  572. <p>Column index for column name</p>
  573. </div>
  574. <div class="method-subsection method-declaration"><code>- (int)columnIndexForName:(NSString *)<em>columnName</em></code></div>
  575. <div class="method-subsection arguments-section parameters">
  576. <h4 class="method-subtitle parameter-title">Parameters</h4>
  577. <dl class="argument-def parameter-def">
  578. <dt><em>columnName</em></dt>
  579. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  580. </dl>
  581. </div>
  582. <div class="method-subsection return">
  583. <h4 class="method-subtitle parameter-title">Return Value</h4>
  584. <p>Zero-based index for column.</p>
  585. </div>
  586. <div class="method-subsection declared-in-section">
  587. <h4 class="method-subtitle">Declared In</h4>
  588. <code class="declared-in-ref">FMResultSet.h</code><br />
  589. </div>
  590. </div>
  591. <div class="section-method">
  592. <a name="//api/name/columnIndexIsNull:" title="columnIndexIsNull:"></a>
  593. <h3 class="subsubtitle method-title">columnIndexIsNull:</h3>
  594. <div class="method-subsection brief-description">
  595. <p>Is the column <code>NULL</code>?</p>
  596. </div>
  597. <div class="method-subsection method-declaration"><code>- (BOOL)columnIndexIsNull:(int)<em>columnIdx</em></code></div>
  598. <div class="method-subsection arguments-section parameters">
  599. <h4 class="method-subtitle parameter-title">Parameters</h4>
  600. <dl class="argument-def parameter-def">
  601. <dt><em>columnIdx</em></dt>
  602. <dd><p>Zero-based index for column.</p></dd>
  603. </dl>
  604. </div>
  605. <div class="method-subsection return">
  606. <h4 class="method-subtitle parameter-title">Return Value</h4>
  607. <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p>
  608. </div>
  609. <div class="method-subsection declared-in-section">
  610. <h4 class="method-subtitle">Declared In</h4>
  611. <code class="declared-in-ref">FMResultSet.h</code><br />
  612. </div>
  613. </div>
  614. <div class="section-method">
  615. <a name="//api/name/columnIsNull:" title="columnIsNull:"></a>
  616. <h3 class="subsubtitle method-title">columnIsNull:</h3>
  617. <div class="method-subsection brief-description">
  618. <p>Is the column <code>NULL</code>?</p>
  619. </div>
  620. <div class="method-subsection method-declaration"><code>- (BOOL)columnIsNull:(NSString *)<em>columnName</em></code></div>
  621. <div class="method-subsection arguments-section parameters">
  622. <h4 class="method-subtitle parameter-title">Parameters</h4>
  623. <dl class="argument-def parameter-def">
  624. <dt><em>columnName</em></dt>
  625. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  626. </dl>
  627. </div>
  628. <div class="method-subsection return">
  629. <h4 class="method-subtitle parameter-title">Return Value</h4>
  630. <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p>
  631. </div>
  632. <div class="method-subsection declared-in-section">
  633. <h4 class="method-subtitle">Declared In</h4>
  634. <code class="declared-in-ref">FMResultSet.h</code><br />
  635. </div>
  636. </div>
  637. <div class="section-method">
  638. <a name="//api/name/columnNameForIndex:" title="columnNameForIndex:"></a>
  639. <h3 class="subsubtitle method-title">columnNameForIndex:</h3>
  640. <div class="method-subsection brief-description">
  641. <p>Column name for column index</p>
  642. </div>
  643. <div class="method-subsection method-declaration"><code>- (NSString *)columnNameForIndex:(int)<em>columnIdx</em></code></div>
  644. <div class="method-subsection arguments-section parameters">
  645. <h4 class="method-subtitle parameter-title">Parameters</h4>
  646. <dl class="argument-def parameter-def">
  647. <dt><em>columnIdx</em></dt>
  648. <dd><p>Zero-based index for column.</p></dd>
  649. </dl>
  650. </div>
  651. <div class="method-subsection return">
  652. <h4 class="method-subtitle parameter-title">Return Value</h4>
  653. <p>columnName <code>NSString</code> value of the name of the column.</p>
  654. </div>
  655. <div class="method-subsection declared-in-section">
  656. <h4 class="method-subtitle">Declared In</h4>
  657. <code class="declared-in-ref">FMResultSet.h</code><br />
  658. </div>
  659. </div>
  660. <div class="section-method">
  661. <a name="//api/name/columnNameToIndexMap" title="columnNameToIndexMap"></a>
  662. <h3 class="subsubtitle method-title">columnNameToIndexMap</h3>
  663. <div class="method-subsection brief-description">
  664. <p><code>NSMutableDictionary</code> mapping column names to numeric index</p>
  665. </div>
  666. <div class="method-subsection method-declaration"><code>- (NSMutableDictionary *)columnNameToIndexMap</code></div>
  667. <div class="method-subsection declared-in-section">
  668. <h4 class="method-subtitle">Declared In</h4>
  669. <code class="declared-in-ref">FMResultSet.h</code><br />
  670. </div>
  671. </div>
  672. <div class="section-method">
  673. <a name="//api/name/dataForColumn:" title="dataForColumn:"></a>
  674. <h3 class="subsubtitle method-title">dataForColumn:</h3>
  675. <div class="method-subsection brief-description">
  676. <p>Result set <code>NSData</code> value for column.</p>
  677. </div>
  678. <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumn:(NSString *)<em>columnName</em></code></div>
  679. <div class="method-subsection arguments-section parameters">
  680. <h4 class="method-subtitle parameter-title">Parameters</h4>
  681. <dl class="argument-def parameter-def">
  682. <dt><em>columnName</em></dt>
  683. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  684. </dl>
  685. </div>
  686. <div class="method-subsection return">
  687. <h4 class="method-subtitle parameter-title">Return Value</h4>
  688. <p><code>NSData</code> value of the result set&rsquo;s column.</p>
  689. </div>
  690. <div class="method-subsection discussion-section">
  691. <h4 class="method-subtitle">Discussion</h4>
  692. <p>This is useful when storing binary data in table (such as image or the like).</p>
  693. </div>
  694. <div class="method-subsection declared-in-section">
  695. <h4 class="method-subtitle">Declared In</h4>
  696. <code class="declared-in-ref">FMResultSet.h</code><br />
  697. </div>
  698. </div>
  699. <div class="section-method">
  700. <a name="//api/name/dataForColumnIndex:" title="dataForColumnIndex:"></a>
  701. <h3 class="subsubtitle method-title">dataForColumnIndex:</h3>
  702. <div class="method-subsection brief-description">
  703. <p>Result set <code>NSData</code> value for column.</p>
  704. </div>
  705. <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumnIndex:(int)<em>columnIdx</em></code></div>
  706. <div class="method-subsection arguments-section parameters">
  707. <h4 class="method-subtitle parameter-title">Parameters</h4>
  708. <dl class="argument-def parameter-def">
  709. <dt><em>columnIdx</em></dt>
  710. <dd><p>Zero-based index for column.</p></dd>
  711. </dl>
  712. </div>
  713. <div class="method-subsection return">
  714. <h4 class="method-subtitle parameter-title">Return Value</h4>
  715. <p><code>NSData</code> value of the result set&rsquo;s column.</p>
  716. </div>
  717. <div class="method-subsection declared-in-section">
  718. <h4 class="method-subtitle">Declared In</h4>
  719. <code class="declared-in-ref">FMResultSet.h</code><br />
  720. </div>
  721. </div>
  722. <div class="section-method">
  723. <a name="//api/name/dataNoCopyForColumn:" title="dataNoCopyForColumn:"></a>
  724. <h3 class="subsubtitle method-title">dataNoCopyForColumn:</h3>
  725. <div class="method-subsection brief-description">
  726. <p>Result set <code>NSData</code> value for column.</p>
  727. </div>
  728. <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumn:(NSString *)<em>columnName</em></code></div>
  729. <div class="method-subsection arguments-section parameters">
  730. <h4 class="method-subtitle parameter-title">Parameters</h4>
  731. <dl class="argument-def parameter-def">
  732. <dt><em>columnName</em></dt>
  733. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  734. </dl>
  735. </div>
  736. <div class="method-subsection return">
  737. <h4 class="method-subtitle parameter-title">Return Value</h4>
  738. <p><code>NSData</code> value of the result set&rsquo;s column.</p>
  739. </div>
  740. <div class="method-subsection discussion-section">
  741. <h4 class="method-subtitle">Discussion</h4>
  742. <div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the
  743. result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>)
  744. If you don&rsquo;t, you&rsquo;re going to be in a world of hurt when you try and use the data.</p></div>
  745. </div>
  746. <div class="method-subsection declared-in-section">
  747. <h4 class="method-subtitle">Declared In</h4>
  748. <code class="declared-in-ref">FMResultSet.h</code><br />
  749. </div>
  750. </div>
  751. <div class="section-method">
  752. <a name="//api/name/dataNoCopyForColumnIndex:" title="dataNoCopyForColumnIndex:"></a>
  753. <h3 class="subsubtitle method-title">dataNoCopyForColumnIndex:</h3>
  754. <div class="method-subsection brief-description">
  755. <p>Result set <code>NSData</code> value for column.</p>
  756. </div>
  757. <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumnIndex:(int)<em>columnIdx</em></code></div>
  758. <div class="method-subsection arguments-section parameters">
  759. <h4 class="method-subtitle parameter-title">Parameters</h4>
  760. <dl class="argument-def parameter-def">
  761. <dt><em>columnIdx</em></dt>
  762. <dd><p>Zero-based index for column.</p></dd>
  763. </dl>
  764. </div>
  765. <div class="method-subsection return">
  766. <h4 class="method-subtitle parameter-title">Return Value</h4>
  767. <p><code>NSData</code> value of the result set&rsquo;s column.</p>
  768. </div>
  769. <div class="method-subsection discussion-section">
  770. <h4 class="method-subtitle">Discussion</h4>
  771. <div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the
  772. result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>)
  773. If you don&rsquo;t, you&rsquo;re going to be in a world of hurt when you try and use the data.</p></div>
  774. </div>
  775. <div class="method-subsection declared-in-section">
  776. <h4 class="method-subtitle">Declared In</h4>
  777. <code class="declared-in-ref">FMResultSet.h</code><br />
  778. </div>
  779. </div>
  780. <div class="section-method">
  781. <a name="//api/name/dateForColumn:" title="dateForColumn:"></a>
  782. <h3 class="subsubtitle method-title">dateForColumn:</h3>
  783. <div class="method-subsection brief-description">
  784. <p>Result set <code>NSDate</code> value for column.</p>
  785. </div>
  786. <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumn:(NSString *)<em>columnName</em></code></div>
  787. <div class="method-subsection arguments-section parameters">
  788. <h4 class="method-subtitle parameter-title">Parameters</h4>
  789. <dl class="argument-def parameter-def">
  790. <dt><em>columnName</em></dt>
  791. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  792. </dl>
  793. </div>
  794. <div class="method-subsection return">
  795. <h4 class="method-subtitle parameter-title">Return Value</h4>
  796. <p><code>NSDate</code> value of the result set&rsquo;s column.</p>
  797. </div>
  798. <div class="method-subsection declared-in-section">
  799. <h4 class="method-subtitle">Declared In</h4>
  800. <code class="declared-in-ref">FMResultSet.h</code><br />
  801. </div>
  802. </div>
  803. <div class="section-method">
  804. <a name="//api/name/dateForColumnIndex:" title="dateForColumnIndex:"></a>
  805. <h3 class="subsubtitle method-title">dateForColumnIndex:</h3>
  806. <div class="method-subsection brief-description">
  807. <p>Result set <code>NSDate</code> value for column.</p>
  808. </div>
  809. <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumnIndex:(int)<em>columnIdx</em></code></div>
  810. <div class="method-subsection arguments-section parameters">
  811. <h4 class="method-subtitle parameter-title">Parameters</h4>
  812. <dl class="argument-def parameter-def">
  813. <dt><em>columnIdx</em></dt>
  814. <dd><p>Zero-based index for column.</p></dd>
  815. </dl>
  816. </div>
  817. <div class="method-subsection return">
  818. <h4 class="method-subtitle parameter-title">Return Value</h4>
  819. <p><code>NSDate</code> value of the result set&rsquo;s column.</p>
  820. </div>
  821. <div class="method-subsection declared-in-section">
  822. <h4 class="method-subtitle">Declared In</h4>
  823. <code class="declared-in-ref">FMResultSet.h</code><br />
  824. </div>
  825. </div>
  826. <div class="section-method">
  827. <a name="//api/name/doubleForColumn:" title="doubleForColumn:"></a>
  828. <h3 class="subsubtitle method-title">doubleForColumn:</h3>
  829. <div class="method-subsection brief-description">
  830. <p>Result set <code>double</code> value for column.</p>
  831. </div>
  832. <div class="method-subsection method-declaration"><code>- (double)doubleForColumn:(NSString *)<em>columnName</em></code></div>
  833. <div class="method-subsection arguments-section parameters">
  834. <h4 class="method-subtitle parameter-title">Parameters</h4>
  835. <dl class="argument-def parameter-def">
  836. <dt><em>columnName</em></dt>
  837. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  838. </dl>
  839. </div>
  840. <div class="method-subsection return">
  841. <h4 class="method-subtitle parameter-title">Return Value</h4>
  842. <p><code>double</code> value of the result set&rsquo;s column.</p>
  843. </div>
  844. <div class="method-subsection declared-in-section">
  845. <h4 class="method-subtitle">Declared In</h4>
  846. <code class="declared-in-ref">FMResultSet.h</code><br />
  847. </div>
  848. </div>
  849. <div class="section-method">
  850. <a name="//api/name/doubleForColumnIndex:" title="doubleForColumnIndex:"></a>
  851. <h3 class="subsubtitle method-title">doubleForColumnIndex:</h3>
  852. <div class="method-subsection brief-description">
  853. <p>Result set <code>double</code> value for column.</p>
  854. </div>
  855. <div class="method-subsection method-declaration"><code>- (double)doubleForColumnIndex:(int)<em>columnIdx</em></code></div>
  856. <div class="method-subsection arguments-section parameters">
  857. <h4 class="method-subtitle parameter-title">Parameters</h4>
  858. <dl class="argument-def parameter-def">
  859. <dt><em>columnIdx</em></dt>
  860. <dd><p>Zero-based index for column.</p></dd>
  861. </dl>
  862. </div>
  863. <div class="method-subsection return">
  864. <h4 class="method-subtitle parameter-title">Return Value</h4>
  865. <p><code>double</code> value of the result set&rsquo;s column.</p>
  866. </div>
  867. <div class="method-subsection declared-in-section">
  868. <h4 class="method-subtitle">Declared In</h4>
  869. <code class="declared-in-ref">FMResultSet.h</code><br />
  870. </div>
  871. </div>
  872. <div class="section-method">
  873. <a name="//api/name/hasAnotherRow" title="hasAnotherRow"></a>
  874. <h3 class="subsubtitle method-title">hasAnotherRow</h3>
  875. <div class="method-subsection brief-description">
  876. <p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p>
  877. </div>
  878. <div class="method-subsection method-declaration"><code>- (BOOL)hasAnotherRow</code></div>
  879. <div class="method-subsection return">
  880. <h4 class="method-subtitle parameter-title">Return Value</h4>
  881. <p><code>YES</code> if the last call to <a href="#//api/name/next"><code>next</code></a> succeeded in retrieving another record; <code>NO</code> if not.</p>
  882. </div>
  883. <div class="method-subsection discussion-section">
  884. <h4 class="method-subtitle">Discussion</h4>
  885. <div class="warning"><p><strong>Warning:</strong> The <code>hasAnotherRow</code> method must follow a call to <a href="#//api/name/next"><code>next</code></a>. If the previous database interaction was something other than a call to <code>next</code>, then this method may return <code>NO</code>, whether there is another row of data or not.</p></div>
  886. </div>
  887. <div class="method-subsection see-also-section">
  888. <h4 class="method-subtitle">See Also</h4>
  889. <ul>
  890. <li><code><p><a href="#//api/name/next">- next</a></p></code></li>
  891. </ul>
  892. </div>
  893. <div class="method-subsection declared-in-section">
  894. <h4 class="method-subtitle">Declared In</h4>
  895. <code class="declared-in-ref">FMResultSet.h</code><br />
  896. </div>
  897. </div>
  898. <div class="section-method">
  899. <a name="//api/name/intForColumn:" title="intForColumn:"></a>
  900. <h3 class="subsubtitle method-title">intForColumn:</h3>
  901. <div class="method-subsection brief-description">
  902. <p>Result set integer value for column.</p>
  903. </div>
  904. <div class="method-subsection method-declaration"><code>- (int)intForColumn:(NSString *)<em>columnName</em></code></div>
  905. <div class="method-subsection arguments-section parameters">
  906. <h4 class="method-subtitle parameter-title">Parameters</h4>
  907. <dl class="argument-def parameter-def">
  908. <dt><em>columnName</em></dt>
  909. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  910. </dl>
  911. </div>
  912. <div class="method-subsection return">
  913. <h4 class="method-subtitle parameter-title">Return Value</h4>
  914. <p><code>int</code> value of the result set&rsquo;s column.</p>
  915. </div>
  916. <div class="method-subsection declared-in-section">
  917. <h4 class="method-subtitle">Declared In</h4>
  918. <code class="declared-in-ref">FMResultSet.h</code><br />
  919. </div>
  920. </div>
  921. <div class="section-method">
  922. <a name="//api/name/intForColumnIndex:" title="intForColumnIndex:"></a>
  923. <h3 class="subsubtitle method-title">intForColumnIndex:</h3>
  924. <div class="method-subsection brief-description">
  925. <p>Result set integer value for column.</p>
  926. </div>
  927. <div class="method-subsection method-declaration"><code>- (int)intForColumnIndex:(int)<em>columnIdx</em></code></div>
  928. <div class="method-subsection arguments-section parameters">
  929. <h4 class="method-subtitle parameter-title">Parameters</h4>
  930. <dl class="argument-def parameter-def">
  931. <dt><em>columnIdx</em></dt>
  932. <dd><p>Zero-based index for column.</p></dd>
  933. </dl>
  934. </div>
  935. <div class="method-subsection return">
  936. <h4 class="method-subtitle parameter-title">Return Value</h4>
  937. <p><code>int</code> value of the result set&rsquo;s column.</p>
  938. </div>
  939. <div class="method-subsection declared-in-section">
  940. <h4 class="method-subtitle">Declared In</h4>
  941. <code class="declared-in-ref">FMResultSet.h</code><br />
  942. </div>
  943. </div>
  944. <div class="section-method">
  945. <a name="//api/name/kvcMagic:" title="kvcMagic:"></a>
  946. <h3 class="subsubtitle method-title">kvcMagic:</h3>
  947. <div class="method-subsection brief-description">
  948. <p>Performs <code>setValue</code> to yield support for key value observing.</p>
  949. </div>
  950. <div class="method-subsection method-declaration"><code>- (void)kvcMagic:(id)<em>object</em></code></div>
  951. <div class="method-subsection arguments-section parameters">
  952. <h4 class="method-subtitle parameter-title">Parameters</h4>
  953. <dl class="argument-def parameter-def">
  954. <dt><em>object</em></dt>
  955. <dd><p>The object for which the values will be set. This is the key-value-coding compliant object that you might, for example, observe.</p></dd>
  956. </dl>
  957. </div>
  958. <div class="method-subsection declared-in-section">
  959. <h4 class="method-subtitle">Declared In</h4>
  960. <code class="declared-in-ref">FMResultSet.h</code><br />
  961. </div>
  962. </div>
  963. <div class="section-method">
  964. <a name="//api/name/longForColumn:" title="longForColumn:"></a>
  965. <h3 class="subsubtitle method-title">longForColumn:</h3>
  966. <div class="method-subsection brief-description">
  967. <p>Result set <code>long</code> value for column.</p>
  968. </div>
  969. <div class="method-subsection method-declaration"><code>- (long)longForColumn:(NSString *)<em>columnName</em></code></div>
  970. <div class="method-subsection arguments-section parameters">
  971. <h4 class="method-subtitle parameter-title">Parameters</h4>
  972. <dl class="argument-def parameter-def">
  973. <dt><em>columnName</em></dt>
  974. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  975. </dl>
  976. </div>
  977. <div class="method-subsection return">
  978. <h4 class="method-subtitle parameter-title">Return Value</h4>
  979. <p><code>long</code> value of the result set&rsquo;s column.</p>
  980. </div>
  981. <div class="method-subsection declared-in-section">
  982. <h4 class="method-subtitle">Declared In</h4>
  983. <code class="declared-in-ref">FMResultSet.h</code><br />
  984. </div>
  985. </div>
  986. <div class="section-method">
  987. <a name="//api/name/longForColumnIndex:" title="longForColumnIndex:"></a>
  988. <h3 class="subsubtitle method-title">longForColumnIndex:</h3>
  989. <div class="method-subsection brief-description">
  990. <p>Result set long value for column.</p>
  991. </div>
  992. <div class="method-subsection method-declaration"><code>- (long)longForColumnIndex:(int)<em>columnIdx</em></code></div>
  993. <div class="method-subsection arguments-section parameters">
  994. <h4 class="method-subtitle parameter-title">Parameters</h4>
  995. <dl class="argument-def parameter-def">
  996. <dt><em>columnIdx</em></dt>
  997. <dd><p>Zero-based index for column.</p></dd>
  998. </dl>
  999. </div>
  1000. <div class="method-subsection return">
  1001. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1002. <p><code>long</code> value of the result set&rsquo;s column.</p>
  1003. </div>
  1004. <div class="method-subsection declared-in-section">
  1005. <h4 class="method-subtitle">Declared In</h4>
  1006. <code class="declared-in-ref">FMResultSet.h</code><br />
  1007. </div>
  1008. </div>
  1009. <div class="section-method">
  1010. <a name="//api/name/longLongIntForColumn:" title="longLongIntForColumn:"></a>
  1011. <h3 class="subsubtitle method-title">longLongIntForColumn:</h3>
  1012. <div class="method-subsection brief-description">
  1013. <p>Result set <code>long long int</code> value for column.</p>
  1014. </div>
  1015. <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumn:(NSString *)<em>columnName</em></code></div>
  1016. <div class="method-subsection arguments-section parameters">
  1017. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1018. <dl class="argument-def parameter-def">
  1019. <dt><em>columnName</em></dt>
  1020. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  1021. </dl>
  1022. </div>
  1023. <div class="method-subsection return">
  1024. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1025. <p><code>long long int</code> value of the result set&rsquo;s column.</p>
  1026. </div>
  1027. <div class="method-subsection declared-in-section">
  1028. <h4 class="method-subtitle">Declared In</h4>
  1029. <code class="declared-in-ref">FMResultSet.h</code><br />
  1030. </div>
  1031. </div>
  1032. <div class="section-method">
  1033. <a name="//api/name/longLongIntForColumnIndex:" title="longLongIntForColumnIndex:"></a>
  1034. <h3 class="subsubtitle method-title">longLongIntForColumnIndex:</h3>
  1035. <div class="method-subsection brief-description">
  1036. <p>Result set <code>long long int</code> value for column.</p>
  1037. </div>
  1038. <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumnIndex:(int)<em>columnIdx</em></code></div>
  1039. <div class="method-subsection arguments-section parameters">
  1040. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1041. <dl class="argument-def parameter-def">
  1042. <dt><em>columnIdx</em></dt>
  1043. <dd><p>Zero-based index for column.</p></dd>
  1044. </dl>
  1045. </div>
  1046. <div class="method-subsection return">
  1047. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1048. <p><code>long long int</code> value of the result set&rsquo;s column.</p>
  1049. </div>
  1050. <div class="method-subsection declared-in-section">
  1051. <h4 class="method-subtitle">Declared In</h4>
  1052. <code class="declared-in-ref">FMResultSet.h</code><br />
  1053. </div>
  1054. </div>
  1055. <div class="section-method">
  1056. <a name="//api/name/next" title="next"></a>
  1057. <h3 class="subsubtitle method-title">next</h3>
  1058. <div class="method-subsection brief-description">
  1059. <p>Retrieve next row for result set.</p>
  1060. </div>
  1061. <div class="method-subsection method-declaration"><code>- (BOOL)next</code></div>
  1062. <div class="method-subsection return">
  1063. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1064. <p><code>YES</code> if row successfully retrieved; <code>NO</code> if end of result set reached</p>
  1065. </div>
  1066. <div class="method-subsection discussion-section">
  1067. <h4 class="method-subtitle">Discussion</h4>
  1068. <p>You must always invoke <code>next</code> before attempting to access the values returned in a query, even if you&rsquo;re only expecting one.</p>
  1069. </div>
  1070. <div class="method-subsection see-also-section">
  1071. <h4 class="method-subtitle">See Also</h4>
  1072. <ul>
  1073. <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li>
  1074. </ul>
  1075. </div>
  1076. <div class="method-subsection declared-in-section">
  1077. <h4 class="method-subtitle">Declared In</h4>
  1078. <code class="declared-in-ref">FMResultSet.h</code><br />
  1079. </div>
  1080. </div>
  1081. <div class="section-method">
  1082. <a name="//api/name/objectAtIndexedSubscript:" title="objectAtIndexedSubscript:"></a>
  1083. <h3 class="subsubtitle method-title">objectAtIndexedSubscript:</h3>
  1084. <div class="method-subsection brief-description">
  1085. <p>Result set object for column.</p>
  1086. </div>
  1087. <div class="method-subsection method-declaration"><code>- (id)objectAtIndexedSubscript:(int)<em>columnIdx</em></code></div>
  1088. <div class="method-subsection arguments-section parameters">
  1089. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1090. <dl class="argument-def parameter-def">
  1091. <dt><em>columnIdx</em></dt>
  1092. <dd><p>Zero-based index for column.</p></dd>
  1093. </dl>
  1094. </div>
  1095. <div class="method-subsection return">
  1096. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1097. <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p>
  1098. </div>
  1099. <div class="method-subsection discussion-section">
  1100. <h4 class="method-subtitle">Discussion</h4>
  1101. <p>This method allows the use of the &ldquo;boxed&rdquo; syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p>
  1102. <pre><code>id result = rs[0];
  1103. </code></pre>
  1104. <p>This simplified syntax is equivalent to calling:</p>
  1105. <pre><code>id result = [rs objectForKeyedSubscript:0];
  1106. </code></pre>
  1107. <p>which is, it turns out, equivalent to calling:</p>
  1108. <pre><code>id result = [rs objectForColumnName:0];
  1109. </code></pre>
  1110. </div>
  1111. <div class="method-subsection declared-in-section">
  1112. <h4 class="method-subtitle">Declared In</h4>
  1113. <code class="declared-in-ref">FMResultSet.h</code><br />
  1114. </div>
  1115. </div>
  1116. <div class="section-method">
  1117. <a name="//api/name/objectForColumnIndex:" title="objectForColumnIndex:"></a>
  1118. <h3 class="subsubtitle method-title">objectForColumnIndex:</h3>
  1119. <div class="method-subsection brief-description">
  1120. <p>Result set object for column.</p>
  1121. </div>
  1122. <div class="method-subsection method-declaration"><code>- (id)objectForColumnIndex:(int)<em>columnIdx</em></code></div>
  1123. <div class="method-subsection arguments-section parameters">
  1124. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1125. <dl class="argument-def parameter-def">
  1126. <dt><em>columnIdx</em></dt>
  1127. <dd><p>Zero-based index for column.</p></dd>
  1128. </dl>
  1129. </div>
  1130. <div class="method-subsection return">
  1131. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1132. <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p>
  1133. </div>
  1134. <div class="method-subsection see-also-section">
  1135. <h4 class="method-subtitle">See Also</h4>
  1136. <ul>
  1137. <li><code><p><a href="#//api/name/objectAtIndexedSubscript:">- objectAtIndexedSubscript:</a></p></code></li>
  1138. </ul>
  1139. </div>
  1140. <div class="method-subsection declared-in-section">
  1141. <h4 class="method-subtitle">Declared In</h4>
  1142. <code class="declared-in-ref">FMResultSet.h</code><br />
  1143. </div>
  1144. </div>
  1145. <div class="section-method">
  1146. <a name="//api/name/objectForColumnName:" title="objectForColumnName:"></a>
  1147. <h3 class="subsubtitle method-title">objectForColumnName:</h3>
  1148. <div class="method-subsection brief-description">
  1149. <p>Result set object for column.</p>
  1150. </div>
  1151. <div class="method-subsection method-declaration"><code>- (id)objectForColumnName:(NSString *)<em>columnName</em></code></div>
  1152. <div class="method-subsection arguments-section parameters">
  1153. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1154. <dl class="argument-def parameter-def">
  1155. <dt><em>columnName</em></dt>
  1156. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  1157. </dl>
  1158. </div>
  1159. <div class="method-subsection return">
  1160. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1161. <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p>
  1162. </div>
  1163. <div class="method-subsection see-also-section">
  1164. <h4 class="method-subtitle">See Also</h4>
  1165. <ul>
  1166. <li><code><p><a href="#//api/name/objectForKeyedSubscript:">- objectForKeyedSubscript:</a></p></code></li>
  1167. </ul>
  1168. </div>
  1169. <div class="method-subsection declared-in-section">
  1170. <h4 class="method-subtitle">Declared In</h4>
  1171. <code class="declared-in-ref">FMResultSet.h</code><br />
  1172. </div>
  1173. </div>
  1174. <div class="section-method">
  1175. <a name="//api/name/objectForKeyedSubscript:" title="objectForKeyedSubscript:"></a>
  1176. <h3 class="subsubtitle method-title">objectForKeyedSubscript:</h3>
  1177. <div class="method-subsection brief-description">
  1178. <p>Result set object for column.</p>
  1179. </div>
  1180. <div class="method-subsection method-declaration"><code>- (id)objectForKeyedSubscript:(NSString *)<em>columnName</em></code></div>
  1181. <div class="method-subsection arguments-section parameters">
  1182. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1183. <dl class="argument-def parameter-def">
  1184. <dt><em>columnName</em></dt>
  1185. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  1186. </dl>
  1187. </div>
  1188. <div class="method-subsection return">
  1189. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1190. <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p>
  1191. </div>
  1192. <div class="method-subsection discussion-section">
  1193. <h4 class="method-subtitle">Discussion</h4>
  1194. <p>This method allows the use of the &ldquo;boxed&rdquo; syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p>
  1195. <pre><code>id result = rs[@"employee_name"];
  1196. </code></pre>
  1197. <p>This simplified syntax is equivalent to calling:</p>
  1198. <pre><code>id result = [rs objectForKeyedSubscript:@"employee_name"];
  1199. </code></pre>
  1200. <p>which is, it turns out, equivalent to calling:</p>
  1201. <pre><code>id result = [rs objectForColumnName:@"employee_name"];
  1202. </code></pre>
  1203. </div>
  1204. <div class="method-subsection declared-in-section">
  1205. <h4 class="method-subtitle">Declared In</h4>
  1206. <code class="declared-in-ref">FMResultSet.h</code><br />
  1207. </div>
  1208. </div>
  1209. <div class="section-method">
  1210. <a name="//api/name/resultDict" title="resultDict"></a>
  1211. <h3 class="subsubtitle method-title">resultDict</h3>
  1212. <div class="method-subsection brief-description">
  1213. <p>Returns a dictionary of the row results</p>
  1214. </div>
  1215. <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDict</code></div>
  1216. <div class="method-subsection discussion-section">
  1217. <h4 class="method-subtitle">Discussion</h4>
  1218. <div class="warning"><p><strong>Warning:</strong> <strong>Deprecated</strong>: Please use <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> instead. Also, beware that <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> is case sensitive!</p></div>
  1219. </div>
  1220. <div class="method-subsection see-also-section">
  1221. <h4 class="method-subtitle">See Also</h4>
  1222. <ul>
  1223. <li><code><p><a href="#//api/name/resultDictionary">- resultDictionary</a></p></code></li>
  1224. </ul>
  1225. </div>
  1226. <div class="method-subsection declared-in-section">
  1227. <h4 class="method-subtitle">Declared In</h4>
  1228. <code class="declared-in-ref">FMResultSet.h</code><br />
  1229. </div>
  1230. </div>
  1231. <div class="section-method">
  1232. <a name="//api/name/resultDictionary" title="resultDictionary"></a>
  1233. <h3 class="subsubtitle method-title">resultDictionary</h3>
  1234. <div class="method-subsection brief-description">
  1235. <p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p>
  1236. </div>
  1237. <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDictionary</code></div>
  1238. <div class="method-subsection return">
  1239. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1240. <p><code>NSDictionary</code> of the row results.</p>
  1241. </div>
  1242. <div class="method-subsection discussion-section">
  1243. <h4 class="method-subtitle">Discussion</h4>
  1244. <div class="warning"><p><strong>Warning:</strong> The keys to the dictionary are case sensitive of the column names.</p></div>
  1245. </div>
  1246. <div class="method-subsection declared-in-section">
  1247. <h4 class="method-subtitle">Declared In</h4>
  1248. <code class="declared-in-ref">FMResultSet.h</code><br />
  1249. </div>
  1250. </div>
  1251. <div class="section-method">
  1252. <a name="//api/name/stringForColumn:" title="stringForColumn:"></a>
  1253. <h3 class="subsubtitle method-title">stringForColumn:</h3>
  1254. <div class="method-subsection brief-description">
  1255. <p>Result set <code>NSString</code> value for column.</p>
  1256. </div>
  1257. <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumn:(NSString *)<em>columnName</em></code></div>
  1258. <div class="method-subsection arguments-section parameters">
  1259. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1260. <dl class="argument-def parameter-def">
  1261. <dt><em>columnName</em></dt>
  1262. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  1263. </dl>
  1264. </div>
  1265. <div class="method-subsection return">
  1266. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1267. <p><code>NSString</code> value of the result set&rsquo;s column.</p>
  1268. </div>
  1269. <div class="method-subsection declared-in-section">
  1270. <h4 class="method-subtitle">Declared In</h4>
  1271. <code class="declared-in-ref">FMResultSet.h</code><br />
  1272. </div>
  1273. </div>
  1274. <div class="section-method">
  1275. <a name="//api/name/stringForColumnIndex:" title="stringForColumnIndex:"></a>
  1276. <h3 class="subsubtitle method-title">stringForColumnIndex:</h3>
  1277. <div class="method-subsection brief-description">
  1278. <p>Result set <code>NSString</code> value for column.</p>
  1279. </div>
  1280. <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumnIndex:(int)<em>columnIdx</em></code></div>
  1281. <div class="method-subsection arguments-section parameters">
  1282. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1283. <dl class="argument-def parameter-def">
  1284. <dt><em>columnIdx</em></dt>
  1285. <dd><p>Zero-based index for column.</p></dd>
  1286. </dl>
  1287. </div>
  1288. <div class="method-subsection return">
  1289. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1290. <p><code>NSString</code> value of the result set&rsquo;s column.</p>
  1291. </div>
  1292. <div class="method-subsection declared-in-section">
  1293. <h4 class="method-subtitle">Declared In</h4>
  1294. <code class="declared-in-ref">FMResultSet.h</code><br />
  1295. </div>
  1296. </div>
  1297. <div class="section-method">
  1298. <a name="//api/name/unsignedLongLongIntForColumn:" title="unsignedLongLongIntForColumn:"></a>
  1299. <h3 class="subsubtitle method-title">unsignedLongLongIntForColumn:</h3>
  1300. <div class="method-subsection brief-description">
  1301. <p>Result set <code>unsigned long long int</code> value for column.</p>
  1302. </div>
  1303. <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumn:(NSString *)<em>columnName</em></code></div>
  1304. <div class="method-subsection arguments-section parameters">
  1305. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1306. <dl class="argument-def parameter-def">
  1307. <dt><em>columnName</em></dt>
  1308. <dd><p><code>NSString</code> value of the name of the column.</p></dd>
  1309. </dl>
  1310. </div>
  1311. <div class="method-subsection return">
  1312. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1313. <p><code>unsigned long long int</code> value of the result set&rsquo;s column.</p>
  1314. </div>
  1315. <div class="method-subsection declared-in-section">
  1316. <h4 class="method-subtitle">Declared In</h4>
  1317. <code class="declared-in-ref">FMResultSet.h</code><br />
  1318. </div>
  1319. </div>
  1320. <div class="section-method">
  1321. <a name="//api/name/unsignedLongLongIntForColumnIndex:" title="unsignedLongLongIntForColumnIndex:"></a>
  1322. <h3 class="subsubtitle method-title">unsignedLongLongIntForColumnIndex:</h3>
  1323. <div class="method-subsection brief-description">
  1324. <p>Result set <code>unsigned long long int</code> value for column.</p>
  1325. </div>
  1326. <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumnIndex:(int)<em>columnIdx</em></code></div>
  1327. <div class="method-subsection arguments-section parameters">
  1328. <h4 class="method-subtitle parameter-title">Parameters</h4>
  1329. <dl class="argument-def parameter-def">
  1330. <dt><em>columnIdx</em></dt>
  1331. <dd><p>Zero-based index for column.</p></dd>
  1332. </dl>
  1333. </div>
  1334. <div class="method-subsection return">
  1335. <h4 class="method-subtitle parameter-title">Return Value</h4>
  1336. <p><code>unsigned long long int</code> value of the result set&rsquo;s column.</p>
  1337. </div>
  1338. <div class="method-subsection declared-in-section">
  1339. <h4 class="method-subtitle">Declared In</h4>
  1340. <code class="declared-in-ref">FMResultSet.h</code><br />
  1341. </div>
  1342. </div>
  1343. </div>
  1344. </div>
  1345. <div class="main-navigation navigation-bottom">
  1346. <ul>
  1347. <li><a href="../index.html">Index</a></li>
  1348. <li><a href="../hierarchy.html">Hierarchy</a></li>
  1349. </ul>
  1350. </div>
  1351. <div id="footer">
  1352. <hr />
  1353. <div class="footer-copyright">
  1354. <p><span class="copyright">&copy; 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br />
  1355. <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
  1356. </div>
  1357. </div>
  1358. </div>
  1359. </article>
  1360. <script type="text/javascript">
  1361. function jumpToChange()
  1362. {
  1363. window.location.hash = this.options[this.selectedIndex].value;
  1364. }
  1365. function toggleTOC()
  1366. {
  1367. var contents = document.getElementById('contents');
  1368. var tocContainer = document.getElementById('tocContainer');
  1369. if (this.getAttribute('class') == 'open')
  1370. {
  1371. this.setAttribute('class', '');
  1372. contents.setAttribute('class', '');
  1373. tocContainer.setAttribute('class', '');
  1374. window.name = "hideTOC";
  1375. }
  1376. else
  1377. {
  1378. this.setAttribute('class', 'open');
  1379. contents.setAttribute('class', 'isShowingTOC');
  1380. tocContainer.setAttribute('class', 'isShowingTOC');
  1381. window.name = "";
  1382. }
  1383. return false;
  1384. }
  1385. function toggleTOCEntryChildren(e)
  1386. {
  1387. e.stopPropagation();
  1388. var currentClass = this.getAttribute('class');
  1389. if (currentClass == 'children') {
  1390. this.setAttribute('class', 'children open');
  1391. }
  1392. else if (currentClass == 'children open') {
  1393. this.setAttribute('class', 'children');
  1394. }
  1395. return false;
  1396. }
  1397. function tocEntryClick(e)
  1398. {
  1399. e.stopPropagation();
  1400. return true;
  1401. }
  1402. function init()
  1403. {
  1404. var selectElement = document.getElementById('jumpTo');
  1405. selectElement.addEventListener('change', jumpToChange, false);
  1406. var tocButton = document.getElementById('table_of_contents');
  1407. tocButton.addEventListener('click', toggleTOC, false);
  1408. var taskTreeItem = document.getElementById('task_treeitem');
  1409. if (taskTreeItem.getElementsByTagName('li').length > 0)
  1410. {
  1411. taskTreeItem.setAttribute('class', 'children');
  1412. taskTreeItem.firstChild.setAttribute('class', 'disclosure');
  1413. }
  1414. var tocList = document.getElementById('toc');
  1415. var tocEntries = tocList.getElementsByTagName('li');
  1416. for (var i = 0; i < tocEntries.length; i++) {
  1417. tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
  1418. }
  1419. var tocLinks = tocList.getElementsByTagName('a');
  1420. for (var i = 0; i < tocLinks.length; i++) {
  1421. tocLinks[i].addEventListener('click', tocEntryClick, false);
  1422. }
  1423. if (window.name == "hideTOC") {
  1424. toggleTOC.call(tocButton);
  1425. }
  1426. }
  1427. window.onload = init;
  1428. // If showing in Xcode, hide the TOC and Header
  1429. if (navigator.userAgent.match(/xcode/i)) {
  1430. document.getElementById("contents").className = "hideInXcode"
  1431. document.getElementById("tocContainer").className = "hideInXcode"
  1432. document.getElementById("top_header").className = "hideInXcode"
  1433. }
  1434. </script>
  1435. </body>
  1436. </html>