FMResultSet.html 75 KB

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