class_sd_fat_soft_spi.html 100 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>SdFat: SdFatSoftSpi&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  66. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. </div><!-- top -->
  82. <div class="header">
  83. <div class="summary">
  84. <a href="#pub-methods">Public Member Functions</a> &#124;
  85. <a href="class_sd_fat_soft_spi-members.html">List of all members</a> </div>
  86. <div class="headertitle">
  87. <div class="title">SdFatSoftSpi&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p><a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class using software SPI.
  91. <a href="class_sd_fat_soft_spi.html#details">More...</a></p>
  92. <p><code>#include &lt;SdFat.h&gt;</code></p>
  93. <div class="dynheader">
  94. Inheritance diagram for SdFatSoftSpi&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  95. <div class="dyncontent">
  96. <div class="center"><img src="class_sd_fat_soft_spi__inherit__graph.png" border="0" usemap="#_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" alt="Inheritance graph"/></div>
  97. <map name="_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" id="_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map">
  98. <area shape="rect" id="node2" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="43,155,130,181"/>
  99. <area shape="rect" id="node3" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="33,80,140,107"/>
  100. <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="44,5,129,32"/>
  101. </map>
  102. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  103. <div class="dynheader">
  104. Collaboration diagram for SdFatSoftSpi&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  105. <div class="dyncontent">
  106. <div class="center"><img src="class_sd_fat_soft_spi__coll__graph.png" border="0" usemap="#_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" alt="Collaboration graph"/></div>
  107. <map name="_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" id="_sd_fat_soft_spi_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map">
  108. <area shape="rect" id="node2" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="43,155,130,181"/>
  109. <area shape="rect" id="node3" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="33,80,140,107"/>
  110. <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="44,5,129,32"/>
  111. </map>
  112. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  115. Public Member Functions</h2></td></tr>
  116. <tr class="memitem:a05bd3d358a708efe2f9002d05c3a4139"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a05bd3d358a708efe2f9002d05c3a4139">begin</a> (uint8_t part=0)</td></tr>
  117. <tr class="separator:a05bd3d358a708efe2f9002d05c3a4139"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a3d3f2cc4df1b6f2a129c3a614c1e5e1f">begin</a> (<a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *spi, uint8_t csPin=SS, uint8_t divisor=2)</td></tr>
  119. <tr class="separator:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aaa99af872cd02612cf17e46b250b1192"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_soft_spi.html#aaa99af872cd02612cf17e46b250b1192">begin</a> (uint8_t csPin=SS, uint8_t divisor=2)</td></tr>
  121. <tr class="separator:aaa99af872cd02612cf17e46b250b1192"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a06beed4cea5e38116b58254a57125442"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06beed4cea5e38116b58254a57125442">blocksPerCluster</a> () const </td></tr>
  123. <tr class="separator:a06beed4cea5e38116b58254a57125442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:abc66d856d05198d9ebe7104c8c4155d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abc66d856d05198d9ebe7104c8c4155d7">blocksPerFat</a> () const </td></tr>
  125. <tr class="separator:abc66d856d05198d9ebe7104c8c4155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>
  127. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a899294ced4e4585feae7668099338534"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a899294ced4e4585feae7668099338534">card</a> ()</td></tr>
  129. <tr class="separator:a899294ced4e4585feae7668099338534"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a85a4c8a4a1aff6dc6c3cd3fb7de246dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_soft_spi.html#a85a4c8a4a1aff6dc6c3cd3fb7de246dc">cardBegin</a> (uint8_t csPin=SS, uint8_t divisor=2)</td></tr>
  131. <tr class="separator:a85a4c8a4a1aff6dc6c3cd3fb7de246dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>
  133. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>
  135. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:af24917d6e00c8766dab168eb834047ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#af24917d6e00c8766dab168eb834047ec">chvol</a> ()</td></tr>
  137. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a18446a9c5924304fa7a87d5f03ccaf21">clusterCount</a> () const </td></tr>
  139. <tr class="separator:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ac0e63f33d71d5dc95a602834274def6a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0e63f33d71d5dc95a602834274def6a">clusterSizeShift</a> () const </td></tr>
  141. <tr class="separator:ac0e63f33d71d5dc95a602834274def6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a443364af257c219f8e908d5b073d8fa3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a443364af257c219f8e908d5b073d8fa3">dataStartBlock</a> () const </td></tr>
  143. <tr class="separator:a443364af257c219f8e908d5b073d8fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  145. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a905d883dcbaa60aa35a6eb0cad63cc9e">errorHalt</a> ()</td></tr>
  147. <tr class="separator:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ae8cf95abf0ffb1c7a55eb1a192c28982">errorHalt</a> (Print *pr)</td></tr>
  149. <tr class="separator:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a07e04b976ffcaf7e9492e50c6e4900a8">errorHalt</a> (char const *msg)</td></tr>
  151. <tr class="separator:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7c52e1a1909c9aa532b8525cf721fd89">errorHalt</a> (Print *pr, char const *msg)</td></tr>
  153. <tr class="separator:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a111cecbcc7ea5c068c44051491a77a52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a111cecbcc7ea5c068c44051491a77a52">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  155. <tr class="separator:a111cecbcc7ea5c068c44051491a77a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a4c34e68605243269f96122a9cb909004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a4c34e68605243269f96122a9cb909004">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  157. <tr class="separator:a4c34e68605243269f96122a9cb909004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a2deadc5b8bcdf5710fefba39b895e008"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a2deadc5b8bcdf5710fefba39b895e008">errorPrint</a> ()</td></tr>
  159. <tr class="separator:a2deadc5b8bcdf5710fefba39b895e008"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aaa950f290e41c0ff2d62b94cb425ba12">errorPrint</a> (Print *pr)</td></tr>
  161. <tr class="separator:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a84fe32d89460471cf9f66495f545e2ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a84fe32d89460471cf9f66495f545e2ae">errorPrint</a> (const char *msg)</td></tr>
  163. <tr class="separator:a84fe32d89460471cf9f66495f545e2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a5ecc4177c65f8e2837a9ef4d17368a98">errorPrint</a> (Print *pr, char const *msg)</td></tr>
  165. <tr class="separator:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a7eed2449f96d62e87bea96c6da4f618a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7eed2449f96d62e87bea96c6da4f618a">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  167. <tr class="separator:a7eed2449f96d62e87bea96c6da4f618a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:aace11e097b69144a80a4abbca54d35b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aace11e097b69144a80a4abbca54d35b0">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  169. <tr class="separator:aace11e097b69144a80a4abbca54d35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:aee58c6352652f216577196e32a594b67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aee58c6352652f216577196e32a594b67">exists</a> (const char *path)</td></tr>
  171. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acdedc6a200b01e401c9cd9b511eae6ec">fatCount</a> ()</td></tr>
  173. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0dd0cc689b63ef0702aed1cf36b1722d">fatStartBlock</a> () const </td></tr>
  175. <tr class="separator:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1364f11fe9bb4717ce0685e2b7b86027">fatType</a> () const </td></tr>
  177. <tr class="separator:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a1683b063fc6202ab85470b9610f16f93"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1683b063fc6202ab85470b9610f16f93">freeClusterCount</a> ()</td></tr>
  179. <tr class="separator:a1683b063fc6202ab85470b9610f16f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a389f0ef6fb556c67b48ade5c0c1b3a9a">fsBegin</a> ()</td></tr>
  181. <tr class="separator:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">init</a> ()</td></tr>
  183. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>
  185. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:adbfd9264f972f054e561128bad0b267e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adbfd9264f972f054e561128bad0b267e">initErrorHalt</a> ()</td></tr>
  187. <tr class="separator:adbfd9264f972f054e561128bad0b267e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a86770dd889bffc5788172c8d34a3582c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a86770dd889bffc5788172c8d34a3582c">initErrorHalt</a> (Print *pr)</td></tr>
  189. <tr class="separator:a86770dd889bffc5788172c8d34a3582c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a0d4c851a3243c9f8c21d3894821292e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a0d4c851a3243c9f8c21d3894821292e9">initErrorHalt</a> (char const *msg)</td></tr>
  191. <tr class="separator:a0d4c851a3243c9f8c21d3894821292e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a02f18794078b7a1c9662c3ded438cff4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a02f18794078b7a1c9662c3ded438cff4">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>
  193. <tr class="separator:a02f18794078b7a1c9662c3ded438cff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:abe312251854aebf5b8d6b4f9896660ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#abe312251854aebf5b8d6b4f9896660ed">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  195. <tr class="separator:abe312251854aebf5b8d6b4f9896660ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aa93c7fec40b37e7f5dd1e362ebf5ff69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  197. <tr class="separator:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:a62a979138be1b62942f7b3f04964356e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a62a979138be1b62942f7b3f04964356e">initErrorPrint</a> ()</td></tr>
  199. <tr class="separator:a62a979138be1b62942f7b3f04964356e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:adffd5a3e802842b371b170c6df6b2530"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adffd5a3e802842b371b170c6df6b2530">initErrorPrint</a> (Print *pr)</td></tr>
  201. <tr class="separator:adffd5a3e802842b371b170c6df6b2530"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a296855ca8cc7590b9cbe7b3aeabc8467">initErrorPrint</a> (char const *msg)</td></tr>
  203. <tr class="separator:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aca07f92b3a06ede0e7a56b68b76dc3b7">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>
  205. <tr class="separator:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:a9c334faf236651db265d5acf65271666"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a9c334faf236651db265d5acf65271666">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  207. <tr class="separator:a9c334faf236651db265d5acf65271666"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:ac0b7161c1385841264323ac244f5c89c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ac0b7161c1385841264323ac244f5c89c">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  209. <tr class="separator:ac0b7161c1385841264323ac244f5c89c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a2398fb37a7a9d5e0dc0ffde6a44a993d">ls</a> (uint8_t flags=0)</td></tr>
  211. <tr class="separator:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:a122b61dbec5051304bcc81bc08b1b99d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a122b61dbec5051304bcc81bc08b1b99d">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  213. <tr class="separator:a122b61dbec5051304bcc81bc08b1b99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  215. <tr class="separator:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  217. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a231c62c98ba8ac3c2624dc5ad2053ebf">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  219. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:a947e4586077a922892b632edac33b67a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a947e4586077a922892b632edac33b67a">open</a> (const char *path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  221. <tr class="separator:a947e4586077a922892b632edac33b67a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  223. <tr class="separator:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  224. <tr class="memitem:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#abf7d7d0dab43083d5be10d70ff4669e4">remove</a> (const char *path)</td></tr>
  225. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:a0187891a24017b41bd7c5ba63e659e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  227. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:aaed2edc7ff7fedb163458c870bb41b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aaed2edc7ff7fedb163458c870bb41b33">rmdir</a> (const char *path)</td></tr>
  229. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. <tr class="memitem:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab2d483670a0a6a6a4754b23614fe11bc">rootDirEntryCount</a> () const </td></tr>
  231. <tr class="separator:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr class="memitem:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae9363ebbbae90e895ea56e8fa3f60c13">rootDirStart</a> () const </td></tr>
  233. <tr class="separator:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  234. <tr class="memitem:ad60cb13557f35578f868e03e9ccb8be1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ad60cb13557f35578f868e03e9ccb8be1">truncate</a> (const char *path, uint32_t length)</td></tr>
  235. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  236. <tr class="memitem:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a4ca68fe47bb675df0a80df1ed7a53698">vol</a> ()</td></tr>
  237. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  238. <tr class="memitem:a07bc98088ce4a9c725700899c184f7fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a07bc98088ce4a9c725700899c184f7fc">volumeBlockCount</a> () const </td></tr>
  239. <tr class="separator:a07bc98088ce4a9c725700899c184f7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  240. <tr class="memitem:acf257d02b7166683bda2abc5058004bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#acf257d02b7166683bda2abc5058004bf">vwd</a> ()</td></tr>
  241. <tr class="separator:acf257d02b7166683bda2abc5058004bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. <tr class="memitem:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a36d7831f92acfbfef1c4a24dd7103dc4">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>
  243. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  244. </table>
  245. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  246. <div class="textblock"><h3>template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt;<br />
  247. class SdFatSoftSpi&lt; MisoPin, MosiPin, SckPin &gt;</h3>
  248. <p><a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class using software SPI. </p>
  249. </div><h2 class="groupheader">Member Function Documentation</h2>
  250. <a class="anchor" id="a05bd3d358a708efe2f9002d05c3a4139"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool FatFileSystem::begin </td>
  259. <td>(</td>
  260. <td class="paramtype">uint8_t&#160;</td>
  261. <td class="paramname"><em>part</em> = <code>0</code></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Initialize an <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  272. <table class="params">
  273. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="a3d3f2cc4df1b6f2a129c3a614c1e5e1f"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="mlabels">
  284. <tr>
  285. <td class="mlabels-left">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">bool SdFatBase::begin </td>
  289. <td>(</td>
  290. <td class="paramtype"><a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *&#160;</td>
  291. <td class="paramname"><em>spi</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">uint8_t&#160;</td>
  297. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype">uint8_t&#160;</td>
  303. <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>
  304. </tr>
  305. <tr>
  306. <td></td>
  307. <td>)</td>
  308. <td></td><td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Initialize SD card and file system. </p><dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI object for the card. </td></tr>
  320. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  321. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>
  322. </table>
  323. </dd>
  324. </dl>
  325. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  326. </div>
  327. </div>
  328. <a class="anchor" id="aaa99af872cd02612cf17e46b250b1192"></a>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <div class="memtemplate">
  332. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  333. <table class="mlabels">
  334. <tr>
  335. <td class="mlabels-left">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">bool <a class="el" href="class_sd_fat_soft_spi.html">SdFatSoftSpi</a>&lt; MisoPin, MosiPin, SckPin &gt;::begin </td>
  339. <td>(</td>
  340. <td class="paramtype">uint8_t&#160;</td>
  341. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  342. </tr>
  343. <tr>
  344. <td class="paramkey"></td>
  345. <td></td>
  346. <td class="paramtype">uint8_t&#160;</td>
  347. <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>
  348. </tr>
  349. <tr>
  350. <td></td>
  351. <td>)</td>
  352. <td></td><td></td>
  353. </tr>
  354. </table>
  355. </td>
  356. <td class="mlabels-right">
  357. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>Initialize SD card and file system.</p>
  362. <dl class="params"><dt>Parameters</dt><dd>
  363. <table class="params">
  364. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  365. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  370. </div>
  371. </div>
  372. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="mlabels">
  376. <tr>
  377. <td class="mlabels-left">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">uint8_t FatVolume::blocksPerCluster </td>
  381. <td>(</td>
  382. <td class="paramname"></td><td>)</td>
  383. <td> const</td>
  384. </tr>
  385. </table>
  386. </td>
  387. <td class="mlabels-right">
  388. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  393. </div>
  394. </div>
  395. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="mlabels">
  399. <tr>
  400. <td class="mlabels-left">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  404. <td>(</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td> const</td>
  407. </tr>
  408. </table>
  409. </td>
  410. <td class="mlabels-right">
  411. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  416. </div>
  417. </div>
  418. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  427. <td>(</td>
  428. <td class="paramname"></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Clear the cache and returns a pointer to the cache. Not for normal apps. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>
  439. </div>
  440. </div>
  441. <a class="anchor" id="a899294ced4e4585feae7668099338534"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="mlabels">
  445. <tr>
  446. <td class="mlabels-left">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a>* SdFatBase::card </td>
  450. <td>(</td>
  451. <td class="paramname"></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </td>
  456. <td class="mlabels-right">
  457. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>
  462. </div>
  463. </div>
  464. <a class="anchor" id="a85a4c8a4a1aff6dc6c3cd3fb7de246dc"></a>
  465. <div class="memitem">
  466. <div class="memproto">
  467. <div class="memtemplate">
  468. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  469. <table class="mlabels">
  470. <tr>
  471. <td class="mlabels-left">
  472. <table class="memname">
  473. <tr>
  474. <td class="memname">bool <a class="el" href="class_sd_fat_soft_spi.html">SdFatSoftSpi</a>&lt; MisoPin, MosiPin, SckPin &gt;::cardBegin </td>
  475. <td>(</td>
  476. <td class="paramtype">uint8_t&#160;</td>
  477. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  478. </tr>
  479. <tr>
  480. <td class="paramkey"></td>
  481. <td></td>
  482. <td class="paramtype">uint8_t&#160;</td>
  483. <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>
  484. </tr>
  485. <tr>
  486. <td></td>
  487. <td>)</td>
  488. <td></td><td></td>
  489. </tr>
  490. </table>
  491. </td>
  492. <td class="mlabels-right">
  493. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  494. </tr>
  495. </table>
  496. </div><div class="memdoc">
  497. <p>Diagnostic call to initialize SD card - use for diagnostic purposes only. </p><dl class="params"><dt>Parameters</dt><dd>
  498. <table class="params">
  499. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  500. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>
  501. </table>
  502. </dd>
  503. </dl>
  504. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  505. </div>
  506. </div>
  507. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="mlabels">
  511. <tr>
  512. <td class="mlabels-left">
  513. <table class="memname">
  514. <tr>
  515. <td class="memname">bool FatFileSystem::chdir </td>
  516. <td>(</td>
  517. <td class="paramtype">bool&#160;</td>
  518. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  519. <td></td>
  520. </tr>
  521. </table>
  522. </td>
  523. <td class="mlabels-right">
  524. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. <p>Change a volume's working directory to root</p>
  529. <p>Changes the volume's working directory to the SD's root directory. Optionally set the current working directory to the volume's working directory.</p>
  530. <dl class="params"><dt>Parameters</dt><dd>
  531. <table class="params">
  532. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  533. </table>
  534. </dd>
  535. </dl>
  536. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  537. </div>
  538. </div>
  539. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>
  540. <div class="memitem">
  541. <div class="memproto">
  542. <table class="mlabels">
  543. <tr>
  544. <td class="mlabels-left">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname">bool FatFileSystem::chdir </td>
  548. <td>(</td>
  549. <td class="paramtype">const char *&#160;</td>
  550. <td class="paramname"><em>path</em>, </td>
  551. </tr>
  552. <tr>
  553. <td class="paramkey"></td>
  554. <td></td>
  555. <td class="paramtype">bool&#160;</td>
  556. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  557. </tr>
  558. <tr>
  559. <td></td>
  560. <td>)</td>
  561. <td></td><td></td>
  562. </tr>
  563. </table>
  564. </td>
  565. <td class="mlabels-right">
  566. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  567. </tr>
  568. </table>
  569. </div><div class="memdoc">
  570. <p>Change a volume's working directory</p>
  571. <p>Changes the volume working directory to the <em>path</em> subdirectory. Optionally set the current working directory to the volume's working directory.</p>
  572. <p>Example: If the volume's working directory is "/DIR", chdir("SUB") will change the volume's working directory from "/DIR" to "/DIR/SUB".</p>
  573. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  574. <dl class="params"><dt>Parameters</dt><dd>
  575. <table class="params">
  576. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  577. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  578. </table>
  579. </dd>
  580. </dl>
  581. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  582. </div>
  583. </div>
  584. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>
  585. <div class="memitem">
  586. <div class="memproto">
  587. <table class="mlabels">
  588. <tr>
  589. <td class="mlabels-left">
  590. <table class="memname">
  591. <tr>
  592. <td class="memname">void FatFileSystem::chvol </td>
  593. <td>(</td>
  594. <td class="paramname"></td><td>)</td>
  595. <td></td>
  596. </tr>
  597. </table>
  598. </td>
  599. <td class="mlabels-right">
  600. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. <p>Set the current working directory to a volume's working directory.</p>
  605. <p>This is useful with multiple SD cards.</p>
  606. <p>The current working directory is changed to this volume's working directory.</p>
  607. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  608. </div>
  609. </div>
  610. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>
  611. <div class="memitem">
  612. <div class="memproto">
  613. <table class="mlabels">
  614. <tr>
  615. <td class="mlabels-left">
  616. <table class="memname">
  617. <tr>
  618. <td class="memname">uint32_t FatVolume::clusterCount </td>
  619. <td>(</td>
  620. <td class="paramname"></td><td>)</td>
  621. <td> const</td>
  622. </tr>
  623. </table>
  624. </td>
  625. <td class="mlabels-right">
  626. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  627. </tr>
  628. </table>
  629. </div><div class="memdoc">
  630. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  631. </div>
  632. </div>
  633. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>
  634. <div class="memitem">
  635. <div class="memproto">
  636. <table class="mlabels">
  637. <tr>
  638. <td class="mlabels-left">
  639. <table class="memname">
  640. <tr>
  641. <td class="memname">uint8_t FatVolume::clusterSizeShift </td>
  642. <td>(</td>
  643. <td class="paramname"></td><td>)</td>
  644. <td> const</td>
  645. </tr>
  646. </table>
  647. </td>
  648. <td class="mlabels-right">
  649. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  650. </tr>
  651. </table>
  652. </div><div class="memdoc">
  653. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  654. </div>
  655. </div>
  656. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="mlabels">
  660. <tr>
  661. <td class="mlabels-left">
  662. <table class="memname">
  663. <tr>
  664. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  665. <td>(</td>
  666. <td class="paramname"></td><td>)</td>
  667. <td> const</td>
  668. </tr>
  669. </table>
  670. </td>
  671. <td class="mlabels-right">
  672. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  673. </tr>
  674. </table>
  675. </div><div class="memdoc">
  676. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  677. </div>
  678. </div>
  679. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>
  680. <div class="memitem">
  681. <div class="memproto">
  682. <table class="mlabels">
  683. <tr>
  684. <td class="mlabels-left">
  685. <table class="memname">
  686. <tr>
  687. <td class="memname">int8_t FatVolume::dbgFat </td>
  688. <td>(</td>
  689. <td class="paramtype">uint32_t&#160;</td>
  690. <td class="paramname"><em>n</em>, </td>
  691. </tr>
  692. <tr>
  693. <td class="paramkey"></td>
  694. <td></td>
  695. <td class="paramtype">uint32_t *&#160;</td>
  696. <td class="paramname"><em>v</em>&#160;</td>
  697. </tr>
  698. <tr>
  699. <td></td>
  700. <td>)</td>
  701. <td></td><td></td>
  702. </tr>
  703. </table>
  704. </td>
  705. <td class="mlabels-right">
  706. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  707. </tr>
  708. </table>
  709. </div><div class="memdoc">
  710. <p>Debug access to FAT table</p>
  711. <dl class="params"><dt>Parameters</dt><dd>
  712. <table class="params">
  713. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  714. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  715. </table>
  716. </dd>
  717. </dl>
  718. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  719. </div>
  720. </div>
  721. <a class="anchor" id="a905d883dcbaa60aa35a6eb0cad63cc9e"></a>
  722. <div class="memitem">
  723. <div class="memproto">
  724. <table class="mlabels">
  725. <tr>
  726. <td class="mlabels-left">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname">void SdFatBase::errorHalt </td>
  730. <td>(</td>
  731. <td class="paramname"></td><td>)</td>
  732. <td></td>
  733. </tr>
  734. </table>
  735. </td>
  736. <td class="mlabels-right">
  737. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  738. </tr>
  739. </table>
  740. </div><div class="memdoc">
  741. <p>Print any SD error code to Serial and halt. </p>
  742. </div>
  743. </div>
  744. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></a>
  745. <div class="memitem">
  746. <div class="memproto">
  747. <table class="mlabels">
  748. <tr>
  749. <td class="mlabels-left">
  750. <table class="memname">
  751. <tr>
  752. <td class="memname">void SdFatBase::errorHalt </td>
  753. <td>(</td>
  754. <td class="paramtype">Print *&#160;</td>
  755. <td class="paramname"><em>pr</em></td><td>)</td>
  756. <td></td>
  757. </tr>
  758. </table>
  759. </td>
  760. <td class="mlabels-right">
  761. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  762. </tr>
  763. </table>
  764. </div><div class="memdoc">
  765. <p>Print any SD error code and halt.</p>
  766. <dl class="params"><dt>Parameters</dt><dd>
  767. <table class="params">
  768. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  769. </table>
  770. </dd>
  771. </dl>
  772. </div>
  773. </div>
  774. <a class="anchor" id="a07e04b976ffcaf7e9492e50c6e4900a8"></a>
  775. <div class="memitem">
  776. <div class="memproto">
  777. <table class="mlabels">
  778. <tr>
  779. <td class="mlabels-left">
  780. <table class="memname">
  781. <tr>
  782. <td class="memname">void SdFatBase::errorHalt </td>
  783. <td>(</td>
  784. <td class="paramtype">char const *&#160;</td>
  785. <td class="paramname"><em>msg</em></td><td>)</td>
  786. <td></td>
  787. </tr>
  788. </table>
  789. </td>
  790. <td class="mlabels-right">
  791. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  792. </tr>
  793. </table>
  794. </div><div class="memdoc">
  795. <p>Print msg, any SD error code and halt.</p>
  796. <dl class="params"><dt>Parameters</dt><dd>
  797. <table class="params">
  798. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  799. </table>
  800. </dd>
  801. </dl>
  802. </div>
  803. </div>
  804. <a class="anchor" id="a7c52e1a1909c9aa532b8525cf721fd89"></a>
  805. <div class="memitem">
  806. <div class="memproto">
  807. <table class="mlabels">
  808. <tr>
  809. <td class="mlabels-left">
  810. <table class="memname">
  811. <tr>
  812. <td class="memname">void SdFatBase::errorHalt </td>
  813. <td>(</td>
  814. <td class="paramtype">Print *&#160;</td>
  815. <td class="paramname"><em>pr</em>, </td>
  816. </tr>
  817. <tr>
  818. <td class="paramkey"></td>
  819. <td></td>
  820. <td class="paramtype">char const *&#160;</td>
  821. <td class="paramname"><em>msg</em>&#160;</td>
  822. </tr>
  823. <tr>
  824. <td></td>
  825. <td>)</td>
  826. <td></td><td></td>
  827. </tr>
  828. </table>
  829. </td>
  830. <td class="mlabels-right">
  831. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  832. </tr>
  833. </table>
  834. </div><div class="memdoc">
  835. <p>Print msg, any SD error code, and halt.</p>
  836. <dl class="params"><dt>Parameters</dt><dd>
  837. <table class="params">
  838. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  839. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  840. </table>
  841. </dd>
  842. </dl>
  843. </div>
  844. </div>
  845. <a class="anchor" id="a111cecbcc7ea5c068c44051491a77a52"></a>
  846. <div class="memitem">
  847. <div class="memproto">
  848. <table class="mlabels">
  849. <tr>
  850. <td class="mlabels-left">
  851. <table class="memname">
  852. <tr>
  853. <td class="memname">void SdFatBase::errorHalt </td>
  854. <td>(</td>
  855. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  856. <td class="paramname"><em>msg</em></td><td>)</td>
  857. <td></td>
  858. </tr>
  859. </table>
  860. </td>
  861. <td class="mlabels-right">
  862. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  863. </tr>
  864. </table>
  865. </div><div class="memdoc">
  866. <p>Print msg, any SD error code, and halt.</p>
  867. <dl class="params"><dt>Parameters</dt><dd>
  868. <table class="params">
  869. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  870. </table>
  871. </dd>
  872. </dl>
  873. </div>
  874. </div>
  875. <a class="anchor" id="a4c34e68605243269f96122a9cb909004"></a>
  876. <div class="memitem">
  877. <div class="memproto">
  878. <table class="mlabels">
  879. <tr>
  880. <td class="mlabels-left">
  881. <table class="memname">
  882. <tr>
  883. <td class="memname">void SdFatBase::errorHalt </td>
  884. <td>(</td>
  885. <td class="paramtype">Print *&#160;</td>
  886. <td class="paramname"><em>pr</em>, </td>
  887. </tr>
  888. <tr>
  889. <td class="paramkey"></td>
  890. <td></td>
  891. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  892. <td class="paramname"><em>msg</em>&#160;</td>
  893. </tr>
  894. <tr>
  895. <td></td>
  896. <td>)</td>
  897. <td></td><td></td>
  898. </tr>
  899. </table>
  900. </td>
  901. <td class="mlabels-right">
  902. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  903. </tr>
  904. </table>
  905. </div><div class="memdoc">
  906. <p>Print msg, any SD error code, and halt.</p>
  907. <dl class="params"><dt>Parameters</dt><dd>
  908. <table class="params">
  909. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  910. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  911. </table>
  912. </dd>
  913. </dl>
  914. </div>
  915. </div>
  916. <a class="anchor" id="a2deadc5b8bcdf5710fefba39b895e008"></a>
  917. <div class="memitem">
  918. <div class="memproto">
  919. <table class="mlabels">
  920. <tr>
  921. <td class="mlabels-left">
  922. <table class="memname">
  923. <tr>
  924. <td class="memname">void SdFatBase::errorPrint </td>
  925. <td>(</td>
  926. <td class="paramname"></td><td>)</td>
  927. <td></td>
  928. </tr>
  929. </table>
  930. </td>
  931. <td class="mlabels-right">
  932. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  933. </tr>
  934. </table>
  935. </div><div class="memdoc">
  936. <p>Print any SD error code to Serial </p>
  937. </div>
  938. </div>
  939. <a class="anchor" id="aaa950f290e41c0ff2d62b94cb425ba12"></a>
  940. <div class="memitem">
  941. <div class="memproto">
  942. <table class="mlabels">
  943. <tr>
  944. <td class="mlabels-left">
  945. <table class="memname">
  946. <tr>
  947. <td class="memname">void SdFatBase::errorPrint </td>
  948. <td>(</td>
  949. <td class="paramtype">Print *&#160;</td>
  950. <td class="paramname"><em>pr</em></td><td>)</td>
  951. <td></td>
  952. </tr>
  953. </table>
  954. </td>
  955. <td class="mlabels-right">
  956. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  957. </tr>
  958. </table>
  959. </div><div class="memdoc">
  960. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  961. <table class="params">
  962. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  963. </table>
  964. </dd>
  965. </dl>
  966. </div>
  967. </div>
  968. <a class="anchor" id="a84fe32d89460471cf9f66495f545e2ae"></a>
  969. <div class="memitem">
  970. <div class="memproto">
  971. <table class="mlabels">
  972. <tr>
  973. <td class="mlabels-left">
  974. <table class="memname">
  975. <tr>
  976. <td class="memname">void SdFatBase::errorPrint </td>
  977. <td>(</td>
  978. <td class="paramtype">const char *&#160;</td>
  979. <td class="paramname"><em>msg</em></td><td>)</td>
  980. <td></td>
  981. </tr>
  982. </table>
  983. </td>
  984. <td class="mlabels-right">
  985. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  986. </tr>
  987. </table>
  988. </div><div class="memdoc">
  989. <p>Print msg, any SD error code.</p>
  990. <dl class="params"><dt>Parameters</dt><dd>
  991. <table class="params">
  992. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  993. </table>
  994. </dd>
  995. </dl>
  996. </div>
  997. </div>
  998. <a class="anchor" id="a5ecc4177c65f8e2837a9ef4d17368a98"></a>
  999. <div class="memitem">
  1000. <div class="memproto">
  1001. <table class="mlabels">
  1002. <tr>
  1003. <td class="mlabels-left">
  1004. <table class="memname">
  1005. <tr>
  1006. <td class="memname">void SdFatBase::errorPrint </td>
  1007. <td>(</td>
  1008. <td class="paramtype">Print *&#160;</td>
  1009. <td class="paramname"><em>pr</em>, </td>
  1010. </tr>
  1011. <tr>
  1012. <td class="paramkey"></td>
  1013. <td></td>
  1014. <td class="paramtype">char const *&#160;</td>
  1015. <td class="paramname"><em>msg</em>&#160;</td>
  1016. </tr>
  1017. <tr>
  1018. <td></td>
  1019. <td>)</td>
  1020. <td></td><td></td>
  1021. </tr>
  1022. </table>
  1023. </td>
  1024. <td class="mlabels-right">
  1025. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1026. </tr>
  1027. </table>
  1028. </div><div class="memdoc">
  1029. <p>Print msg, any SD error code.</p>
  1030. <dl class="params"><dt>Parameters</dt><dd>
  1031. <table class="params">
  1032. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1033. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1034. </table>
  1035. </dd>
  1036. </dl>
  1037. </div>
  1038. </div>
  1039. <a class="anchor" id="a7eed2449f96d62e87bea96c6da4f618a"></a>
  1040. <div class="memitem">
  1041. <div class="memproto">
  1042. <table class="mlabels">
  1043. <tr>
  1044. <td class="mlabels-left">
  1045. <table class="memname">
  1046. <tr>
  1047. <td class="memname">void SdFatBase::errorPrint </td>
  1048. <td>(</td>
  1049. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1050. <td class="paramname"><em>msg</em></td><td>)</td>
  1051. <td></td>
  1052. </tr>
  1053. </table>
  1054. </td>
  1055. <td class="mlabels-right">
  1056. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1057. </tr>
  1058. </table>
  1059. </div><div class="memdoc">
  1060. <p>Print msg, any SD error code.</p>
  1061. <dl class="params"><dt>Parameters</dt><dd>
  1062. <table class="params">
  1063. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1064. </table>
  1065. </dd>
  1066. </dl>
  1067. </div>
  1068. </div>
  1069. <a class="anchor" id="aace11e097b69144a80a4abbca54d35b0"></a>
  1070. <div class="memitem">
  1071. <div class="memproto">
  1072. <table class="mlabels">
  1073. <tr>
  1074. <td class="mlabels-left">
  1075. <table class="memname">
  1076. <tr>
  1077. <td class="memname">void SdFatBase::errorPrint </td>
  1078. <td>(</td>
  1079. <td class="paramtype">Print *&#160;</td>
  1080. <td class="paramname"><em>pr</em>, </td>
  1081. </tr>
  1082. <tr>
  1083. <td class="paramkey"></td>
  1084. <td></td>
  1085. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1086. <td class="paramname"><em>msg</em>&#160;</td>
  1087. </tr>
  1088. <tr>
  1089. <td></td>
  1090. <td>)</td>
  1091. <td></td><td></td>
  1092. </tr>
  1093. </table>
  1094. </td>
  1095. <td class="mlabels-right">
  1096. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1097. </tr>
  1098. </table>
  1099. </div><div class="memdoc">
  1100. <p>Print msg, any SD error code.</p>
  1101. <dl class="params"><dt>Parameters</dt><dd>
  1102. <table class="params">
  1103. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1104. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1105. </table>
  1106. </dd>
  1107. </dl>
  1108. </div>
  1109. </div>
  1110. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>
  1111. <div class="memitem">
  1112. <div class="memproto">
  1113. <table class="mlabels">
  1114. <tr>
  1115. <td class="mlabels-left">
  1116. <table class="memname">
  1117. <tr>
  1118. <td class="memname">bool FatFileSystem::exists </td>
  1119. <td>(</td>
  1120. <td class="paramtype">const char *&#160;</td>
  1121. <td class="paramname"><em>path</em></td><td>)</td>
  1122. <td></td>
  1123. </tr>
  1124. </table>
  1125. </td>
  1126. <td class="mlabels-right">
  1127. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1128. </tr>
  1129. </table>
  1130. </div><div class="memdoc">
  1131. <p>Test for the existence of a file.</p>
  1132. <dl class="params"><dt>Parameters</dt><dd>
  1133. <table class="params">
  1134. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  1135. </table>
  1136. </dd>
  1137. </dl>
  1138. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  1139. </div>
  1140. </div>
  1141. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  1142. <div class="memitem">
  1143. <div class="memproto">
  1144. <table class="mlabels">
  1145. <tr>
  1146. <td class="mlabels-left">
  1147. <table class="memname">
  1148. <tr>
  1149. <td class="memname">uint8_t FatVolume::fatCount </td>
  1150. <td>(</td>
  1151. <td class="paramname"></td><td>)</td>
  1152. <td></td>
  1153. </tr>
  1154. </table>
  1155. </td>
  1156. <td class="mlabels-right">
  1157. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1158. </tr>
  1159. </table>
  1160. </div><div class="memdoc">
  1161. <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Allocation Tables. </dd></dl>
  1162. </div>
  1163. </div>
  1164. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>
  1165. <div class="memitem">
  1166. <div class="memproto">
  1167. <table class="mlabels">
  1168. <tr>
  1169. <td class="mlabels-left">
  1170. <table class="memname">
  1171. <tr>
  1172. <td class="memname">uint32_t FatVolume::fatStartBlock </td>
  1173. <td>(</td>
  1174. <td class="paramname"></td><td>)</td>
  1175. <td> const</td>
  1176. </tr>
  1177. </table>
  1178. </td>
  1179. <td class="mlabels-right">
  1180. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1181. </tr>
  1182. </table>
  1183. </div><div class="memdoc">
  1184. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  1185. </div>
  1186. </div>
  1187. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>
  1188. <div class="memitem">
  1189. <div class="memproto">
  1190. <table class="mlabels">
  1191. <tr>
  1192. <td class="mlabels-left">
  1193. <table class="memname">
  1194. <tr>
  1195. <td class="memname">uint8_t FatVolume::fatType </td>
  1196. <td>(</td>
  1197. <td class="paramname"></td><td>)</td>
  1198. <td> const</td>
  1199. </tr>
  1200. </table>
  1201. </td>
  1202. <td class="mlabels-right">
  1203. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1204. </tr>
  1205. </table>
  1206. </div><div class="memdoc">
  1207. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  1208. </div>
  1209. </div>
  1210. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>
  1211. <div class="memitem">
  1212. <div class="memproto">
  1213. <table class="mlabels">
  1214. <tr>
  1215. <td class="mlabels-left">
  1216. <table class="memname">
  1217. <tr>
  1218. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  1219. <td>(</td>
  1220. <td class="paramname"></td><td>)</td>
  1221. <td></td>
  1222. </tr>
  1223. </table>
  1224. </td>
  1225. <td class="mlabels-right">
  1226. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1227. </tr>
  1228. </table>
  1229. </div><div class="memdoc">
  1230. <p>Volume free space in clusters.</p>
  1231. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  1232. </div>
  1233. </div>
  1234. <a class="anchor" id="a389f0ef6fb556c67b48ade5c0c1b3a9a"></a>
  1235. <div class="memitem">
  1236. <div class="memproto">
  1237. <table class="mlabels">
  1238. <tr>
  1239. <td class="mlabels-left">
  1240. <table class="memname">
  1241. <tr>
  1242. <td class="memname">bool SdFatBase::fsBegin </td>
  1243. <td>(</td>
  1244. <td class="paramname"></td><td>)</td>
  1245. <td></td>
  1246. </tr>
  1247. </table>
  1248. </td>
  1249. <td class="mlabels-right">
  1250. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1251. </tr>
  1252. </table>
  1253. </div><div class="memdoc">
  1254. <p>Diagnostic call to initialize <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> - use for diagnostic purposes only. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  1255. </div>
  1256. </div>
  1257. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  1258. <div class="memitem">
  1259. <div class="memproto">
  1260. <table class="mlabels">
  1261. <tr>
  1262. <td class="mlabels-left">
  1263. <table class="memname">
  1264. <tr>
  1265. <td class="memname">bool FatVolume::init </td>
  1266. <td>(</td>
  1267. <td class="paramname"></td><td>)</td>
  1268. <td></td>
  1269. </tr>
  1270. </table>
  1271. </td>
  1272. <td class="mlabels-right">
  1273. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1274. </tr>
  1275. </table>
  1276. </div><div class="memdoc">
  1277. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  1278. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1279. </div>
  1280. </div>
  1281. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  1282. <div class="memitem">
  1283. <div class="memproto">
  1284. <table class="mlabels">
  1285. <tr>
  1286. <td class="mlabels-left">
  1287. <table class="memname">
  1288. <tr>
  1289. <td class="memname">bool FatVolume::init </td>
  1290. <td>(</td>
  1291. <td class="paramtype">uint8_t&#160;</td>
  1292. <td class="paramname"><em>part</em></td><td>)</td>
  1293. <td></td>
  1294. </tr>
  1295. </table>
  1296. </td>
  1297. <td class="mlabels-right">
  1298. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1299. </tr>
  1300. </table>
  1301. </div><div class="memdoc">
  1302. <p>Initialize a FAT volume.</p>
  1303. <dl class="params"><dt>Parameters</dt><dd>
  1304. <table class="params">
  1305. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in block zero.</td></tr>
  1306. </table>
  1307. </dd>
  1308. </dl>
  1309. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1310. </div>
  1311. </div>
  1312. <a class="anchor" id="adbfd9264f972f054e561128bad0b267e"></a>
  1313. <div class="memitem">
  1314. <div class="memproto">
  1315. <table class="mlabels">
  1316. <tr>
  1317. <td class="mlabels-left">
  1318. <table class="memname">
  1319. <tr>
  1320. <td class="memname">void SdFatBase::initErrorHalt </td>
  1321. <td>(</td>
  1322. <td class="paramname"></td><td>)</td>
  1323. <td></td>
  1324. </tr>
  1325. </table>
  1326. </td>
  1327. <td class="mlabels-right">
  1328. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1329. </tr>
  1330. </table>
  1331. </div><div class="memdoc">
  1332. <p>Print any SD error code and halt. </p>
  1333. </div>
  1334. </div>
  1335. <a class="anchor" id="a86770dd889bffc5788172c8d34a3582c"></a>
  1336. <div class="memitem">
  1337. <div class="memproto">
  1338. <table class="mlabels">
  1339. <tr>
  1340. <td class="mlabels-left">
  1341. <table class="memname">
  1342. <tr>
  1343. <td class="memname">void SdFatBase::initErrorHalt </td>
  1344. <td>(</td>
  1345. <td class="paramtype">Print *&#160;</td>
  1346. <td class="paramname"><em>pr</em></td><td>)</td>
  1347. <td></td>
  1348. </tr>
  1349. </table>
  1350. </td>
  1351. <td class="mlabels-right">
  1352. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1353. </tr>
  1354. </table>
  1355. </div><div class="memdoc">
  1356. <p>Print error details and halt after begin fails.</p>
  1357. <dl class="params"><dt>Parameters</dt><dd>
  1358. <table class="params">
  1359. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1360. </table>
  1361. </dd>
  1362. </dl>
  1363. </div>
  1364. </div>
  1365. <a class="anchor" id="a0d4c851a3243c9f8c21d3894821292e9"></a>
  1366. <div class="memitem">
  1367. <div class="memproto">
  1368. <table class="mlabels">
  1369. <tr>
  1370. <td class="mlabels-left">
  1371. <table class="memname">
  1372. <tr>
  1373. <td class="memname">void SdFatBase::initErrorHalt </td>
  1374. <td>(</td>
  1375. <td class="paramtype">char const *&#160;</td>
  1376. <td class="paramname"><em>msg</em></td><td>)</td>
  1377. <td></td>
  1378. </tr>
  1379. </table>
  1380. </td>
  1381. <td class="mlabels-right">
  1382. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1383. </tr>
  1384. </table>
  1385. </div><div class="memdoc">
  1386. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1387. <dl class="params"><dt>Parameters</dt><dd>
  1388. <table class="params">
  1389. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1390. </table>
  1391. </dd>
  1392. </dl>
  1393. </div>
  1394. </div>
  1395. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></a>
  1396. <div class="memitem">
  1397. <div class="memproto">
  1398. <table class="mlabels">
  1399. <tr>
  1400. <td class="mlabels-left">
  1401. <table class="memname">
  1402. <tr>
  1403. <td class="memname">void SdFatBase::initErrorHalt </td>
  1404. <td>(</td>
  1405. <td class="paramtype">Print *&#160;</td>
  1406. <td class="paramname"><em>pr</em>, </td>
  1407. </tr>
  1408. <tr>
  1409. <td class="paramkey"></td>
  1410. <td></td>
  1411. <td class="paramtype">char const *&#160;</td>
  1412. <td class="paramname"><em>msg</em>&#160;</td>
  1413. </tr>
  1414. <tr>
  1415. <td></td>
  1416. <td>)</td>
  1417. <td></td><td></td>
  1418. </tr>
  1419. </table>
  1420. </td>
  1421. <td class="mlabels-right">
  1422. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1423. </tr>
  1424. </table>
  1425. </div><div class="memdoc">
  1426. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1427. <table class="params">
  1428. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  1429. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1430. </table>
  1431. </dd>
  1432. </dl>
  1433. </div>
  1434. </div>
  1435. <a class="anchor" id="abe312251854aebf5b8d6b4f9896660ed"></a>
  1436. <div class="memitem">
  1437. <div class="memproto">
  1438. <table class="mlabels">
  1439. <tr>
  1440. <td class="mlabels-left">
  1441. <table class="memname">
  1442. <tr>
  1443. <td class="memname">void SdFatBase::initErrorHalt </td>
  1444. <td>(</td>
  1445. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1446. <td class="paramname"><em>msg</em></td><td>)</td>
  1447. <td></td>
  1448. </tr>
  1449. </table>
  1450. </td>
  1451. <td class="mlabels-right">
  1452. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1453. </tr>
  1454. </table>
  1455. </div><div class="memdoc">
  1456. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1457. <dl class="params"><dt>Parameters</dt><dd>
  1458. <table class="params">
  1459. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1460. </table>
  1461. </dd>
  1462. </dl>
  1463. </div>
  1464. </div>
  1465. <a class="anchor" id="aa93c7fec40b37e7f5dd1e362ebf5ff69"></a>
  1466. <div class="memitem">
  1467. <div class="memproto">
  1468. <table class="mlabels">
  1469. <tr>
  1470. <td class="mlabels-left">
  1471. <table class="memname">
  1472. <tr>
  1473. <td class="memname">void SdFatBase::initErrorHalt </td>
  1474. <td>(</td>
  1475. <td class="paramtype">Print *&#160;</td>
  1476. <td class="paramname"><em>pr</em>, </td>
  1477. </tr>
  1478. <tr>
  1479. <td class="paramkey"></td>
  1480. <td></td>
  1481. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1482. <td class="paramname"><em>msg</em>&#160;</td>
  1483. </tr>
  1484. <tr>
  1485. <td></td>
  1486. <td>)</td>
  1487. <td></td><td></td>
  1488. </tr>
  1489. </table>
  1490. </td>
  1491. <td class="mlabels-right">
  1492. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1493. </tr>
  1494. </table>
  1495. </div><div class="memdoc">
  1496. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1497. <table class="params">
  1498. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>
  1499. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1500. </table>
  1501. </dd>
  1502. </dl>
  1503. </div>
  1504. </div>
  1505. <a class="anchor" id="a62a979138be1b62942f7b3f04964356e"></a>
  1506. <div class="memitem">
  1507. <div class="memproto">
  1508. <table class="mlabels">
  1509. <tr>
  1510. <td class="mlabels-left">
  1511. <table class="memname">
  1512. <tr>
  1513. <td class="memname">void SdFatBase::initErrorPrint </td>
  1514. <td>(</td>
  1515. <td class="paramname"></td><td>)</td>
  1516. <td></td>
  1517. </tr>
  1518. </table>
  1519. </td>
  1520. <td class="mlabels-right">
  1521. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1522. </tr>
  1523. </table>
  1524. </div><div class="memdoc">
  1525. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails. </p>
  1526. </div>
  1527. </div>
  1528. <a class="anchor" id="adffd5a3e802842b371b170c6df6b2530"></a>
  1529. <div class="memitem">
  1530. <div class="memproto">
  1531. <table class="mlabels">
  1532. <tr>
  1533. <td class="mlabels-left">
  1534. <table class="memname">
  1535. <tr>
  1536. <td class="memname">void SdFatBase::initErrorPrint </td>
  1537. <td>(</td>
  1538. <td class="paramtype">Print *&#160;</td>
  1539. <td class="paramname"><em>pr</em></td><td>)</td>
  1540. <td></td>
  1541. </tr>
  1542. </table>
  1543. </td>
  1544. <td class="mlabels-right">
  1545. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1546. </tr>
  1547. </table>
  1548. </div><div class="memdoc">
  1549. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1550. <dl class="params"><dt>Parameters</dt><dd>
  1551. <table class="params">
  1552. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1553. </table>
  1554. </dd>
  1555. </dl>
  1556. </div>
  1557. </div>
  1558. <a class="anchor" id="a296855ca8cc7590b9cbe7b3aeabc8467"></a>
  1559. <div class="memitem">
  1560. <div class="memproto">
  1561. <table class="mlabels">
  1562. <tr>
  1563. <td class="mlabels-left">
  1564. <table class="memname">
  1565. <tr>
  1566. <td class="memname">void SdFatBase::initErrorPrint </td>
  1567. <td>(</td>
  1568. <td class="paramtype">char const *&#160;</td>
  1569. <td class="paramname"><em>msg</em></td><td>)</td>
  1570. <td></td>
  1571. </tr>
  1572. </table>
  1573. </td>
  1574. <td class="mlabels-right">
  1575. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1576. </tr>
  1577. </table>
  1578. </div><div class="memdoc">
  1579. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1580. <dl class="params"><dt>Parameters</dt><dd>
  1581. <table class="params">
  1582. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1583. </table>
  1584. </dd>
  1585. </dl>
  1586. </div>
  1587. </div>
  1588. <a class="anchor" id="aca07f92b3a06ede0e7a56b68b76dc3b7"></a>
  1589. <div class="memitem">
  1590. <div class="memproto">
  1591. <table class="mlabels">
  1592. <tr>
  1593. <td class="mlabels-left">
  1594. <table class="memname">
  1595. <tr>
  1596. <td class="memname">void SdFatBase::initErrorPrint </td>
  1597. <td>(</td>
  1598. <td class="paramtype">Print *&#160;</td>
  1599. <td class="paramname"><em>pr</em>, </td>
  1600. </tr>
  1601. <tr>
  1602. <td class="paramkey"></td>
  1603. <td></td>
  1604. <td class="paramtype">char const *&#160;</td>
  1605. <td class="paramname"><em>msg</em>&#160;</td>
  1606. </tr>
  1607. <tr>
  1608. <td></td>
  1609. <td>)</td>
  1610. <td></td><td></td>
  1611. </tr>
  1612. </table>
  1613. </td>
  1614. <td class="mlabels-right">
  1615. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1616. </tr>
  1617. </table>
  1618. </div><div class="memdoc">
  1619. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1620. <dl class="params"><dt>Parameters</dt><dd>
  1621. <table class="params">
  1622. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1623. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1624. </table>
  1625. </dd>
  1626. </dl>
  1627. </div>
  1628. </div>
  1629. <a class="anchor" id="a9c334faf236651db265d5acf65271666"></a>
  1630. <div class="memitem">
  1631. <div class="memproto">
  1632. <table class="mlabels">
  1633. <tr>
  1634. <td class="mlabels-left">
  1635. <table class="memname">
  1636. <tr>
  1637. <td class="memname">void SdFatBase::initErrorPrint </td>
  1638. <td>(</td>
  1639. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1640. <td class="paramname"><em>msg</em></td><td>)</td>
  1641. <td></td>
  1642. </tr>
  1643. </table>
  1644. </td>
  1645. <td class="mlabels-right">
  1646. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1647. </tr>
  1648. </table>
  1649. </div><div class="memdoc">
  1650. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1651. <dl class="params"><dt>Parameters</dt><dd>
  1652. <table class="params">
  1653. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1654. </table>
  1655. </dd>
  1656. </dl>
  1657. </div>
  1658. </div>
  1659. <a class="anchor" id="ac0b7161c1385841264323ac244f5c89c"></a>
  1660. <div class="memitem">
  1661. <div class="memproto">
  1662. <table class="mlabels">
  1663. <tr>
  1664. <td class="mlabels-left">
  1665. <table class="memname">
  1666. <tr>
  1667. <td class="memname">void SdFatBase::initErrorPrint </td>
  1668. <td>(</td>
  1669. <td class="paramtype">Print *&#160;</td>
  1670. <td class="paramname"><em>pr</em>, </td>
  1671. </tr>
  1672. <tr>
  1673. <td class="paramkey"></td>
  1674. <td></td>
  1675. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1676. <td class="paramname"><em>msg</em>&#160;</td>
  1677. </tr>
  1678. <tr>
  1679. <td></td>
  1680. <td>)</td>
  1681. <td></td><td></td>
  1682. </tr>
  1683. </table>
  1684. </td>
  1685. <td class="mlabels-right">
  1686. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1687. </tr>
  1688. </table>
  1689. </div><div class="memdoc">
  1690. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1691. <dl class="params"><dt>Parameters</dt><dd>
  1692. <table class="params">
  1693. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1694. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1695. </table>
  1696. </dd>
  1697. </dl>
  1698. </div>
  1699. </div>
  1700. <a class="anchor" id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>
  1701. <div class="memitem">
  1702. <div class="memproto">
  1703. <table class="mlabels">
  1704. <tr>
  1705. <td class="mlabels-left">
  1706. <table class="memname">
  1707. <tr>
  1708. <td class="memname">void FatFileSystem::ls </td>
  1709. <td>(</td>
  1710. <td class="paramtype">uint8_t&#160;</td>
  1711. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1712. <td></td>
  1713. </tr>
  1714. </table>
  1715. </td>
  1716. <td class="mlabels-right">
  1717. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1718. </tr>
  1719. </table>
  1720. </div><div class="memdoc">
  1721. <p>List the directory contents of the volume working directory to Serial.</p>
  1722. <dl class="params"><dt>Parameters</dt><dd>
  1723. <table class="params">
  1724. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1725. </table>
  1726. </dd>
  1727. </dl>
  1728. <p>LS_DATE - Print file modification date</p>
  1729. <p>LS_SIZE - Print file size.</p>
  1730. <p>LS_R - Recursive list of subdirectories. </p>
  1731. </div>
  1732. </div>
  1733. <a class="anchor" id="a122b61dbec5051304bcc81bc08b1b99d"></a>
  1734. <div class="memitem">
  1735. <div class="memproto">
  1736. <table class="mlabels">
  1737. <tr>
  1738. <td class="mlabels-left">
  1739. <table class="memname">
  1740. <tr>
  1741. <td class="memname">void FatFileSystem::ls </td>
  1742. <td>(</td>
  1743. <td class="paramtype">const char *&#160;</td>
  1744. <td class="paramname"><em>path</em>, </td>
  1745. </tr>
  1746. <tr>
  1747. <td class="paramkey"></td>
  1748. <td></td>
  1749. <td class="paramtype">uint8_t&#160;</td>
  1750. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1751. </tr>
  1752. <tr>
  1753. <td></td>
  1754. <td>)</td>
  1755. <td></td><td></td>
  1756. </tr>
  1757. </table>
  1758. </td>
  1759. <td class="mlabels-right">
  1760. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1761. </tr>
  1762. </table>
  1763. </div><div class="memdoc">
  1764. <p>List the directory contents of a directory to Serial.</p>
  1765. <dl class="params"><dt>Parameters</dt><dd>
  1766. <table class="params">
  1767. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1768. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1769. </table>
  1770. </dd>
  1771. </dl>
  1772. <p>LS_DATE - Print file modification date</p>
  1773. <p>LS_SIZE - Print file size.</p>
  1774. <p>LS_R - Recursive list of subdirectories. </p>
  1775. </div>
  1776. </div>
  1777. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>
  1778. <div class="memitem">
  1779. <div class="memproto">
  1780. <table class="mlabels">
  1781. <tr>
  1782. <td class="mlabels-left">
  1783. <table class="memname">
  1784. <tr>
  1785. <td class="memname">void FatFileSystem::ls </td>
  1786. <td>(</td>
  1787. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1788. <td class="paramname"><em>pr</em>, </td>
  1789. </tr>
  1790. <tr>
  1791. <td class="paramkey"></td>
  1792. <td></td>
  1793. <td class="paramtype">uint8_t&#160;</td>
  1794. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1795. </tr>
  1796. <tr>
  1797. <td></td>
  1798. <td>)</td>
  1799. <td></td><td></td>
  1800. </tr>
  1801. </table>
  1802. </td>
  1803. <td class="mlabels-right">
  1804. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1805. </tr>
  1806. </table>
  1807. </div><div class="memdoc">
  1808. <p>List the directory contents of the volume working directory.</p>
  1809. <dl class="params"><dt>Parameters</dt><dd>
  1810. <table class="params">
  1811. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1812. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1813. </table>
  1814. </dd>
  1815. </dl>
  1816. <p>LS_DATE - Print file modification date</p>
  1817. <p>LS_SIZE - Print file size.</p>
  1818. <p>LS_R - Recursive list of subdirectories. </p>
  1819. </div>
  1820. </div>
  1821. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>
  1822. <div class="memitem">
  1823. <div class="memproto">
  1824. <table class="mlabels">
  1825. <tr>
  1826. <td class="mlabels-left">
  1827. <table class="memname">
  1828. <tr>
  1829. <td class="memname">void FatFileSystem::ls </td>
  1830. <td>(</td>
  1831. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1832. <td class="paramname"><em>pr</em>, </td>
  1833. </tr>
  1834. <tr>
  1835. <td class="paramkey"></td>
  1836. <td></td>
  1837. <td class="paramtype">const char *&#160;</td>
  1838. <td class="paramname"><em>path</em>, </td>
  1839. </tr>
  1840. <tr>
  1841. <td class="paramkey"></td>
  1842. <td></td>
  1843. <td class="paramtype">uint8_t&#160;</td>
  1844. <td class="paramname"><em>flags</em>&#160;</td>
  1845. </tr>
  1846. <tr>
  1847. <td></td>
  1848. <td>)</td>
  1849. <td></td><td></td>
  1850. </tr>
  1851. </table>
  1852. </td>
  1853. <td class="mlabels-right">
  1854. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1855. </tr>
  1856. </table>
  1857. </div><div class="memdoc">
  1858. <p>List the directory contents of a directory.</p>
  1859. <dl class="params"><dt>Parameters</dt><dd>
  1860. <table class="params">
  1861. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1862. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1863. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1864. </table>
  1865. </dd>
  1866. </dl>
  1867. <p>LS_DATE - Print file modification date</p>
  1868. <p>LS_SIZE - Print file size.</p>
  1869. <p>LS_R - Recursive list of subdirectories. </p>
  1870. </div>
  1871. </div>
  1872. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  1873. <div class="memitem">
  1874. <div class="memproto">
  1875. <table class="mlabels">
  1876. <tr>
  1877. <td class="mlabels-left">
  1878. <table class="memname">
  1879. <tr>
  1880. <td class="memname">bool FatFileSystem::mkdir </td>
  1881. <td>(</td>
  1882. <td class="paramtype">const char *&#160;</td>
  1883. <td class="paramname"><em>path</em>, </td>
  1884. </tr>
  1885. <tr>
  1886. <td class="paramkey"></td>
  1887. <td></td>
  1888. <td class="paramtype">bool&#160;</td>
  1889. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1890. </tr>
  1891. <tr>
  1892. <td></td>
  1893. <td>)</td>
  1894. <td></td><td></td>
  1895. </tr>
  1896. </table>
  1897. </td>
  1898. <td class="mlabels-right">
  1899. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1900. </tr>
  1901. </table>
  1902. </div><div class="memdoc">
  1903. <p>Make a subdirectory in the volume working directory.</p>
  1904. <dl class="params"><dt>Parameters</dt><dd>
  1905. <table class="params">
  1906. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  1907. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1908. </table>
  1909. </dd>
  1910. </dl>
  1911. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1912. </div>
  1913. </div>
  1914. <a class="anchor" id="a947e4586077a922892b632edac33b67a"></a>
  1915. <div class="memitem">
  1916. <div class="memproto">
  1917. <table class="mlabels">
  1918. <tr>
  1919. <td class="mlabels-left">
  1920. <table class="memname">
  1921. <tr>
  1922. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1923. <td>(</td>
  1924. <td class="paramtype">const char *&#160;</td>
  1925. <td class="paramname"><em>path</em>, </td>
  1926. </tr>
  1927. <tr>
  1928. <td class="paramkey"></td>
  1929. <td></td>
  1930. <td class="paramtype">uint8_t&#160;</td>
  1931. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1932. </tr>
  1933. <tr>
  1934. <td></td>
  1935. <td>)</td>
  1936. <td></td><td></td>
  1937. </tr>
  1938. </table>
  1939. </td>
  1940. <td class="mlabels-right">
  1941. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1942. </tr>
  1943. </table>
  1944. </div><div class="memdoc">
  1945. <p>open a file</p>
  1946. <dl class="params"><dt>Parameters</dt><dd>
  1947. <table class="params">
  1948. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1949. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1950. </table>
  1951. </dd>
  1952. </dl>
  1953. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  1954. </div>
  1955. </div>
  1956. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>
  1957. <div class="memitem">
  1958. <div class="memproto">
  1959. <table class="mlabels">
  1960. <tr>
  1961. <td class="mlabels-left">
  1962. <table class="memname">
  1963. <tr>
  1964. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1965. <td>(</td>
  1966. <td class="paramtype">const String &amp;&#160;</td>
  1967. <td class="paramname"><em>path</em>, </td>
  1968. </tr>
  1969. <tr>
  1970. <td class="paramkey"></td>
  1971. <td></td>
  1972. <td class="paramtype">uint8_t&#160;</td>
  1973. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1974. </tr>
  1975. <tr>
  1976. <td></td>
  1977. <td>)</td>
  1978. <td></td><td></td>
  1979. </tr>
  1980. </table>
  1981. </td>
  1982. <td class="mlabels-right">
  1983. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1984. </tr>
  1985. </table>
  1986. </div><div class="memdoc">
  1987. <p>open a file</p>
  1988. <dl class="params"><dt>Parameters</dt><dd>
  1989. <table class="params">
  1990. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1991. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1992. </table>
  1993. </dd>
  1994. </dl>
  1995. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  1996. </div>
  1997. </div>
  1998. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  1999. <div class="memitem">
  2000. <div class="memproto">
  2001. <table class="mlabels">
  2002. <tr>
  2003. <td class="mlabels-left">
  2004. <table class="memname">
  2005. <tr>
  2006. <td class="memname">bool FatFileSystem::remove </td>
  2007. <td>(</td>
  2008. <td class="paramtype">const char *&#160;</td>
  2009. <td class="paramname"><em>path</em></td><td>)</td>
  2010. <td></td>
  2011. </tr>
  2012. </table>
  2013. </td>
  2014. <td class="mlabels-right">
  2015. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2016. </tr>
  2017. </table>
  2018. </div><div class="memdoc">
  2019. <p>Remove a file from the volume working directory.</p>
  2020. <dl class="params"><dt>Parameters</dt><dd>
  2021. <table class="params">
  2022. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file.</td></tr>
  2023. </table>
  2024. </dd>
  2025. </dl>
  2026. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2027. </div>
  2028. </div>
  2029. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>
  2030. <div class="memitem">
  2031. <div class="memproto">
  2032. <table class="mlabels">
  2033. <tr>
  2034. <td class="mlabels-left">
  2035. <table class="memname">
  2036. <tr>
  2037. <td class="memname">bool FatFileSystem::rename </td>
  2038. <td>(</td>
  2039. <td class="paramtype">const char *&#160;</td>
  2040. <td class="paramname"><em>oldPath</em>, </td>
  2041. </tr>
  2042. <tr>
  2043. <td class="paramkey"></td>
  2044. <td></td>
  2045. <td class="paramtype">const char *&#160;</td>
  2046. <td class="paramname"><em>newPath</em>&#160;</td>
  2047. </tr>
  2048. <tr>
  2049. <td></td>
  2050. <td>)</td>
  2051. <td></td><td></td>
  2052. </tr>
  2053. </table>
  2054. </td>
  2055. <td class="mlabels-right">
  2056. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2057. </tr>
  2058. </table>
  2059. </div><div class="memdoc">
  2060. <p>Rename a file or subdirectory.</p>
  2061. <dl class="params"><dt>Parameters</dt><dd>
  2062. <table class="params">
  2063. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  2064. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  2065. </table>
  2066. </dd>
  2067. </dl>
  2068. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  2069. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename()</a> call.</p>
  2070. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2071. </div>
  2072. </div>
  2073. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  2074. <div class="memitem">
  2075. <div class="memproto">
  2076. <table class="mlabels">
  2077. <tr>
  2078. <td class="mlabels-left">
  2079. <table class="memname">
  2080. <tr>
  2081. <td class="memname">bool FatFileSystem::rmdir </td>
  2082. <td>(</td>
  2083. <td class="paramtype">const char *&#160;</td>
  2084. <td class="paramname"><em>path</em></td><td>)</td>
  2085. <td></td>
  2086. </tr>
  2087. </table>
  2088. </td>
  2089. <td class="mlabels-right">
  2090. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2091. </tr>
  2092. </table>
  2093. </div><div class="memdoc">
  2094. <p>Remove a subdirectory from the volume's working directory.</p>
  2095. <dl class="params"><dt>Parameters</dt><dd>
  2096. <table class="params">
  2097. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  2098. </table>
  2099. </dd>
  2100. </dl>
  2101. <p>The subdirectory file will be removed only if it is empty.</p>
  2102. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2103. </div>
  2104. </div>
  2105. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>
  2106. <div class="memitem">
  2107. <div class="memproto">
  2108. <table class="mlabels">
  2109. <tr>
  2110. <td class="mlabels-left">
  2111. <table class="memname">
  2112. <tr>
  2113. <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>
  2114. <td>(</td>
  2115. <td class="paramname"></td><td>)</td>
  2116. <td> const</td>
  2117. </tr>
  2118. </table>
  2119. </td>
  2120. <td class="mlabels-right">
  2121. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2122. </tr>
  2123. </table>
  2124. </div><div class="memdoc">
  2125. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  2126. </div>
  2127. </div>
  2128. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>
  2129. <div class="memitem">
  2130. <div class="memproto">
  2131. <table class="mlabels">
  2132. <tr>
  2133. <td class="mlabels-left">
  2134. <table class="memname">
  2135. <tr>
  2136. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  2137. <td>(</td>
  2138. <td class="paramname"></td><td>)</td>
  2139. <td> const</td>
  2140. </tr>
  2141. </table>
  2142. </td>
  2143. <td class="mlabels-right">
  2144. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2145. </tr>
  2146. </table>
  2147. </div><div class="memdoc">
  2148. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  2149. </div>
  2150. </div>
  2151. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  2152. <div class="memitem">
  2153. <div class="memproto">
  2154. <table class="mlabels">
  2155. <tr>
  2156. <td class="mlabels-left">
  2157. <table class="memname">
  2158. <tr>
  2159. <td class="memname">bool FatFileSystem::truncate </td>
  2160. <td>(</td>
  2161. <td class="paramtype">const char *&#160;</td>
  2162. <td class="paramname"><em>path</em>, </td>
  2163. </tr>
  2164. <tr>
  2165. <td class="paramkey"></td>
  2166. <td></td>
  2167. <td class="paramtype">uint32_t&#160;</td>
  2168. <td class="paramname"><em>length</em>&#160;</td>
  2169. </tr>
  2170. <tr>
  2171. <td></td>
  2172. <td>)</td>
  2173. <td></td><td></td>
  2174. </tr>
  2175. </table>
  2176. </td>
  2177. <td class="mlabels-right">
  2178. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2179. </tr>
  2180. </table>
  2181. </div><div class="memdoc">
  2182. <p>Truncate a file to a specified length. The current file position will be maintained if it is less than or equal to <em>length</em> otherwise it will be set to end of file.</p>
  2183. <dl class="params"><dt>Parameters</dt><dd>
  2184. <table class="params">
  2185. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file. </td></tr>
  2186. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2187. </table>
  2188. </dd>
  2189. </dl>
  2190. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2191. </div>
  2192. </div>
  2193. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  2194. <div class="memitem">
  2195. <div class="memproto">
  2196. <table class="mlabels">
  2197. <tr>
  2198. <td class="mlabels-left">
  2199. <table class="memname">
  2200. <tr>
  2201. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  2202. <td>(</td>
  2203. <td class="paramname"></td><td>)</td>
  2204. <td></td>
  2205. </tr>
  2206. </table>
  2207. </td>
  2208. <td class="mlabels-right">
  2209. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2210. </tr>
  2211. </table>
  2212. </div><div class="memdoc">
  2213. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> object. </dd></dl>
  2214. </div>
  2215. </div>
  2216. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>
  2217. <div class="memitem">
  2218. <div class="memproto">
  2219. <table class="mlabels">
  2220. <tr>
  2221. <td class="mlabels-left">
  2222. <table class="memname">
  2223. <tr>
  2224. <td class="memname">uint32_t FatVolume::volumeBlockCount </td>
  2225. <td>(</td>
  2226. <td class="paramname"></td><td>)</td>
  2227. <td> const</td>
  2228. </tr>
  2229. </table>
  2230. </td>
  2231. <td class="mlabels-right">
  2232. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2233. </tr>
  2234. </table>
  2235. </div><div class="memdoc">
  2236. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>
  2237. </div>
  2238. </div>
  2239. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>
  2240. <div class="memitem">
  2241. <div class="memproto">
  2242. <table class="mlabels">
  2243. <tr>
  2244. <td class="mlabels-left">
  2245. <table class="memname">
  2246. <tr>
  2247. <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>
  2248. <td>(</td>
  2249. <td class="paramname"></td><td>)</td>
  2250. <td></td>
  2251. </tr>
  2252. </table>
  2253. </td>
  2254. <td class="mlabels-right">
  2255. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2256. </tr>
  2257. </table>
  2258. </div><div class="memdoc">
  2259. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  2260. </div>
  2261. </div>
  2262. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>
  2263. <div class="memitem">
  2264. <div class="memproto">
  2265. <table class="mlabels">
  2266. <tr>
  2267. <td class="mlabels-left">
  2268. <table class="memname">
  2269. <tr>
  2270. <td class="memname">bool FatFileSystem::wipe </td>
  2271. <td>(</td>
  2272. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2273. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  2274. <td></td>
  2275. </tr>
  2276. </table>
  2277. </td>
  2278. <td class="mlabels-right">
  2279. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2280. </tr>
  2281. </table>
  2282. </div><div class="memdoc">
  2283. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>
  2284. <table class="params">
  2285. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  2286. </table>
  2287. </dd>
  2288. </dl>
  2289. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  2290. </div>
  2291. </div>
  2292. <hr/>The documentation for this class was generated from the following file:<ul>
  2293. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  2294. </ul>
  2295. </div><!-- contents -->
  2296. <!-- start footer part -->
  2297. <hr class="footer"/><address class="footer"><small>
  2298. Generated on Tue Jul 19 2016 06:31:51 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  2299. <img class="footer" src="doxygen.png" alt="doxygen"/>
  2300. </a> 1.8.10
  2301. </small></address>
  2302. </body>
  2303. </html>