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.

2338 lines
102KB

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