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

2321 lines
99KB

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