class_sd_fat.html 98 KB

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