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.

2414 line
105KB

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