You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2321 lines
96KB

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