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.

2328 lines
97KB

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