class_sd_file_system.html 106 KB

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