Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

class_sd_fat_base.html 90KB

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