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.

2905 lines
128KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: SdFat32 Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  65. <a href="class_sd_fat32-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">SdFat32 Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>SD file system class for FAT volumes.
  71. <a href="class_sd_fat32.html#details">More...</a></p>
  72. <p><code>#include &lt;SdFat.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for SdFat32:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_sd_fat32__inherit__graph.png" border="0" usemap="#_sd_fat32_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_sd_fat32_inherit__map" id="_sd_fat32_inherit__map">
  78. <area shape="rect" title="SD file system class for FAT volumes." alt="" coords="47,229,118,256"/>
  79. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,160,181"/>
  80. <area shape="rect" href="class_fat_volume.html" title="Integration class for the FatLib library." alt="" coords="40,80,125,107"/>
  81. <area shape="rect" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices." alt="" coords="38,5,127,32"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <div class="dynheader">
  85. Collaboration diagram for SdFat32:</div>
  86. <div class="dyncontent">
  87. <div class="center"><img src="class_sd_fat32__coll__graph.png" border="0" usemap="#_sd_fat32_coll__map" alt="Collaboration graph"/></div>
  88. <map name="_sd_fat32_coll__map" id="_sd_fat32_coll__map">
  89. <area shape="rect" title="SD file system class for FAT volumes." alt="" coords="47,229,118,256"/>
  90. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,160,181"/>
  91. <area shape="rect" href="class_fat_volume.html" title="Integration class for the FatLib library." alt="" coords="40,80,125,107"/>
  92. <area shape="rect" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices." alt="" coords="38,5,127,32"/>
  93. </map>
  94. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr class="memitem:af3a219ea89bbbf310a61115c9a3d221a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af3a219ea89bbbf310a61115c9a3d221a">begin</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, bool setCwv=true, uint8_t part=1)</td></tr>
  99. <tr class="separator:af3a219ea89bbbf310a61115c9a3d221a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a94081827e77063eacf6fa035143cfde1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a94081827e77063eacf6fa035143cfde1">begin</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> csPin, uint32_t maxSck)</td></tr>
  101. <tr class="separator:a94081827e77063eacf6fa035143cfde1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:abff5f318cfe072b80119f1938cd591bb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#abff5f318cfe072b80119f1938cd591bb">begin</a> (<a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a> csPin=SS)</td></tr>
  103. <tr class="separator:abff5f318cfe072b80119f1938cd591bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ab6343925e4605897d4a1c39be6705760"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#ab6343925e4605897d4a1c39be6705760">begin</a> (<a class="el" href="class_sdio_config.html">SdioConfig</a> sdioConfig)</td></tr>
  105. <tr class="separator:ab6343925e4605897d4a1c39be6705760"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5748f43d73a4272ec8dc302fb0213556"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a5748f43d73a4272ec8dc302fb0213556">begin</a> (<a class="el" href="class_sd_spi_config.html">SdSpiConfig</a> spiConfig)</td></tr>
  107. <tr class="separator:a5748f43d73a4272ec8dc302fb0213556"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1c3ab374b425c27bb6b6ddd55752c056">bytesPerCluster</a> ()</td></tr>
  109. <tr class="separator:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:aaf43a09e71689c257f4b189ee307db4f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aaf43a09e71689c257f4b189ee307db4f">bytesPerClusterShift</a> ()</td></tr>
  111. <tr class="separator:aaf43a09e71689c257f4b189ee307db4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a1eba03c763bab44263735488435731f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1eba03c763bab44263735488435731f8">bytesPerSector</a> ()</td></tr>
  113. <tr class="separator:a1eba03c763bab44263735488435731f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a4e513ab3fcfb95583092793116aa4df5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a4e513ab3fcfb95583092793116aa4df5">bytesPerSectorShift</a> ()</td></tr>
  115. <tr class="separator:a4e513ab3fcfb95583092793116aa4df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:abf74c1e3c714b396e6271aee304c2448"><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_partition.html#abf74c1e3c714b396e6271aee304c2448">cacheClear</a> ()</td></tr>
  117. <tr class="separator:abf74c1e3c714b396e6271aee304c2448"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a1516a55bdab1ee7fe56848808986ae34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card.html">SdCard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a1516a55bdab1ee7fe56848808986ae34">card</a> ()</td></tr>
  119. <tr class="separator:a1516a55bdab1ee7fe56848808986ae34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a64cd10a3ce5ee342d0fd31738f385362"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a64cd10a3ce5ee342d0fd31738f385362">cardBegin</a> (<a class="el" href="class_sdio_config.html">SdioConfig</a> sdioConfig)</td></tr>
  121. <tr class="separator:a64cd10a3ce5ee342d0fd31738f385362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a7a5e3b08f6cdd94cfaa19a1b43df6ed9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a7a5e3b08f6cdd94cfaa19a1b43df6ed9">cardBegin</a> (<a class="el" href="class_sd_spi_config.html">SdSpiConfig</a> spiConfig)</td></tr>
  123. <tr class="separator:a7a5e3b08f6cdd94cfaa19a1b43df6ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a659d921b3efd52d310a33cba69eff18b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a659d921b3efd52d310a33cba69eff18b">chdir</a> ()</td></tr>
  125. <tr class="separator:a659d921b3efd52d310a33cba69eff18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ac0f6cf6ece2285af777c1fdf5cf8c219"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0f6cf6ece2285af777c1fdf5cf8c219">chdir</a> (const char *path)</td></tr>
  127. <tr class="separator:ac0f6cf6ece2285af777c1fdf5cf8c219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ac591520e33ff8ba51e80782a87423872"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac591520e33ff8ba51e80782a87423872">chdir</a> (const String &amp;path)</td></tr>
  129. <tr class="separator:ac591520e33ff8ba51e80782a87423872"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a36fbc19755b066068cac7c4ca578b27b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a36fbc19755b066068cac7c4ca578b27b">chvol</a> ()</td></tr>
  131. <tr class="separator:a36fbc19755b066068cac7c4ca578b27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:aba35645c23735c4833c07bc2b3adcd1f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aba35645c23735c4833c07bc2b3adcd1f">clusterCount</a> () const</td></tr>
  133. <tr class="separator:aba35645c23735c4833c07bc2b3adcd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a7e89ec91780f7dfa060b261c605bf2e5">dataStartSector</a> () const</td></tr>
  135. <tr class="separator:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a0af1e91a311180119b4a2c85d7e6e87e">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  137. <tr class="separator:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a841a42d2ddc34c21dfb208b9a377c777"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a841a42d2ddc34c21dfb208b9a377c777">errorHalt</a> ()</td></tr>
  139. <tr class="separator:a841a42d2ddc34c21dfb208b9a377c777"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a3a0d626662aa29c5b942442d0f6ee0ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a3a0d626662aa29c5b942442d0f6ee0ff">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  141. <tr class="separator:a3a0d626662aa29c5b942442d0f6ee0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a65aab6f19ed26777c2b3a149bbed39b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a65aab6f19ed26777c2b3a149bbed39b5">errorHalt</a> (const char *msg)</td></tr>
  143. <tr class="separator:a65aab6f19ed26777c2b3a149bbed39b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ac9d239810a48c90bd0f3a3e9c4c606a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#ac9d239810a48c90bd0f3a3e9c4c606a9">errorHalt</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  145. <tr class="separator:ac9d239810a48c90bd0f3a3e9c4c606a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ac530fe041855d994a53d2e1b9c33f22d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#ac530fe041855d994a53d2e1b9c33f22d">errorHalt</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const __FlashStringHelper *msg)</td></tr>
  147. <tr class="separator:ac530fe041855d994a53d2e1b9c33f22d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a1691b7a85fc11851a6942de035d73772"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a1691b7a85fc11851a6942de035d73772">errorHalt</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *msg)</td></tr>
  149. <tr class="separator:a1691b7a85fc11851a6942de035d73772"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:afebeeb8af2027f1c9a0b4f1106be9c2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#afebeeb8af2027f1c9a0b4f1106be9c2a">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  151. <tr class="separator:afebeeb8af2027f1c9a0b4f1106be9c2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ab4d5db510feb64a9cd487defe5bb62d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#ab4d5db510feb64a9cd487defe5bb62d9">errorPrint</a> (const char *msg)</td></tr>
  153. <tr class="separator:ab4d5db510feb64a9cd487defe5bb62d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a6793653198ce4c570ae92d2f9436dca9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a6793653198ce4c570ae92d2f9436dca9">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  155. <tr class="separator:a6793653198ce4c570ae92d2f9436dca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a22d184b3266ae7cb31ab47b7203e91ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a22d184b3266ae7cb31ab47b7203e91ac">errorPrint</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  157. <tr class="separator:a22d184b3266ae7cb31ab47b7203e91ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a7d119e8ae896cc4caa073e9f54823f3e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a7d119e8ae896cc4caa073e9f54823f3e">errorPrint</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, char const *msg)</td></tr>
  159. <tr class="separator:a7d119e8ae896cc4caa073e9f54823f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a21541734ad76f64ea24b9f45e2bd6117"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a21541734ad76f64ea24b9f45e2bd6117">exists</a> (const char *path)</td></tr>
  161. <tr class="separator:a21541734ad76f64ea24b9f45e2bd6117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:afb7709e5b9e04265467305b43adf7cef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#afb7709e5b9e04265467305b43adf7cef">exists</a> (const String &amp;path)</td></tr>
  163. <tr class="separator:afb7709e5b9e04265467305b43adf7cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a56b37c3230818b9ae8e0a25c01a370a3">fatCount</a> ()</td></tr>
  165. <tr class="separator:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a6a1ce7d707cf15bea08b63216413e055"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6a1ce7d707cf15bea08b63216413e055">fatStartSector</a> () const</td></tr>
  167. <tr class="separator:a6a1ce7d707cf15bea08b63216413e055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ad45c276232d7093b82f1075e8c488bac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ad45c276232d7093b82f1075e8c488bac">fatType</a> () const</td></tr>
  169. <tr class="separator:ad45c276232d7093b82f1075e8c488bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a303f00204805011d12e70c59ad24e42d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat32.html#a303f00204805011d12e70c59ad24e42d">format</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=<a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>
  171. <tr class="separator:a303f00204805011d12e70c59ad24e42d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ac9689f1e11f59acc5f1b21ed9bb71174">freeClusterCount</a> ()</td></tr>
  173. <tr class="separator:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:ab827224f30eec57255d21cae589911ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ab827224f30eec57255d21cae589911ef">init</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, uint8_t part=1)</td></tr>
  175. <tr class="separator:ab827224f30eec57255d21cae589911ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a5901169e4d6ae992b348df518da68a76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a5901169e4d6ae992b348df518da68a76">initErrorHalt</a> ()</td></tr>
  177. <tr class="separator:a5901169e4d6ae992b348df518da68a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a557ac64877bdd851cd27bf0a00f380c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a557ac64877bdd851cd27bf0a00f380c2">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  179. <tr class="separator:a557ac64877bdd851cd27bf0a00f380c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a9b6c279ebcd8fa95d6b409d099986931"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a9b6c279ebcd8fa95d6b409d099986931">initErrorHalt</a> (const char *msg)</td></tr>
  181. <tr class="separator:a9b6c279ebcd8fa95d6b409d099986931"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a8a249b866a4b24ac0a0753f966aab299"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a8a249b866a4b24ac0a0753f966aab299">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  183. <tr class="separator:a8a249b866a4b24ac0a0753f966aab299"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:acb8180faf22cf72d97ec81330a700b05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#acb8180faf22cf72d97ec81330a700b05">initErrorHalt</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  185. <tr class="separator:acb8180faf22cf72d97ec81330a700b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:aef6fd47c67b9b8498c1398e58422f169"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#aef6fd47c67b9b8498c1398e58422f169">initErrorHalt</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *msg)</td></tr>
  187. <tr class="separator:aef6fd47c67b9b8498c1398e58422f169"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:abe8d75ba435b4decd6b2079b4272d0e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#abe8d75ba435b4decd6b2079b4272d0e5">initErrorPrint</a> ()</td></tr>
  189. <tr class="separator:abe8d75ba435b4decd6b2079b4272d0e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a918474d623107f64b7ab9ca88d6fe46f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a918474d623107f64b7ab9ca88d6fe46f">initErrorPrint</a> (Print *pr)</td></tr>
  191. <tr class="separator:a918474d623107f64b7ab9ca88d6fe46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a455ad7b2a5b6b31551dca08087a3c404"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a455ad7b2a5b6b31551dca08087a3c404">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  193. <tr class="separator:a455ad7b2a5b6b31551dca08087a3c404"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:ac5fc83cac7fd3af0b140a7986b9472f8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac5fc83cac7fd3af0b140a7986b9472f8">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  195. <tr class="separator:ac5fc83cac7fd3af0b140a7986b9472f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:ae40964f357cfff4208812344a0e6f26f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae40964f357cfff4208812344a0e6f26f">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  197. <tr class="separator:ae40964f357cfff4208812344a0e6f26f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:ad455ad05551329865c659cc4676f2d18"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ad455ad05551329865c659cc4676f2d18">ls</a> (uint8_t flags=0)</td></tr>
  199. <tr class="separator:ad455ad05551329865c659cc4676f2d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:ad80bccf8f24ff001a7b9277effc2cc52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ad80bccf8f24ff001a7b9277effc2cc52">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  201. <tr class="separator:ad80bccf8f24ff001a7b9277effc2cc52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:ab423ec4f7e5b58a6d454f328f61fd864"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab423ec4f7e5b58a6d454f328f61fd864">mkdir</a> (const String &amp;path, bool pFlag=true)</td></tr>
  203. <tr class="separator:ab423ec4f7e5b58a6d454f328f61fd864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a22923b86de9c797ce5e19f206dd4ce1f">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>
  205. <tr class="separator:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:af7178b7f13eeae7748640b6268a34812"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af7178b7f13eeae7748640b6268a34812">open</a> (const String &amp;path, oflag_t oflag=0X00)</td></tr>
  207. <tr class="separator:af7178b7f13eeae7748640b6268a34812"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:a234e80318c39229fe968a182b172148c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a234e80318c39229fe968a182b172148c">printFatType</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  209. <tr class="separator:a234e80318c39229fe968a182b172148c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:a6a8ba118e754b2b9fa0f34410163e228"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a6a8ba118e754b2b9fa0f34410163e228">printSdError</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  211. <tr class="separator:a6a8ba118e754b2b9fa0f34410163e228"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:abb11d05ef407775bcdb9b14a6c608433"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abb11d05ef407775bcdb9b14a6c608433">remove</a> (const char *path)</td></tr>
  213. <tr class="separator:abb11d05ef407775bcdb9b14a6c608433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:a994411f55df474be6be87f06100c2c39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a994411f55df474be6be87f06100c2c39">remove</a> (const String &amp;path)</td></tr>
  215. <tr class="separator:a994411f55df474be6be87f06100c2c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:a5e4ea6c91569dc435c7aacd7ba704911"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  217. <tr class="separator:a5e4ea6c91569dc435c7aacd7ba704911"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:aa7015c0f694261780081c79c05d0882d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa7015c0f694261780081c79c05d0882d">rename</a> (const String &amp;oldPath, const String &amp;newPath)</td></tr>
  219. <tr class="separator:aa7015c0f694261780081c79c05d0882d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:af1181990bcece7dbb7d19293dd4fe11a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af1181990bcece7dbb7d19293dd4fe11a">rmdir</a> (const char *path)</td></tr>
  221. <tr class="separator:af1181990bcece7dbb7d19293dd4fe11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <tr class="memitem:a105f437fb649b57ed3823f8ff1a2f37e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a105f437fb649b57ed3823f8ff1a2f37e">rmdir</a> (const String &amp;path)</td></tr>
  223. <tr class="separator:a105f437fb649b57ed3823f8ff1a2f37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  224. <tr class="memitem:a6ba99b9711269b5ab6ca091b88e81288"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6ba99b9711269b5ab6ca091b88e81288">rootDirEntryCount</a> () const</td></tr>
  225. <tr class="separator:a6ba99b9711269b5ab6ca091b88e81288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a5d005e0f6fd4b84da8a5ebdea03aaf85">rootDirStart</a> () const</td></tr>
  227. <tr class="separator:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:af2bb8fea732f9272a2e98772fbcc4595"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#af2bb8fea732f9272a2e98772fbcc4595">sdErrorCode</a> ()</td></tr>
  229. <tr class="separator:af2bb8fea732f9272a2e98772fbcc4595"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. <tr class="memitem:a5f8f363b6c23f1d8bfeb858c946f1994"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a5f8f363b6c23f1d8bfeb858c946f1994">sdErrorData</a> ()</td></tr>
  231. <tr class="separator:a5f8f363b6c23f1d8bfeb858c946f1994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr class="memitem:a6b970fa2e06de1a826b09e251dc3119b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6b970fa2e06de1a826b09e251dc3119b">sectorMask</a> ()</td></tr>
  233. <tr class="separator:a6b970fa2e06de1a826b09e251dc3119b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  234. <tr class="memitem:a836546c368e6ffe117e6ab8775d23eba"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a836546c368e6ffe117e6ab8775d23eba">sectorsPerCluster</a> () const</td></tr>
  235. <tr class="separator:a836546c368e6ffe117e6ab8775d23eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  236. <tr class="memitem:a593a27482ff8d993542d6f82bd92e26c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a593a27482ff8d993542d6f82bd92e26c">sectorsPerClusterShift</a> () const</td></tr>
  237. <tr class="separator:a593a27482ff8d993542d6f82bd92e26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  238. <tr class="memitem:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1f5c7599333dbe152a3cdd60623ce6d1">sectorsPerFat</a> () const</td></tr>
  239. <tr class="separator:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  240. <tr class="memitem:a86a08bf789e33567418465b9b12751e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a86a08bf789e33567418465b9b12751e2">truncate</a> (const char *path, uint32_t length)</td></tr>
  241. <tr class="separator:a86a08bf789e33567418465b9b12751e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. <tr class="memitem:a97ef39ec02c38c0772f0029d42edcb46"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a97ef39ec02c38c0772f0029d42edcb46">truncate</a> (const String &amp;path, uint32_t length)</td></tr>
  243. <tr class="separator:a97ef39ec02c38c0772f0029d42edcb46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  244. <tr class="memitem:a20ed1868a6498cd336364c22d1df28a5"><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_sd_base.html#a20ed1868a6498cd336364c22d1df28a5">vol</a> ()</td></tr>
  245. <tr class="separator:a20ed1868a6498cd336364c22d1df28a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  246. <tr class="memitem:a1f1de2aac5384475b67506f86199e4c8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a1f1de2aac5384475b67506f86199e4c8">volumeBegin</a> ()</td></tr>
  247. <tr class="separator:a1f1de2aac5384475b67506f86199e4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  248. <tr class="memitem:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a916ba7d67711bb62daf12ecd47ca4b8e">volumeSectorCount</a> () const</td></tr>
  249. <tr class="separator:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  250. </table><table class="memberdecls">
  251. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  252. Static Public Member Functions</h2></td></tr>
  253. <tr class="memitem:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06acd4a434456b6a4644ff79a0bf0a24">cwv</a> ()</td></tr>
  254. <tr class="separator:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  255. </table>
  256. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  257. <div class="textblock"><p>SD file system class for FAT volumes. </p>
  258. </div><h2 class="groupheader">Member Function Documentation</h2>
  259. <a id="af3a219ea89bbbf310a61115c9a3d221a"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#af3a219ea89bbbf310a61115c9a3d221a">&#9670;&nbsp;</a></span>begin() <span class="overload">[1/5]</span></h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="mlabels">
  264. <tr>
  265. <td class="mlabels-left">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">bool FatVolume::begin </td>
  269. <td>(</td>
  270. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  271. <td class="paramname"><em>dev</em>, </td>
  272. </tr>
  273. <tr>
  274. <td class="paramkey"></td>
  275. <td></td>
  276. <td class="paramtype">bool&#160;</td>
  277. <td class="paramname"><em>setCwv</em> = <code>true</code>, </td>
  278. </tr>
  279. <tr>
  280. <td class="paramkey"></td>
  281. <td></td>
  282. <td class="paramtype">uint8_t&#160;</td>
  283. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  284. </tr>
  285. <tr>
  286. <td></td>
  287. <td>)</td>
  288. <td></td><td></td>
  289. </tr>
  290. </table>
  291. </td>
  292. <td class="mlabels-right">
  293. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Initialize an <a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library.">FatVolume</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Device block driver. </td></tr>
  300. <tr><td class="paramdir">[in]</td><td class="paramname">setCwv</td><td>Set current working volume if true. </td></tr>
  301. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  302. </table>
  303. </dd>
  304. </dl>
  305. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  306. </div>
  307. </div>
  308. <a id="a94081827e77063eacf6fa035143cfde1"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a94081827e77063eacf6fa035143cfde1">&#9670;&nbsp;</a></span>begin() <span class="overload">[2/5]</span></h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="mlabels">
  313. <tr>
  314. <td class="mlabels-left">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::begin </td>
  318. <td>(</td>
  319. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  320. <td class="paramname"><em>csPin</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">uint32_t&#160;</td>
  326. <td class="paramname"><em>maxSck</em>&#160;</td>
  327. </tr>
  328. <tr>
  329. <td></td>
  330. <td>)</td>
  331. <td></td><td></td>
  332. </tr>
  333. </table>
  334. </td>
  335. <td class="mlabels-right">
  336. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Initialize SD card and file system.</p>
  341. <dl class="params"><dt>Parameters</dt><dd>
  342. <table class="params">
  343. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  344. <tr><td class="paramdir">[in]</td><td class="paramname">maxSck</td><td>Maximum SCK frequency. </td></tr>
  345. </table>
  346. </dd>
  347. </dl>
  348. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  349. </div>
  350. </div>
  351. <a id="abff5f318cfe072b80119f1938cd591bb"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#abff5f318cfe072b80119f1938cd591bb">&#9670;&nbsp;</a></span>begin() <span class="overload">[3/5]</span></h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="mlabels">
  356. <tr>
  357. <td class="mlabels-left">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::begin </td>
  361. <td>(</td>
  362. <td class="paramtype"><a class="el" href="_sd_fat_config_8h.html#a7a489fb14a59adf251794342604fc5ea">SdCsPin_t</a>&#160;</td>
  363. <td class="paramname"><em>csPin</em> = <code>SS</code></td><td>)</td>
  364. <td></td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Initialize SD card and file system.</p>
  374. <dl class="params"><dt>Parameters</dt><dd>
  375. <table class="params">
  376. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  377. </table>
  378. </dd>
  379. </dl>
  380. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  381. </div>
  382. </div>
  383. <a id="ab6343925e4605897d4a1c39be6705760"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#ab6343925e4605897d4a1c39be6705760">&#9670;&nbsp;</a></span>begin() <span class="overload">[4/5]</span></h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="mlabels">
  388. <tr>
  389. <td class="mlabels-left">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::begin </td>
  393. <td>(</td>
  394. <td class="paramtype"><a class="el" href="class_sdio_config.html">SdioConfig</a>&#160;</td>
  395. <td class="paramname"><em>sdioConfig</em></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </td>
  400. <td class="mlabels-right">
  401. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>Initialize SD card and file system for SDIO mode.</p>
  406. <dl class="params"><dt>Parameters</dt><dd>
  407. <table class="params">
  408. <tr><td class="paramdir">[in]</td><td class="paramname">sdioConfig</td><td>SDIO configuration. </td></tr>
  409. </table>
  410. </dd>
  411. </dl>
  412. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  413. </div>
  414. </div>
  415. <a id="a5748f43d73a4272ec8dc302fb0213556"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a5748f43d73a4272ec8dc302fb0213556">&#9670;&nbsp;</a></span>begin() <span class="overload">[5/5]</span></h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::begin </td>
  425. <td>(</td>
  426. <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>
  427. <td class="paramname"><em>spiConfig</em></td><td>)</td>
  428. <td></td>
  429. </tr>
  430. </table>
  431. </td>
  432. <td class="mlabels-right">
  433. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. <p>Initialize SD card and file system for SPI mode.</p>
  438. <dl class="params"><dt>Parameters</dt><dd>
  439. <table class="params">
  440. <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI configuration. </td></tr>
  441. </table>
  442. </dd>
  443. </dl>
  444. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  445. </div>
  446. </div>
  447. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>
  448. <h2 class="memtitle"><span class="permalink"><a href="#a1c3ab374b425c27bb6b6ddd55752c056">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="mlabels">
  452. <tr>
  453. <td class="mlabels-left">
  454. <table class="memname">
  455. <tr>
  456. <td class="memname">uint16_t FatPartition::bytesPerCluster </td>
  457. <td>(</td>
  458. <td class="paramname"></td><td>)</td>
  459. <td></td>
  460. </tr>
  461. </table>
  462. </td>
  463. <td class="mlabels-right">
  464. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>
  469. </div>
  470. </div>
  471. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>
  472. <h2 class="memtitle"><span class="permalink"><a href="#aaf43a09e71689c257f4b189ee307db4f">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  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">uint8_t FatPartition::bytesPerClusterShift </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 shift count required to multiply by bytesPerCluster. </dd></dl>
  493. </div>
  494. </div>
  495. <a id="a1eba03c763bab44263735488435731f8"></a>
  496. <h2 class="memtitle"><span class="permalink"><a href="#a1eba03c763bab44263735488435731f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  497. <div class="memitem">
  498. <div class="memproto">
  499. <table class="mlabels">
  500. <tr>
  501. <td class="mlabels-left">
  502. <table class="memname">
  503. <tr>
  504. <td class="memname">uint16_t FatPartition::bytesPerSector </td>
  505. <td>(</td>
  506. <td class="paramname"></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. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>
  517. </div>
  518. </div>
  519. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>
  520. <h2 class="memtitle"><span class="permalink"><a href="#a4e513ab3fcfb95583092793116aa4df5">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <table class="mlabels">
  524. <tr>
  525. <td class="mlabels-left">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>
  529. <td>(</td>
  530. <td class="paramname"></td><td>)</td>
  531. <td></td>
  532. </tr>
  533. </table>
  534. </td>
  535. <td class="mlabels-right">
  536. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  541. </div>
  542. </div>
  543. <a id="abf74c1e3c714b396e6271aee304c2448"></a>
  544. <h2 class="memtitle"><span class="permalink"><a href="#abf74c1e3c714b396e6271aee304c2448">&#9670;&nbsp;</a></span>cacheClear()</h2>
  545. <div class="memitem">
  546. <div class="memproto">
  547. <table class="mlabels">
  548. <tr>
  549. <td class="mlabels-left">
  550. <table class="memname">
  551. <tr>
  552. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>
  553. <td>(</td>
  554. <td class="paramname"></td><td>)</td>
  555. <td></td>
  556. </tr>
  557. </table>
  558. </td>
  559. <td class="mlabels-right">
  560. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <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>
  565. </div>
  566. </div>
  567. <a id="a1516a55bdab1ee7fe56848808986ae34"></a>
  568. <h2 class="memtitle"><span class="permalink"><a href="#a1516a55bdab1ee7fe56848808986ae34">&#9670;&nbsp;</a></span>card()</h2>
  569. <div class="memitem">
  570. <div class="memproto">
  571. <table class="mlabels">
  572. <tr>
  573. <td class="mlabels-left">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname"><a class="el" href="class_sd_spi_card.html">SdCard</a>* <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::card </td>
  577. <td>(</td>
  578. <td class="paramname"></td><td>)</td>
  579. <td></td>
  580. </tr>
  581. </table>
  582. </td>
  583. <td class="mlabels-right">
  584. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  585. </tr>
  586. </table>
  587. </div><div class="memdoc">
  588. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object. </dd></dl>
  589. </div>
  590. </div>
  591. <a id="a64cd10a3ce5ee342d0fd31738f385362"></a>
  592. <h2 class="memtitle"><span class="permalink"><a href="#a64cd10a3ce5ee342d0fd31738f385362">&#9670;&nbsp;</a></span>cardBegin() <span class="overload">[1/2]</span></h2>
  593. <div class="memitem">
  594. <div class="memproto">
  595. <table class="mlabels">
  596. <tr>
  597. <td class="mlabels-left">
  598. <table class="memname">
  599. <tr>
  600. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::cardBegin </td>
  601. <td>(</td>
  602. <td class="paramtype"><a class="el" href="class_sdio_config.html">SdioConfig</a>&#160;</td>
  603. <td class="paramname"><em>sdioConfig</em></td><td>)</td>
  604. <td></td>
  605. </tr>
  606. </table>
  607. </td>
  608. <td class="mlabels-right">
  609. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <p>Initialize SD card in SDIO mode.</p>
  614. <dl class="params"><dt>Parameters</dt><dd>
  615. <table class="params">
  616. <tr><td class="paramdir">[in]</td><td class="paramname">sdioConfig</td><td>SDIO configuration. </td></tr>
  617. </table>
  618. </dd>
  619. </dl>
  620. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  621. </div>
  622. </div>
  623. <a id="a7a5e3b08f6cdd94cfaa19a1b43df6ed9"></a>
  624. <h2 class="memtitle"><span class="permalink"><a href="#a7a5e3b08f6cdd94cfaa19a1b43df6ed9">&#9670;&nbsp;</a></span>cardBegin() <span class="overload">[2/2]</span></h2>
  625. <div class="memitem">
  626. <div class="memproto">
  627. <table class="mlabels">
  628. <tr>
  629. <td class="mlabels-left">
  630. <table class="memname">
  631. <tr>
  632. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::cardBegin </td>
  633. <td>(</td>
  634. <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>
  635. <td class="paramname"><em>spiConfig</em></td><td>)</td>
  636. <td></td>
  637. </tr>
  638. </table>
  639. </td>
  640. <td class="mlabels-right">
  641. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  642. </tr>
  643. </table>
  644. </div><div class="memdoc">
  645. <p>Initialize SD card in SPI mode.</p>
  646. <dl class="params"><dt>Parameters</dt><dd>
  647. <table class="params">
  648. <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI configuration. </td></tr>
  649. </table>
  650. </dd>
  651. </dl>
  652. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  653. </div>
  654. </div>
  655. <a id="a659d921b3efd52d310a33cba69eff18b"></a>
  656. <h2 class="memtitle"><span class="permalink"><a href="#a659d921b3efd52d310a33cba69eff18b">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/3]</span></h2>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="mlabels">
  660. <tr>
  661. <td class="mlabels-left">
  662. <table class="memname">
  663. <tr>
  664. <td class="memname">bool FatVolume::chdir </td>
  665. <td>(</td>
  666. <td class="paramname"></td><td>)</td>
  667. <td></td>
  668. </tr>
  669. </table>
  670. </td>
  671. <td class="mlabels-right">
  672. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  673. </tr>
  674. </table>
  675. </div><div class="memdoc">
  676. <p>Set volume working directory to root. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  677. </div>
  678. </div>
  679. <a id="ac0f6cf6ece2285af777c1fdf5cf8c219"></a>
  680. <h2 class="memtitle"><span class="permalink"><a href="#ac0f6cf6ece2285af777c1fdf5cf8c219">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/3]</span></h2>
  681. <div class="memitem">
  682. <div class="memproto">
  683. <table class="mlabels">
  684. <tr>
  685. <td class="mlabels-left">
  686. <table class="memname">
  687. <tr>
  688. <td class="memname">bool FatVolume::chdir </td>
  689. <td>(</td>
  690. <td class="paramtype">const char *&#160;</td>
  691. <td class="paramname"><em>path</em></td><td>)</td>
  692. <td></td>
  693. </tr>
  694. </table>
  695. </td>
  696. <td class="mlabels-right">
  697. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  698. </tr>
  699. </table>
  700. </div><div class="memdoc">
  701. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  702. <table class="params">
  703. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  704. </table>
  705. </dd>
  706. </dl>
  707. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  708. </div>
  709. </div>
  710. <a id="ac591520e33ff8ba51e80782a87423872"></a>
  711. <h2 class="memtitle"><span class="permalink"><a href="#ac591520e33ff8ba51e80782a87423872">&#9670;&nbsp;</a></span>chdir() <span class="overload">[3/3]</span></h2>
  712. <div class="memitem">
  713. <div class="memproto">
  714. <table class="mlabels">
  715. <tr>
  716. <td class="mlabels-left">
  717. <table class="memname">
  718. <tr>
  719. <td class="memname">bool FatVolume::chdir </td>
  720. <td>(</td>
  721. <td class="paramtype">const String &amp;&#160;</td>
  722. <td class="paramname"><em>path</em></td><td>)</td>
  723. <td></td>
  724. </tr>
  725. </table>
  726. </td>
  727. <td class="mlabels-right">
  728. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  729. </tr>
  730. </table>
  731. </div><div class="memdoc">
  732. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  733. <table class="params">
  734. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  735. </table>
  736. </dd>
  737. </dl>
  738. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  739. </div>
  740. </div>
  741. <a id="a36fbc19755b066068cac7c4ca578b27b"></a>
  742. <h2 class="memtitle"><span class="permalink"><a href="#a36fbc19755b066068cac7c4ca578b27b">&#9670;&nbsp;</a></span>chvol()</h2>
  743. <div class="memitem">
  744. <div class="memproto">
  745. <table class="mlabels">
  746. <tr>
  747. <td class="mlabels-left">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">void FatVolume::chvol </td>
  751. <td>(</td>
  752. <td class="paramname"></td><td>)</td>
  753. <td></td>
  754. </tr>
  755. </table>
  756. </td>
  757. <td class="mlabels-right">
  758. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  759. </tr>
  760. </table>
  761. </div><div class="memdoc">
  762. <p>Change global current working volume to this volume. </p>
  763. </div>
  764. </div>
  765. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>
  766. <h2 class="memtitle"><span class="permalink"><a href="#aba35645c23735c4833c07bc2b3adcd1f">&#9670;&nbsp;</a></span>clusterCount()</h2>
  767. <div class="memitem">
  768. <div class="memproto">
  769. <table class="mlabels">
  770. <tr>
  771. <td class="mlabels-left">
  772. <table class="memname">
  773. <tr>
  774. <td class="memname">uint32_t FatPartition::clusterCount </td>
  775. <td>(</td>
  776. <td class="paramname"></td><td>)</td>
  777. <td> const</td>
  778. </tr>
  779. </table>
  780. </td>
  781. <td class="mlabels-right">
  782. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  783. </tr>
  784. </table>
  785. </div><div class="memdoc">
  786. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  787. </div>
  788. </div>
  789. <a id="a06acd4a434456b6a4644ff79a0bf0a24"></a>
  790. <h2 class="memtitle"><span class="permalink"><a href="#a06acd4a434456b6a4644ff79a0bf0a24">&#9670;&nbsp;</a></span>cwv()</h2>
  791. <div class="memitem">
  792. <div class="memproto">
  793. <table class="mlabels">
  794. <tr>
  795. <td class="mlabels-left">
  796. <table class="memname">
  797. <tr>
  798. <td class="memname">static <a class="el" href="class_fat_volume.html">FatVolume</a>* FatVolume::cwv </td>
  799. <td>(</td>
  800. <td class="paramname"></td><td>)</td>
  801. <td></td>
  802. </tr>
  803. </table>
  804. </td>
  805. <td class="mlabels-right">
  806. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  807. </tr>
  808. </table>
  809. </div><div class="memdoc">
  810. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  811. </div>
  812. </div>
  813. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>
  814. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  815. <div class="memitem">
  816. <div class="memproto">
  817. <table class="mlabels">
  818. <tr>
  819. <td class="mlabels-left">
  820. <table class="memname">
  821. <tr>
  822. <td class="memname">uint32_t FatPartition::dataStartSector </td>
  823. <td>(</td>
  824. <td class="paramname"></td><td>)</td>
  825. <td> const</td>
  826. </tr>
  827. </table>
  828. </td>
  829. <td class="mlabels-right">
  830. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  831. </tr>
  832. </table>
  833. </div><div class="memdoc">
  834. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  835. </div>
  836. </div>
  837. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>
  838. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>
  839. <div class="memitem">
  840. <div class="memproto">
  841. <table class="mlabels">
  842. <tr>
  843. <td class="mlabels-left">
  844. <table class="memname">
  845. <tr>
  846. <td class="memname">int8_t FatPartition::dbgFat </td>
  847. <td>(</td>
  848. <td class="paramtype">uint32_t&#160;</td>
  849. <td class="paramname"><em>n</em>, </td>
  850. </tr>
  851. <tr>
  852. <td class="paramkey"></td>
  853. <td></td>
  854. <td class="paramtype">uint32_t *&#160;</td>
  855. <td class="paramname"><em>v</em>&#160;</td>
  856. </tr>
  857. <tr>
  858. <td></td>
  859. <td>)</td>
  860. <td></td><td></td>
  861. </tr>
  862. </table>
  863. </td>
  864. <td class="mlabels-right">
  865. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  866. </tr>
  867. </table>
  868. </div><div class="memdoc">
  869. <p>Debug access to FAT table</p>
  870. <dl class="params"><dt>Parameters</dt><dd>
  871. <table class="params">
  872. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  873. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  874. </table>
  875. </dd>
  876. </dl>
  877. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>
  878. </div>
  879. </div>
  880. <a id="a841a42d2ddc34c21dfb208b9a377c777"></a>
  881. <h2 class="memtitle"><span class="permalink"><a href="#a841a42d2ddc34c21dfb208b9a377c777">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[1/6]</span></h2>
  882. <div class="memitem">
  883. <div class="memproto">
  884. <table class="mlabels">
  885. <tr>
  886. <td class="mlabels-left">
  887. <table class="memname">
  888. <tr>
  889. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  890. <td>(</td>
  891. <td class="paramname"></td><td>)</td>
  892. <td></td>
  893. </tr>
  894. </table>
  895. </td>
  896. <td class="mlabels-right">
  897. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  898. </tr>
  899. </table>
  900. </div><div class="memdoc">
  901. <p>Print error info to Serial and halt. </p>
  902. </div>
  903. </div>
  904. <a id="a3a0d626662aa29c5b942442d0f6ee0ff"></a>
  905. <h2 class="memtitle"><span class="permalink"><a href="#a3a0d626662aa29c5b942442d0f6ee0ff">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[2/6]</span></h2>
  906. <div class="memitem">
  907. <div class="memproto">
  908. <table class="mlabels">
  909. <tr>
  910. <td class="mlabels-left">
  911. <table class="memname">
  912. <tr>
  913. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  914. <td>(</td>
  915. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  916. <td class="paramname"><em>msg</em></td><td>)</td>
  917. <td></td>
  918. </tr>
  919. </table>
  920. </td>
  921. <td class="mlabels-right">
  922. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  923. </tr>
  924. </table>
  925. </div><div class="memdoc">
  926. <p>Print msg to Serial and halt.</p>
  927. <dl class="params"><dt>Parameters</dt><dd>
  928. <table class="params">
  929. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  930. </table>
  931. </dd>
  932. </dl>
  933. </div>
  934. </div>
  935. <a id="a65aab6f19ed26777c2b3a149bbed39b5"></a>
  936. <h2 class="memtitle"><span class="permalink"><a href="#a65aab6f19ed26777c2b3a149bbed39b5">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[3/6]</span></h2>
  937. <div class="memitem">
  938. <div class="memproto">
  939. <table class="mlabels">
  940. <tr>
  941. <td class="mlabels-left">
  942. <table class="memname">
  943. <tr>
  944. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  945. <td>(</td>
  946. <td class="paramtype">const char *&#160;</td>
  947. <td class="paramname"><em>msg</em></td><td>)</td>
  948. <td></td>
  949. </tr>
  950. </table>
  951. </td>
  952. <td class="mlabels-right">
  953. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  954. </tr>
  955. </table>
  956. </div><div class="memdoc">
  957. <p>Print error info and halt.</p>
  958. <dl class="params"><dt>Parameters</dt><dd>
  959. <table class="params">
  960. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  961. </table>
  962. </dd>
  963. </dl>
  964. </div>
  965. </div>
  966. <a id="ac9d239810a48c90bd0f3a3e9c4c606a9"></a>
  967. <h2 class="memtitle"><span class="permalink"><a href="#ac9d239810a48c90bd0f3a3e9c4c606a9">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[4/6]</span></h2>
  968. <div class="memitem">
  969. <div class="memproto">
  970. <table class="mlabels">
  971. <tr>
  972. <td class="mlabels-left">
  973. <table class="memname">
  974. <tr>
  975. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  976. <td>(</td>
  977. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  978. <td class="paramname"><em>pr</em></td><td>)</td>
  979. <td></td>
  980. </tr>
  981. </table>
  982. </td>
  983. <td class="mlabels-right">
  984. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  985. </tr>
  986. </table>
  987. </div><div class="memdoc">
  988. <p>Print error info and halt.</p>
  989. <dl class="params"><dt>Parameters</dt><dd>
  990. <table class="params">
  991. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  992. </table>
  993. </dd>
  994. </dl>
  995. </div>
  996. </div>
  997. <a id="ac530fe041855d994a53d2e1b9c33f22d"></a>
  998. <h2 class="memtitle"><span class="permalink"><a href="#ac530fe041855d994a53d2e1b9c33f22d">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[5/6]</span></h2>
  999. <div class="memitem">
  1000. <div class="memproto">
  1001. <table class="mlabels">
  1002. <tr>
  1003. <td class="mlabels-left">
  1004. <table class="memname">
  1005. <tr>
  1006. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  1007. <td>(</td>
  1008. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1009. <td class="paramname"><em>pr</em>, </td>
  1010. </tr>
  1011. <tr>
  1012. <td class="paramkey"></td>
  1013. <td></td>
  1014. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1015. <td class="paramname"><em>msg</em>&#160;</td>
  1016. </tr>
  1017. <tr>
  1018. <td></td>
  1019. <td>)</td>
  1020. <td></td><td></td>
  1021. </tr>
  1022. </table>
  1023. </td>
  1024. <td class="mlabels-right">
  1025. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1026. </tr>
  1027. </table>
  1028. </div><div class="memdoc">
  1029. <p>Print msg and halt.</p>
  1030. <dl class="params"><dt>Parameters</dt><dd>
  1031. <table class="params">
  1032. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1033. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1034. </table>
  1035. </dd>
  1036. </dl>
  1037. </div>
  1038. </div>
  1039. <a id="a1691b7a85fc11851a6942de035d73772"></a>
  1040. <h2 class="memtitle"><span class="permalink"><a href="#a1691b7a85fc11851a6942de035d73772">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[6/6]</span></h2>
  1041. <div class="memitem">
  1042. <div class="memproto">
  1043. <table class="mlabels">
  1044. <tr>
  1045. <td class="mlabels-left">
  1046. <table class="memname">
  1047. <tr>
  1048. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorHalt </td>
  1049. <td>(</td>
  1050. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1051. <td class="paramname"><em>pr</em>, </td>
  1052. </tr>
  1053. <tr>
  1054. <td class="paramkey"></td>
  1055. <td></td>
  1056. <td class="paramtype">const char *&#160;</td>
  1057. <td class="paramname"><em>msg</em>&#160;</td>
  1058. </tr>
  1059. <tr>
  1060. <td></td>
  1061. <td>)</td>
  1062. <td></td><td></td>
  1063. </tr>
  1064. </table>
  1065. </td>
  1066. <td class="mlabels-right">
  1067. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1068. </tr>
  1069. </table>
  1070. </div><div class="memdoc">
  1071. <p>Print error info and halt.</p>
  1072. <dl class="params"><dt>Parameters</dt><dd>
  1073. <table class="params">
  1074. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1075. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1076. </table>
  1077. </dd>
  1078. </dl>
  1079. </div>
  1080. </div>
  1081. <a id="afebeeb8af2027f1c9a0b4f1106be9c2a"></a>
  1082. <h2 class="memtitle"><span class="permalink"><a href="#afebeeb8af2027f1c9a0b4f1106be9c2a">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[1/5]</span></h2>
  1083. <div class="memitem">
  1084. <div class="memproto">
  1085. <table class="mlabels">
  1086. <tr>
  1087. <td class="mlabels-left">
  1088. <table class="memname">
  1089. <tr>
  1090. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorPrint </td>
  1091. <td>(</td>
  1092. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1093. <td class="paramname"><em>msg</em></td><td>)</td>
  1094. <td></td>
  1095. </tr>
  1096. </table>
  1097. </td>
  1098. <td class="mlabels-right">
  1099. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1100. </tr>
  1101. </table>
  1102. </div><div class="memdoc">
  1103. <p>Print msg, any SD error code.</p>
  1104. <dl class="params"><dt>Parameters</dt><dd>
  1105. <table class="params">
  1106. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1107. </table>
  1108. </dd>
  1109. </dl>
  1110. </div>
  1111. </div>
  1112. <a id="ab4d5db510feb64a9cd487defe5bb62d9"></a>
  1113. <h2 class="memtitle"><span class="permalink"><a href="#ab4d5db510feb64a9cd487defe5bb62d9">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[2/5]</span></h2>
  1114. <div class="memitem">
  1115. <div class="memproto">
  1116. <table class="mlabels">
  1117. <tr>
  1118. <td class="mlabels-left">
  1119. <table class="memname">
  1120. <tr>
  1121. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorPrint </td>
  1122. <td>(</td>
  1123. <td class="paramtype">const char *&#160;</td>
  1124. <td class="paramname"><em>msg</em></td><td>)</td>
  1125. <td></td>
  1126. </tr>
  1127. </table>
  1128. </td>
  1129. <td class="mlabels-right">
  1130. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1131. </tr>
  1132. </table>
  1133. </div><div class="memdoc">
  1134. <p>Print msg, any SD error code.</p>
  1135. <dl class="params"><dt>Parameters</dt><dd>
  1136. <table class="params">
  1137. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1138. </table>
  1139. </dd>
  1140. </dl>
  1141. </div>
  1142. </div>
  1143. <a id="a6793653198ce4c570ae92d2f9436dca9"></a>
  1144. <h2 class="memtitle"><span class="permalink"><a href="#a6793653198ce4c570ae92d2f9436dca9">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[3/5]</span></h2>
  1145. <div class="memitem">
  1146. <div class="memproto">
  1147. <table class="mlabels">
  1148. <tr>
  1149. <td class="mlabels-left">
  1150. <table class="memname">
  1151. <tr>
  1152. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorPrint </td>
  1153. <td>(</td>
  1154. <td class="paramtype">Print *&#160;</td>
  1155. <td class="paramname"><em>pr</em>, </td>
  1156. </tr>
  1157. <tr>
  1158. <td class="paramkey"></td>
  1159. <td></td>
  1160. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1161. <td class="paramname"><em>msg</em>&#160;</td>
  1162. </tr>
  1163. <tr>
  1164. <td></td>
  1165. <td>)</td>
  1166. <td></td><td></td>
  1167. </tr>
  1168. </table>
  1169. </td>
  1170. <td class="mlabels-right">
  1171. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1172. </tr>
  1173. </table>
  1174. </div><div class="memdoc">
  1175. <p>Print msg, any SD error code.</p>
  1176. <dl class="params"><dt>Parameters</dt><dd>
  1177. <table class="params">
  1178. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1179. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1180. </table>
  1181. </dd>
  1182. </dl>
  1183. </div>
  1184. </div>
  1185. <a id="a22d184b3266ae7cb31ab47b7203e91ac"></a>
  1186. <h2 class="memtitle"><span class="permalink"><a href="#a22d184b3266ae7cb31ab47b7203e91ac">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[4/5]</span></h2>
  1187. <div class="memitem">
  1188. <div class="memproto">
  1189. <table class="mlabels">
  1190. <tr>
  1191. <td class="mlabels-left">
  1192. <table class="memname">
  1193. <tr>
  1194. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorPrint </td>
  1195. <td>(</td>
  1196. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1197. <td class="paramname"><em>pr</em></td><td>)</td>
  1198. <td></td>
  1199. </tr>
  1200. </table>
  1201. </td>
  1202. <td class="mlabels-right">
  1203. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1204. </tr>
  1205. </table>
  1206. </div><div class="memdoc">
  1207. <p>Print SD errorCode and errorData.</p>
  1208. <dl class="params"><dt>Parameters</dt><dd>
  1209. <table class="params">
  1210. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1211. </table>
  1212. </dd>
  1213. </dl>
  1214. </div>
  1215. </div>
  1216. <a id="a7d119e8ae896cc4caa073e9f54823f3e"></a>
  1217. <h2 class="memtitle"><span class="permalink"><a href="#a7d119e8ae896cc4caa073e9f54823f3e">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[5/5]</span></h2>
  1218. <div class="memitem">
  1219. <div class="memproto">
  1220. <table class="mlabels">
  1221. <tr>
  1222. <td class="mlabels-left">
  1223. <table class="memname">
  1224. <tr>
  1225. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::errorPrint </td>
  1226. <td>(</td>
  1227. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1228. <td class="paramname"><em>pr</em>, </td>
  1229. </tr>
  1230. <tr>
  1231. <td class="paramkey"></td>
  1232. <td></td>
  1233. <td class="paramtype">char const *&#160;</td>
  1234. <td class="paramname"><em>msg</em>&#160;</td>
  1235. </tr>
  1236. <tr>
  1237. <td></td>
  1238. <td>)</td>
  1239. <td></td><td></td>
  1240. </tr>
  1241. </table>
  1242. </td>
  1243. <td class="mlabels-right">
  1244. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1245. </tr>
  1246. </table>
  1247. </div><div class="memdoc">
  1248. <p>Print msg, any SD error code.</p>
  1249. <dl class="params"><dt>Parameters</dt><dd>
  1250. <table class="params">
  1251. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1252. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1253. </table>
  1254. </dd>
  1255. </dl>
  1256. </div>
  1257. </div>
  1258. <a id="a21541734ad76f64ea24b9f45e2bd6117"></a>
  1259. <h2 class="memtitle"><span class="permalink"><a href="#a21541734ad76f64ea24b9f45e2bd6117">&#9670;&nbsp;</a></span>exists() <span class="overload">[1/2]</span></h2>
  1260. <div class="memitem">
  1261. <div class="memproto">
  1262. <table class="mlabels">
  1263. <tr>
  1264. <td class="mlabels-left">
  1265. <table class="memname">
  1266. <tr>
  1267. <td class="memname">bool FatVolume::exists </td>
  1268. <td>(</td>
  1269. <td class="paramtype">const char *&#160;</td>
  1270. <td class="paramname"><em>path</em></td><td>)</td>
  1271. <td></td>
  1272. </tr>
  1273. </table>
  1274. </td>
  1275. <td class="mlabels-right">
  1276. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1277. </tr>
  1278. </table>
  1279. </div><div class="memdoc">
  1280. <p>Test for the existence of a file.</p>
  1281. <dl class="params"><dt>Parameters</dt><dd>
  1282. <table class="params">
  1283. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  1284. </table>
  1285. </dd>
  1286. </dl>
  1287. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  1288. </div>
  1289. </div>
  1290. <a id="afb7709e5b9e04265467305b43adf7cef"></a>
  1291. <h2 class="memtitle"><span class="permalink"><a href="#afb7709e5b9e04265467305b43adf7cef">&#9670;&nbsp;</a></span>exists() <span class="overload">[2/2]</span></h2>
  1292. <div class="memitem">
  1293. <div class="memproto">
  1294. <table class="mlabels">
  1295. <tr>
  1296. <td class="mlabels-left">
  1297. <table class="memname">
  1298. <tr>
  1299. <td class="memname">bool FatVolume::exists </td>
  1300. <td>(</td>
  1301. <td class="paramtype">const String &amp;&#160;</td>
  1302. <td class="paramname"><em>path</em></td><td>)</td>
  1303. <td></td>
  1304. </tr>
  1305. </table>
  1306. </td>
  1307. <td class="mlabels-right">
  1308. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1309. </tr>
  1310. </table>
  1311. </div><div class="memdoc">
  1312. <p>Test for the existence of a file.</p>
  1313. <dl class="params"><dt>Parameters</dt><dd>
  1314. <table class="params">
  1315. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  1316. </table>
  1317. </dd>
  1318. </dl>
  1319. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  1320. </div>
  1321. </div>
  1322. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>
  1323. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>
  1324. <div class="memitem">
  1325. <div class="memproto">
  1326. <table class="mlabels">
  1327. <tr>
  1328. <td class="mlabels-left">
  1329. <table class="memname">
  1330. <tr>
  1331. <td class="memname">uint8_t FatPartition::fatCount </td>
  1332. <td>(</td>
  1333. <td class="paramname"></td><td>)</td>
  1334. <td></td>
  1335. </tr>
  1336. </table>
  1337. </td>
  1338. <td class="mlabels-right">
  1339. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1340. </tr>
  1341. </table>
  1342. </div><div class="memdoc">
  1343. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>
  1344. </div>
  1345. </div>
  1346. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>
  1347. <h2 class="memtitle"><span class="permalink"><a href="#a6a1ce7d707cf15bea08b63216413e055">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  1348. <div class="memitem">
  1349. <div class="memproto">
  1350. <table class="mlabels">
  1351. <tr>
  1352. <td class="mlabels-left">
  1353. <table class="memname">
  1354. <tr>
  1355. <td class="memname">uint32_t FatPartition::fatStartSector </td>
  1356. <td>(</td>
  1357. <td class="paramname"></td><td>)</td>
  1358. <td> const</td>
  1359. </tr>
  1360. </table>
  1361. </td>
  1362. <td class="mlabels-right">
  1363. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1364. </tr>
  1365. </table>
  1366. </div><div class="memdoc">
  1367. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  1368. </div>
  1369. </div>
  1370. <a id="ad45c276232d7093b82f1075e8c488bac"></a>
  1371. <h2 class="memtitle"><span class="permalink"><a href="#ad45c276232d7093b82f1075e8c488bac">&#9670;&nbsp;</a></span>fatType()</h2>
  1372. <div class="memitem">
  1373. <div class="memproto">
  1374. <table class="mlabels">
  1375. <tr>
  1376. <td class="mlabels-left">
  1377. <table class="memname">
  1378. <tr>
  1379. <td class="memname">uint8_t FatPartition::fatType </td>
  1380. <td>(</td>
  1381. <td class="paramname"></td><td>)</td>
  1382. <td> const</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. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  1392. </div>
  1393. </div>
  1394. <a id="a303f00204805011d12e70c59ad24e42d"></a>
  1395. <h2 class="memtitle"><span class="permalink"><a href="#a303f00204805011d12e70c59ad24e42d">&#9670;&nbsp;</a></span>format()</h2>
  1396. <div class="memitem">
  1397. <div class="memproto">
  1398. <table class="mlabels">
  1399. <tr>
  1400. <td class="mlabels-left">
  1401. <table class="memname">
  1402. <tr>
  1403. <td class="memname">bool SdFat32::format </td>
  1404. <td>(</td>
  1405. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1406. <td class="paramname"><em>pr</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code></td><td>)</td>
  1407. <td></td>
  1408. </tr>
  1409. </table>
  1410. </td>
  1411. <td class="mlabels-right">
  1412. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1413. </tr>
  1414. </table>
  1415. </div><div class="memdoc">
  1416. <p>Format a SD card FAT32/FAT16.</p>
  1417. <dl class="params"><dt>Parameters</dt><dd>
  1418. <table class="params">
  1419. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Optional Print information. </td></tr>
  1420. </table>
  1421. </dd>
  1422. </dl>
  1423. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1424. </div>
  1425. </div>
  1426. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>
  1427. <h2 class="memtitle"><span class="permalink"><a href="#ac9689f1e11f59acc5f1b21ed9bb71174">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  1428. <div class="memitem">
  1429. <div class="memproto">
  1430. <table class="mlabels">
  1431. <tr>
  1432. <td class="mlabels-left">
  1433. <table class="memname">
  1434. <tr>
  1435. <td class="memname">int32_t FatPartition::freeClusterCount </td>
  1436. <td>(</td>
  1437. <td class="paramname"></td><td>)</td>
  1438. <td></td>
  1439. </tr>
  1440. </table>
  1441. </td>
  1442. <td class="mlabels-right">
  1443. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1444. </tr>
  1445. </table>
  1446. </div><div class="memdoc">
  1447. <p>Volume free space in clusters.</p>
  1448. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  1449. </div>
  1450. </div>
  1451. <a id="ab827224f30eec57255d21cae589911ef"></a>
  1452. <h2 class="memtitle"><span class="permalink"><a href="#ab827224f30eec57255d21cae589911ef">&#9670;&nbsp;</a></span>init()</h2>
  1453. <div class="memitem">
  1454. <div class="memproto">
  1455. <table class="mlabels">
  1456. <tr>
  1457. <td class="mlabels-left">
  1458. <table class="memname">
  1459. <tr>
  1460. <td class="memname">bool FatPartition::init </td>
  1461. <td>(</td>
  1462. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  1463. <td class="paramname"><em>dev</em>, </td>
  1464. </tr>
  1465. <tr>
  1466. <td class="paramkey"></td>
  1467. <td></td>
  1468. <td class="paramtype">uint8_t&#160;</td>
  1469. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  1470. </tr>
  1471. <tr>
  1472. <td></td>
  1473. <td>)</td>
  1474. <td></td><td></td>
  1475. </tr>
  1476. </table>
  1477. </td>
  1478. <td class="mlabels-right">
  1479. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1480. </tr>
  1481. </table>
  1482. </div><div class="memdoc">
  1483. <p>Initialize a FAT partition.</p>
  1484. <dl class="params"><dt>Parameters</dt><dd>
  1485. <table class="params">
  1486. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>
  1487. <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 sector zero.</td></tr>
  1488. </table>
  1489. </dd>
  1490. </dl>
  1491. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1492. </div>
  1493. </div>
  1494. <a id="a5901169e4d6ae992b348df518da68a76"></a>
  1495. <h2 class="memtitle"><span class="permalink"><a href="#a5901169e4d6ae992b348df518da68a76">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[1/6]</span></h2>
  1496. <div class="memitem">
  1497. <div class="memproto">
  1498. <table class="mlabels">
  1499. <tr>
  1500. <td class="mlabels-left">
  1501. <table class="memname">
  1502. <tr>
  1503. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1504. <td>(</td>
  1505. <td class="paramname"></td><td>)</td>
  1506. <td></td>
  1507. </tr>
  1508. </table>
  1509. </td>
  1510. <td class="mlabels-right">
  1511. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1512. </tr>
  1513. </table>
  1514. </div><div class="memdoc">
  1515. <p>Print error info and halt. </p>
  1516. </div>
  1517. </div>
  1518. <a id="a557ac64877bdd851cd27bf0a00f380c2"></a>
  1519. <h2 class="memtitle"><span class="permalink"><a href="#a557ac64877bdd851cd27bf0a00f380c2">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[2/6]</span></h2>
  1520. <div class="memitem">
  1521. <div class="memproto">
  1522. <table class="mlabels">
  1523. <tr>
  1524. <td class="mlabels-left">
  1525. <table class="memname">
  1526. <tr>
  1527. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1528. <td>(</td>
  1529. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1530. <td class="paramname"><em>msg</em></td><td>)</td>
  1531. <td></td>
  1532. </tr>
  1533. </table>
  1534. </td>
  1535. <td class="mlabels-right">
  1536. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1537. </tr>
  1538. </table>
  1539. </div><div class="memdoc">
  1540. <p>Print error info and halt.</p>
  1541. <dl class="params"><dt>Parameters</dt><dd>
  1542. <table class="params">
  1543. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1544. </table>
  1545. </dd>
  1546. </dl>
  1547. </div>
  1548. </div>
  1549. <a id="a9b6c279ebcd8fa95d6b409d099986931"></a>
  1550. <h2 class="memtitle"><span class="permalink"><a href="#a9b6c279ebcd8fa95d6b409d099986931">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[3/6]</span></h2>
  1551. <div class="memitem">
  1552. <div class="memproto">
  1553. <table class="mlabels">
  1554. <tr>
  1555. <td class="mlabels-left">
  1556. <table class="memname">
  1557. <tr>
  1558. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1559. <td>(</td>
  1560. <td class="paramtype">const char *&#160;</td>
  1561. <td class="paramname"><em>msg</em></td><td>)</td>
  1562. <td></td>
  1563. </tr>
  1564. </table>
  1565. </td>
  1566. <td class="mlabels-right">
  1567. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1568. </tr>
  1569. </table>
  1570. </div><div class="memdoc">
  1571. <p>Print error info and halt.</p>
  1572. <dl class="params"><dt>Parameters</dt><dd>
  1573. <table class="params">
  1574. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1575. </table>
  1576. </dd>
  1577. </dl>
  1578. </div>
  1579. </div>
  1580. <a id="a8a249b866a4b24ac0a0753f966aab299"></a>
  1581. <h2 class="memtitle"><span class="permalink"><a href="#a8a249b866a4b24ac0a0753f966aab299">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[4/6]</span></h2>
  1582. <div class="memitem">
  1583. <div class="memproto">
  1584. <table class="mlabels">
  1585. <tr>
  1586. <td class="mlabels-left">
  1587. <table class="memname">
  1588. <tr>
  1589. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1590. <td>(</td>
  1591. <td class="paramtype">Print *&#160;</td>
  1592. <td class="paramname"><em>pr</em>, </td>
  1593. </tr>
  1594. <tr>
  1595. <td class="paramkey"></td>
  1596. <td></td>
  1597. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1598. <td class="paramname"><em>msg</em>&#160;</td>
  1599. </tr>
  1600. <tr>
  1601. <td></td>
  1602. <td>)</td>
  1603. <td></td><td></td>
  1604. </tr>
  1605. </table>
  1606. </td>
  1607. <td class="mlabels-right">
  1608. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1609. </tr>
  1610. </table>
  1611. </div><div class="memdoc">
  1612. <p>Print error info and halt.</p>
  1613. <dl class="params"><dt>Parameters</dt><dd>
  1614. <table class="params">
  1615. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1616. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1617. </table>
  1618. </dd>
  1619. </dl>
  1620. </div>
  1621. </div>
  1622. <a id="acb8180faf22cf72d97ec81330a700b05"></a>
  1623. <h2 class="memtitle"><span class="permalink"><a href="#acb8180faf22cf72d97ec81330a700b05">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[5/6]</span></h2>
  1624. <div class="memitem">
  1625. <div class="memproto">
  1626. <table class="mlabels">
  1627. <tr>
  1628. <td class="mlabels-left">
  1629. <table class="memname">
  1630. <tr>
  1631. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1632. <td>(</td>
  1633. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1634. <td class="paramname"><em>pr</em></td><td>)</td>
  1635. <td></td>
  1636. </tr>
  1637. </table>
  1638. </td>
  1639. <td class="mlabels-right">
  1640. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1641. </tr>
  1642. </table>
  1643. </div><div class="memdoc">
  1644. <p>Print error info and halt.</p>
  1645. <dl class="params"><dt>Parameters</dt><dd>
  1646. <table class="params">
  1647. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1648. </table>
  1649. </dd>
  1650. </dl>
  1651. </div>
  1652. </div>
  1653. <a id="aef6fd47c67b9b8498c1398e58422f169"></a>
  1654. <h2 class="memtitle"><span class="permalink"><a href="#aef6fd47c67b9b8498c1398e58422f169">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[6/6]</span></h2>
  1655. <div class="memitem">
  1656. <div class="memproto">
  1657. <table class="mlabels">
  1658. <tr>
  1659. <td class="mlabels-left">
  1660. <table class="memname">
  1661. <tr>
  1662. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorHalt </td>
  1663. <td>(</td>
  1664. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1665. <td class="paramname"><em>pr</em>, </td>
  1666. </tr>
  1667. <tr>
  1668. <td class="paramkey"></td>
  1669. <td></td>
  1670. <td class="paramtype">const char *&#160;</td>
  1671. <td class="paramname"><em>msg</em>&#160;</td>
  1672. </tr>
  1673. <tr>
  1674. <td></td>
  1675. <td>)</td>
  1676. <td></td><td></td>
  1677. </tr>
  1678. </table>
  1679. </td>
  1680. <td class="mlabels-right">
  1681. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1682. </tr>
  1683. </table>
  1684. </div><div class="memdoc">
  1685. <p>Print error info and halt.</p>
  1686. <dl class="params"><dt>Parameters</dt><dd>
  1687. <table class="params">
  1688. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1689. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1690. </table>
  1691. </dd>
  1692. </dl>
  1693. </div>
  1694. </div>
  1695. <a id="abe8d75ba435b4decd6b2079b4272d0e5"></a>
  1696. <h2 class="memtitle"><span class="permalink"><a href="#abe8d75ba435b4decd6b2079b4272d0e5">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[1/2]</span></h2>
  1697. <div class="memitem">
  1698. <div class="memproto">
  1699. <table class="mlabels">
  1700. <tr>
  1701. <td class="mlabels-left">
  1702. <table class="memname">
  1703. <tr>
  1704. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorPrint </td>
  1705. <td>(</td>
  1706. <td class="paramname"></td><td>)</td>
  1707. <td></td>
  1708. </tr>
  1709. </table>
  1710. </td>
  1711. <td class="mlabels-right">
  1712. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1713. </tr>
  1714. </table>
  1715. </div><div class="memdoc">
  1716. <p>Print error details after <a class="el" href="class_sd_base.html#abff5f318cfe072b80119f1938cd591bb">begin()</a> fails. </p>
  1717. </div>
  1718. </div>
  1719. <a id="a918474d623107f64b7ab9ca88d6fe46f"></a>
  1720. <h2 class="memtitle"><span class="permalink"><a href="#a918474d623107f64b7ab9ca88d6fe46f">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[2/2]</span></h2>
  1721. <div class="memitem">
  1722. <div class="memproto">
  1723. <table class="mlabels">
  1724. <tr>
  1725. <td class="mlabels-left">
  1726. <table class="memname">
  1727. <tr>
  1728. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::initErrorPrint </td>
  1729. <td>(</td>
  1730. <td class="paramtype">Print *&#160;</td>
  1731. <td class="paramname"><em>pr</em></td><td>)</td>
  1732. <td></td>
  1733. </tr>
  1734. </table>
  1735. </td>
  1736. <td class="mlabels-right">
  1737. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1738. </tr>
  1739. </table>
  1740. </div><div class="memdoc">
  1741. <p>Print error details after <a class="el" href="class_sd_base.html#abff5f318cfe072b80119f1938cd591bb">begin()</a> fails.</p>
  1742. <dl class="params"><dt>Parameters</dt><dd>
  1743. <table class="params">
  1744. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1745. </table>
  1746. </dd>
  1747. </dl>
  1748. </div>
  1749. </div>
  1750. <a id="a455ad7b2a5b6b31551dca08087a3c404"></a>
  1751. <h2 class="memtitle"><span class="permalink"><a href="#a455ad7b2a5b6b31551dca08087a3c404">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/4]</span></h2>
  1752. <div class="memitem">
  1753. <div class="memproto">
  1754. <table class="mlabels">
  1755. <tr>
  1756. <td class="mlabels-left">
  1757. <table class="memname">
  1758. <tr>
  1759. <td class="memname">bool FatVolume::ls </td>
  1760. <td>(</td>
  1761. <td class="paramtype">const char *&#160;</td>
  1762. <td class="paramname"><em>path</em>, </td>
  1763. </tr>
  1764. <tr>
  1765. <td class="paramkey"></td>
  1766. <td></td>
  1767. <td class="paramtype">uint8_t&#160;</td>
  1768. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1769. </tr>
  1770. <tr>
  1771. <td></td>
  1772. <td>)</td>
  1773. <td></td><td></td>
  1774. </tr>
  1775. </table>
  1776. </td>
  1777. <td class="mlabels-right">
  1778. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1779. </tr>
  1780. </table>
  1781. </div><div class="memdoc">
  1782. <p>List the directory contents of a directory to Serial.</p>
  1783. <dl class="params"><dt>Parameters</dt><dd>
  1784. <table class="params">
  1785. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1786. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1787. </table>
  1788. </dd>
  1789. </dl>
  1790. <p>LS_DATE - Print file modification date</p>
  1791. <p>LS_SIZE - Print file size.</p>
  1792. <p>LS_R - Recursive list of subdirectories.</p>
  1793. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1794. </div>
  1795. </div>
  1796. <a id="ac5fc83cac7fd3af0b140a7986b9472f8"></a>
  1797. <h2 class="memtitle"><span class="permalink"><a href="#ac5fc83cac7fd3af0b140a7986b9472f8">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/4]</span></h2>
  1798. <div class="memitem">
  1799. <div class="memproto">
  1800. <table class="mlabels">
  1801. <tr>
  1802. <td class="mlabels-left">
  1803. <table class="memname">
  1804. <tr>
  1805. <td class="memname">bool FatVolume::ls </td>
  1806. <td>(</td>
  1807. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1808. <td class="paramname"><em>pr</em>, </td>
  1809. </tr>
  1810. <tr>
  1811. <td class="paramkey"></td>
  1812. <td></td>
  1813. <td class="paramtype">const char *&#160;</td>
  1814. <td class="paramname"><em>path</em>, </td>
  1815. </tr>
  1816. <tr>
  1817. <td class="paramkey"></td>
  1818. <td></td>
  1819. <td class="paramtype">uint8_t&#160;</td>
  1820. <td class="paramname"><em>flags</em>&#160;</td>
  1821. </tr>
  1822. <tr>
  1823. <td></td>
  1824. <td>)</td>
  1825. <td></td><td></td>
  1826. </tr>
  1827. </table>
  1828. </td>
  1829. <td class="mlabels-right">
  1830. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1831. </tr>
  1832. </table>
  1833. </div><div class="memdoc">
  1834. <p>List the contents of a directory.</p>
  1835. <dl class="params"><dt>Parameters</dt><dd>
  1836. <table class="params">
  1837. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1838. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1839. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1840. </table>
  1841. </dd>
  1842. </dl>
  1843. <p>LS_DATE - Print file modification date</p>
  1844. <p>LS_SIZE - Print file size.</p>
  1845. <p>LS_R - Recursive list of subdirectories.</p>
  1846. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1847. </div>
  1848. </div>
  1849. <a id="ae40964f357cfff4208812344a0e6f26f"></a>
  1850. <h2 class="memtitle"><span class="permalink"><a href="#ae40964f357cfff4208812344a0e6f26f">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/4]</span></h2>
  1851. <div class="memitem">
  1852. <div class="memproto">
  1853. <table class="mlabels">
  1854. <tr>
  1855. <td class="mlabels-left">
  1856. <table class="memname">
  1857. <tr>
  1858. <td class="memname">bool FatVolume::ls </td>
  1859. <td>(</td>
  1860. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1861. <td class="paramname"><em>pr</em>, </td>
  1862. </tr>
  1863. <tr>
  1864. <td class="paramkey"></td>
  1865. <td></td>
  1866. <td class="paramtype">uint8_t&#160;</td>
  1867. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1868. </tr>
  1869. <tr>
  1870. <td></td>
  1871. <td>)</td>
  1872. <td></td><td></td>
  1873. </tr>
  1874. </table>
  1875. </td>
  1876. <td class="mlabels-right">
  1877. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1878. </tr>
  1879. </table>
  1880. </div><div class="memdoc">
  1881. <p>List the directory contents of the volume root directory.</p>
  1882. <dl class="params"><dt>Parameters</dt><dd>
  1883. <table class="params">
  1884. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1885. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1886. </table>
  1887. </dd>
  1888. </dl>
  1889. <p>LS_DATE - Print file modification date</p>
  1890. <p>LS_SIZE - Print file size.</p>
  1891. <p>LS_R - Recursive list of subdirectories.</p>
  1892. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1893. </div>
  1894. </div>
  1895. <a id="ad455ad05551329865c659cc4676f2d18"></a>
  1896. <h2 class="memtitle"><span class="permalink"><a href="#ad455ad05551329865c659cc4676f2d18">&#9670;&nbsp;</a></span>ls() <span class="overload">[4/4]</span></h2>
  1897. <div class="memitem">
  1898. <div class="memproto">
  1899. <table class="mlabels">
  1900. <tr>
  1901. <td class="mlabels-left">
  1902. <table class="memname">
  1903. <tr>
  1904. <td class="memname">bool FatVolume::ls </td>
  1905. <td>(</td>
  1906. <td class="paramtype">uint8_t&#160;</td>
  1907. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1908. <td></td>
  1909. </tr>
  1910. </table>
  1911. </td>
  1912. <td class="mlabels-right">
  1913. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1914. </tr>
  1915. </table>
  1916. </div><div class="memdoc">
  1917. <p>List the directory contents of the root directory to Serial.</p>
  1918. <dl class="params"><dt>Parameters</dt><dd>
  1919. <table class="params">
  1920. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1921. </table>
  1922. </dd>
  1923. </dl>
  1924. <p>LS_DATE - Print file modification date</p>
  1925. <p>LS_SIZE - Print file size.</p>
  1926. <p>LS_R - Recursive list of subdirectories.</p>
  1927. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1928. </div>
  1929. </div>
  1930. <a id="ad80bccf8f24ff001a7b9277effc2cc52"></a>
  1931. <h2 class="memtitle"><span class="permalink"><a href="#ad80bccf8f24ff001a7b9277effc2cc52">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[1/2]</span></h2>
  1932. <div class="memitem">
  1933. <div class="memproto">
  1934. <table class="mlabels">
  1935. <tr>
  1936. <td class="mlabels-left">
  1937. <table class="memname">
  1938. <tr>
  1939. <td class="memname">bool FatVolume::mkdir </td>
  1940. <td>(</td>
  1941. <td class="paramtype">const char *&#160;</td>
  1942. <td class="paramname"><em>path</em>, </td>
  1943. </tr>
  1944. <tr>
  1945. <td class="paramkey"></td>
  1946. <td></td>
  1947. <td class="paramtype">bool&#160;</td>
  1948. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1949. </tr>
  1950. <tr>
  1951. <td></td>
  1952. <td>)</td>
  1953. <td></td><td></td>
  1954. </tr>
  1955. </table>
  1956. </td>
  1957. <td class="mlabels-right">
  1958. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1959. </tr>
  1960. </table>
  1961. </div><div class="memdoc">
  1962. <p>Make a subdirectory in the volume root directory.</p>
  1963. <dl class="params"><dt>Parameters</dt><dd>
  1964. <table class="params">
  1965. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  1966. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1967. </table>
  1968. </dd>
  1969. </dl>
  1970. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1971. </div>
  1972. </div>
  1973. <a id="ab423ec4f7e5b58a6d454f328f61fd864"></a>
  1974. <h2 class="memtitle"><span class="permalink"><a href="#ab423ec4f7e5b58a6d454f328f61fd864">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[2/2]</span></h2>
  1975. <div class="memitem">
  1976. <div class="memproto">
  1977. <table class="mlabels">
  1978. <tr>
  1979. <td class="mlabels-left">
  1980. <table class="memname">
  1981. <tr>
  1982. <td class="memname">bool FatVolume::mkdir </td>
  1983. <td>(</td>
  1984. <td class="paramtype">const String &amp;&#160;</td>
  1985. <td class="paramname"><em>path</em>, </td>
  1986. </tr>
  1987. <tr>
  1988. <td class="paramkey"></td>
  1989. <td></td>
  1990. <td class="paramtype">bool&#160;</td>
  1991. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1992. </tr>
  1993. <tr>
  1994. <td></td>
  1995. <td>)</td>
  1996. <td></td><td></td>
  1997. </tr>
  1998. </table>
  1999. </td>
  2000. <td class="mlabels-right">
  2001. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2002. </tr>
  2003. </table>
  2004. </div><div class="memdoc">
  2005. <p>Make a subdirectory in the volume root directory.</p>
  2006. <dl class="params"><dt>Parameters</dt><dd>
  2007. <table class="params">
  2008. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  2009. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  2010. </table>
  2011. </dd>
  2012. </dl>
  2013. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2014. </div>
  2015. </div>
  2016. <a id="a22923b86de9c797ce5e19f206dd4ce1f"></a>
  2017. <h2 class="memtitle"><span class="permalink"><a href="#a22923b86de9c797ce5e19f206dd4ce1f">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>
  2018. <div class="memitem">
  2019. <div class="memproto">
  2020. <table class="mlabels">
  2021. <tr>
  2022. <td class="mlabels-left">
  2023. <table class="memname">
  2024. <tr>
  2025. <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>
  2026. <td>(</td>
  2027. <td class="paramtype">const char *&#160;</td>
  2028. <td class="paramname"><em>path</em>, </td>
  2029. </tr>
  2030. <tr>
  2031. <td class="paramkey"></td>
  2032. <td></td>
  2033. <td class="paramtype">oflag_t&#160;</td>
  2034. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  2035. </tr>
  2036. <tr>
  2037. <td></td>
  2038. <td>)</td>
  2039. <td></td><td></td>
  2040. </tr>
  2041. </table>
  2042. </td>
  2043. <td class="mlabels-right">
  2044. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2045. </tr>
  2046. </table>
  2047. </div><div class="memdoc">
  2048. <p>open a file</p>
  2049. <dl class="params"><dt>Parameters</dt><dd>
  2050. <table class="params">
  2051. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  2052. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  2053. </table>
  2054. </dd>
  2055. </dl>
  2056. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream.">File32</a> object. </dd></dl>
  2057. </div>
  2058. </div>
  2059. <a id="af7178b7f13eeae7748640b6268a34812"></a>
  2060. <h2 class="memtitle"><span class="permalink"><a href="#af7178b7f13eeae7748640b6268a34812">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>
  2061. <div class="memitem">
  2062. <div class="memproto">
  2063. <table class="mlabels">
  2064. <tr>
  2065. <td class="mlabels-left">
  2066. <table class="memname">
  2067. <tr>
  2068. <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>
  2069. <td>(</td>
  2070. <td class="paramtype">const String &amp;&#160;</td>
  2071. <td class="paramname"><em>path</em>, </td>
  2072. </tr>
  2073. <tr>
  2074. <td class="paramkey"></td>
  2075. <td></td>
  2076. <td class="paramtype">oflag_t&#160;</td>
  2077. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  2078. </tr>
  2079. <tr>
  2080. <td></td>
  2081. <td>)</td>
  2082. <td></td><td></td>
  2083. </tr>
  2084. </table>
  2085. </td>
  2086. <td class="mlabels-right">
  2087. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2088. </tr>
  2089. </table>
  2090. </div><div class="memdoc">
  2091. <p>open a file</p>
  2092. <dl class="params"><dt>Parameters</dt><dd>
  2093. <table class="params">
  2094. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  2095. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  2096. </table>
  2097. </dd>
  2098. </dl>
  2099. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream.">File32</a> object. </dd></dl>
  2100. </div>
  2101. </div>
  2102. <a id="a234e80318c39229fe968a182b172148c"></a>
  2103. <h2 class="memtitle"><span class="permalink"><a href="#a234e80318c39229fe968a182b172148c">&#9670;&nbsp;</a></span>printFatType()</h2>
  2104. <div class="memitem">
  2105. <div class="memproto">
  2106. <table class="mlabels">
  2107. <tr>
  2108. <td class="mlabels-left">
  2109. <table class="memname">
  2110. <tr>
  2111. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::printFatType </td>
  2112. <td>(</td>
  2113. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2114. <td class="paramname"><em>pr</em></td><td>)</td>
  2115. <td></td>
  2116. </tr>
  2117. </table>
  2118. </td>
  2119. <td class="mlabels-right">
  2120. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2121. </tr>
  2122. </table>
  2123. </div><div class="memdoc">
  2124. <p>Print volume FAT/exFAT type.</p>
  2125. <dl class="params"><dt>Parameters</dt><dd>
  2126. <table class="params">
  2127. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  2128. </table>
  2129. </dd>
  2130. </dl>
  2131. </div>
  2132. </div>
  2133. <a id="a6a8ba118e754b2b9fa0f34410163e228"></a>
  2134. <h2 class="memtitle"><span class="permalink"><a href="#a6a8ba118e754b2b9fa0f34410163e228">&#9670;&nbsp;</a></span>printSdError()</h2>
  2135. <div class="memitem">
  2136. <div class="memproto">
  2137. <table class="mlabels">
  2138. <tr>
  2139. <td class="mlabels-left">
  2140. <table class="memname">
  2141. <tr>
  2142. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::printSdError </td>
  2143. <td>(</td>
  2144. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2145. <td class="paramname"><em>pr</em></td><td>)</td>
  2146. <td></td>
  2147. </tr>
  2148. </table>
  2149. </td>
  2150. <td class="mlabels-right">
  2151. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2152. </tr>
  2153. </table>
  2154. </div><div class="memdoc">
  2155. <p>Print error info and return.</p>
  2156. <dl class="params"><dt>Parameters</dt><dd>
  2157. <table class="params">
  2158. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  2159. </table>
  2160. </dd>
  2161. </dl>
  2162. </div>
  2163. </div>
  2164. <a id="abb11d05ef407775bcdb9b14a6c608433"></a>
  2165. <h2 class="memtitle"><span class="permalink"><a href="#abb11d05ef407775bcdb9b14a6c608433">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  2166. <div class="memitem">
  2167. <div class="memproto">
  2168. <table class="mlabels">
  2169. <tr>
  2170. <td class="mlabels-left">
  2171. <table class="memname">
  2172. <tr>
  2173. <td class="memname">bool FatVolume::remove </td>
  2174. <td>(</td>
  2175. <td class="paramtype">const char *&#160;</td>
  2176. <td class="paramname"><em>path</em></td><td>)</td>
  2177. <td></td>
  2178. </tr>
  2179. </table>
  2180. </td>
  2181. <td class="mlabels-right">
  2182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2183. </tr>
  2184. </table>
  2185. </div><div class="memdoc">
  2186. <p>Remove a file from the volume root directory.</p>
  2187. <dl class="params"><dt>Parameters</dt><dd>
  2188. <table class="params">
  2189. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>
  2190. </table>
  2191. </dd>
  2192. </dl>
  2193. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2194. </div>
  2195. </div>
  2196. <a id="a994411f55df474be6be87f06100c2c39"></a>
  2197. <h2 class="memtitle"><span class="permalink"><a href="#a994411f55df474be6be87f06100c2c39">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  2198. <div class="memitem">
  2199. <div class="memproto">
  2200. <table class="mlabels">
  2201. <tr>
  2202. <td class="mlabels-left">
  2203. <table class="memname">
  2204. <tr>
  2205. <td class="memname">bool FatVolume::remove </td>
  2206. <td>(</td>
  2207. <td class="paramtype">const String &amp;&#160;</td>
  2208. <td class="paramname"><em>path</em></td><td>)</td>
  2209. <td></td>
  2210. </tr>
  2211. </table>
  2212. </td>
  2213. <td class="mlabels-right">
  2214. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2215. </tr>
  2216. </table>
  2217. </div><div class="memdoc">
  2218. <p>Remove a file from the volume root directory.</p>
  2219. <dl class="params"><dt>Parameters</dt><dd>
  2220. <table class="params">
  2221. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>
  2222. </table>
  2223. </dd>
  2224. </dl>
  2225. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2226. </div>
  2227. </div>
  2228. <a id="a5e4ea6c91569dc435c7aacd7ba704911"></a>
  2229. <h2 class="memtitle"><span class="permalink"><a href="#a5e4ea6c91569dc435c7aacd7ba704911">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  2230. <div class="memitem">
  2231. <div class="memproto">
  2232. <table class="mlabels">
  2233. <tr>
  2234. <td class="mlabels-left">
  2235. <table class="memname">
  2236. <tr>
  2237. <td class="memname">bool FatVolume::rename </td>
  2238. <td>(</td>
  2239. <td class="paramtype">const char *&#160;</td>
  2240. <td class="paramname"><em>oldPath</em>, </td>
  2241. </tr>
  2242. <tr>
  2243. <td class="paramkey"></td>
  2244. <td></td>
  2245. <td class="paramtype">const char *&#160;</td>
  2246. <td class="paramname"><em>newPath</em>&#160;</td>
  2247. </tr>
  2248. <tr>
  2249. <td></td>
  2250. <td>)</td>
  2251. <td></td><td></td>
  2252. </tr>
  2253. </table>
  2254. </td>
  2255. <td class="mlabels-right">
  2256. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2257. </tr>
  2258. </table>
  2259. </div><div class="memdoc">
  2260. <p>Rename a file or subdirectory.</p>
  2261. <dl class="params"><dt>Parameters</dt><dd>
  2262. <table class="params">
  2263. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  2264. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  2265. </table>
  2266. </dd>
  2267. </dl>
  2268. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  2269. <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_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>
  2270. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2271. </div>
  2272. </div>
  2273. <a id="aa7015c0f694261780081c79c05d0882d"></a>
  2274. <h2 class="memtitle"><span class="permalink"><a href="#aa7015c0f694261780081c79c05d0882d">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  2275. <div class="memitem">
  2276. <div class="memproto">
  2277. <table class="mlabels">
  2278. <tr>
  2279. <td class="mlabels-left">
  2280. <table class="memname">
  2281. <tr>
  2282. <td class="memname">bool FatVolume::rename </td>
  2283. <td>(</td>
  2284. <td class="paramtype">const String &amp;&#160;</td>
  2285. <td class="paramname"><em>oldPath</em>, </td>
  2286. </tr>
  2287. <tr>
  2288. <td class="paramkey"></td>
  2289. <td></td>
  2290. <td class="paramtype">const String &amp;&#160;</td>
  2291. <td class="paramname"><em>newPath</em>&#160;</td>
  2292. </tr>
  2293. <tr>
  2294. <td></td>
  2295. <td>)</td>
  2296. <td></td><td></td>
  2297. </tr>
  2298. </table>
  2299. </td>
  2300. <td class="mlabels-right">
  2301. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2302. </tr>
  2303. </table>
  2304. </div><div class="memdoc">
  2305. <p>Rename a file or subdirectory.</p>
  2306. <dl class="params"><dt>Parameters</dt><dd>
  2307. <table class="params">
  2308. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  2309. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  2310. </table>
  2311. </dd>
  2312. </dl>
  2313. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  2314. <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_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>
  2315. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2316. </div>
  2317. </div>
  2318. <a id="af1181990bcece7dbb7d19293dd4fe11a"></a>
  2319. <h2 class="memtitle"><span class="permalink"><a href="#af1181990bcece7dbb7d19293dd4fe11a">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[1/2]</span></h2>
  2320. <div class="memitem">
  2321. <div class="memproto">
  2322. <table class="mlabels">
  2323. <tr>
  2324. <td class="mlabels-left">
  2325. <table class="memname">
  2326. <tr>
  2327. <td class="memname">bool FatVolume::rmdir </td>
  2328. <td>(</td>
  2329. <td class="paramtype">const char *&#160;</td>
  2330. <td class="paramname"><em>path</em></td><td>)</td>
  2331. <td></td>
  2332. </tr>
  2333. </table>
  2334. </td>
  2335. <td class="mlabels-right">
  2336. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2337. </tr>
  2338. </table>
  2339. </div><div class="memdoc">
  2340. <p>Remove a subdirectory from the volume's working directory.</p>
  2341. <dl class="params"><dt>Parameters</dt><dd>
  2342. <table class="params">
  2343. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  2344. </table>
  2345. </dd>
  2346. </dl>
  2347. <p>The subdirectory file will be removed only if it is empty.</p>
  2348. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2349. </div>
  2350. </div>
  2351. <a id="a105f437fb649b57ed3823f8ff1a2f37e"></a>
  2352. <h2 class="memtitle"><span class="permalink"><a href="#a105f437fb649b57ed3823f8ff1a2f37e">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[2/2]</span></h2>
  2353. <div class="memitem">
  2354. <div class="memproto">
  2355. <table class="mlabels">
  2356. <tr>
  2357. <td class="mlabels-left">
  2358. <table class="memname">
  2359. <tr>
  2360. <td class="memname">bool FatVolume::rmdir </td>
  2361. <td>(</td>
  2362. <td class="paramtype">const String &amp;&#160;</td>
  2363. <td class="paramname"><em>path</em></td><td>)</td>
  2364. <td></td>
  2365. </tr>
  2366. </table>
  2367. </td>
  2368. <td class="mlabels-right">
  2369. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2370. </tr>
  2371. </table>
  2372. </div><div class="memdoc">
  2373. <p>Remove a subdirectory from the volume's working directory.</p>
  2374. <dl class="params"><dt>Parameters</dt><dd>
  2375. <table class="params">
  2376. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  2377. </table>
  2378. </dd>
  2379. </dl>
  2380. <p>The subdirectory file will be removed only if it is empty.</p>
  2381. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2382. </div>
  2383. </div>
  2384. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>
  2385. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>
  2386. <div class="memitem">
  2387. <div class="memproto">
  2388. <table class="mlabels">
  2389. <tr>
  2390. <td class="mlabels-left">
  2391. <table class="memname">
  2392. <tr>
  2393. <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>
  2394. <td>(</td>
  2395. <td class="paramname"></td><td>)</td>
  2396. <td> const</td>
  2397. </tr>
  2398. </table>
  2399. </td>
  2400. <td class="mlabels-right">
  2401. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2402. </tr>
  2403. </table>
  2404. </div><div class="memdoc">
  2405. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  2406. </div>
  2407. </div>
  2408. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>
  2409. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>
  2410. <div class="memitem">
  2411. <div class="memproto">
  2412. <table class="mlabels">
  2413. <tr>
  2414. <td class="mlabels-left">
  2415. <table class="memname">
  2416. <tr>
  2417. <td class="memname">uint32_t FatPartition::rootDirStart </td>
  2418. <td>(</td>
  2419. <td class="paramname"></td><td>)</td>
  2420. <td> const</td>
  2421. </tr>
  2422. </table>
  2423. </td>
  2424. <td class="mlabels-right">
  2425. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2426. </tr>
  2427. </table>
  2428. </div><div class="memdoc">
  2429. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  2430. </div>
  2431. </div>
  2432. <a id="af2bb8fea732f9272a2e98772fbcc4595"></a>
  2433. <h2 class="memtitle"><span class="permalink"><a href="#af2bb8fea732f9272a2e98772fbcc4595">&#9670;&nbsp;</a></span>sdErrorCode()</h2>
  2434. <div class="memitem">
  2435. <div class="memproto">
  2436. <table class="mlabels">
  2437. <tr>
  2438. <td class="mlabels-left">
  2439. <table class="memname">
  2440. <tr>
  2441. <td class="memname">uint8_t <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::sdErrorCode </td>
  2442. <td>(</td>
  2443. <td class="paramname"></td><td>)</td>
  2444. <td></td>
  2445. </tr>
  2446. </table>
  2447. </td>
  2448. <td class="mlabels-right">
  2449. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2450. </tr>
  2451. </table>
  2452. </div><div class="memdoc">
  2453. <dl class="section return"><dt>Returns</dt><dd>SD card error code. </dd></dl>
  2454. </div>
  2455. </div>
  2456. <a id="a5f8f363b6c23f1d8bfeb858c946f1994"></a>
  2457. <h2 class="memtitle"><span class="permalink"><a href="#a5f8f363b6c23f1d8bfeb858c946f1994">&#9670;&nbsp;</a></span>sdErrorData()</h2>
  2458. <div class="memitem">
  2459. <div class="memproto">
  2460. <table class="mlabels">
  2461. <tr>
  2462. <td class="mlabels-left">
  2463. <table class="memname">
  2464. <tr>
  2465. <td class="memname">uint8_t <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::sdErrorData </td>
  2466. <td>(</td>
  2467. <td class="paramname"></td><td>)</td>
  2468. <td></td>
  2469. </tr>
  2470. </table>
  2471. </td>
  2472. <td class="mlabels-right">
  2473. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2474. </tr>
  2475. </table>
  2476. </div><div class="memdoc">
  2477. <dl class="section return"><dt>Returns</dt><dd>SD card error data. </dd></dl>
  2478. </div>
  2479. </div>
  2480. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>
  2481. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>
  2482. <div class="memitem">
  2483. <div class="memproto">
  2484. <table class="mlabels">
  2485. <tr>
  2486. <td class="mlabels-left">
  2487. <table class="memname">
  2488. <tr>
  2489. <td class="memname">uint16_t FatPartition::sectorMask </td>
  2490. <td>(</td>
  2491. <td class="paramname"></td><td>)</td>
  2492. <td></td>
  2493. </tr>
  2494. </table>
  2495. </td>
  2496. <td class="mlabels-right">
  2497. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2498. </tr>
  2499. </table>
  2500. </div><div class="memdoc">
  2501. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>
  2502. </div>
  2503. </div>
  2504. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>
  2505. <h2 class="memtitle"><span class="permalink"><a href="#a836546c368e6ffe117e6ab8775d23eba">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  2506. <div class="memitem">
  2507. <div class="memproto">
  2508. <table class="mlabels">
  2509. <tr>
  2510. <td class="mlabels-left">
  2511. <table class="memname">
  2512. <tr>
  2513. <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>
  2514. <td>(</td>
  2515. <td class="paramname"></td><td>)</td>
  2516. <td> const</td>
  2517. </tr>
  2518. </table>
  2519. </td>
  2520. <td class="mlabels-right">
  2521. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2522. </tr>
  2523. </table>
  2524. </div><div class="memdoc">
  2525. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  2526. </div>
  2527. </div>
  2528. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>
  2529. <h2 class="memtitle"><span class="permalink"><a href="#a593a27482ff8d993542d6f82bd92e26c">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  2530. <div class="memitem">
  2531. <div class="memproto">
  2532. <table class="mlabels">
  2533. <tr>
  2534. <td class="mlabels-left">
  2535. <table class="memname">
  2536. <tr>
  2537. <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>
  2538. <td>(</td>
  2539. <td class="paramname"></td><td>)</td>
  2540. <td> const</td>
  2541. </tr>
  2542. </table>
  2543. </td>
  2544. <td class="mlabels-right">
  2545. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2546. </tr>
  2547. </table>
  2548. </div><div class="memdoc">
  2549. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>
  2550. </div>
  2551. </div>
  2552. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>
  2553. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>
  2554. <div class="memitem">
  2555. <div class="memproto">
  2556. <table class="mlabels">
  2557. <tr>
  2558. <td class="mlabels-left">
  2559. <table class="memname">
  2560. <tr>
  2561. <td class="memname">uint32_t FatPartition::sectorsPerFat </td>
  2562. <td>(</td>
  2563. <td class="paramname"></td><td>)</td>
  2564. <td> const</td>
  2565. </tr>
  2566. </table>
  2567. </td>
  2568. <td class="mlabels-right">
  2569. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2570. </tr>
  2571. </table>
  2572. </div><div class="memdoc">
  2573. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>
  2574. </div>
  2575. </div>
  2576. <a id="a86a08bf789e33567418465b9b12751e2"></a>
  2577. <h2 class="memtitle"><span class="permalink"><a href="#a86a08bf789e33567418465b9b12751e2">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>
  2578. <div class="memitem">
  2579. <div class="memproto">
  2580. <table class="mlabels">
  2581. <tr>
  2582. <td class="mlabels-left">
  2583. <table class="memname">
  2584. <tr>
  2585. <td class="memname">bool FatVolume::truncate </td>
  2586. <td>(</td>
  2587. <td class="paramtype">const char *&#160;</td>
  2588. <td class="paramname"><em>path</em>, </td>
  2589. </tr>
  2590. <tr>
  2591. <td class="paramkey"></td>
  2592. <td></td>
  2593. <td class="paramtype">uint32_t&#160;</td>
  2594. <td class="paramname"><em>length</em>&#160;</td>
  2595. </tr>
  2596. <tr>
  2597. <td></td>
  2598. <td>)</td>
  2599. <td></td><td></td>
  2600. </tr>
  2601. </table>
  2602. </td>
  2603. <td class="mlabels-right">
  2604. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2605. </tr>
  2606. </table>
  2607. </div><div class="memdoc">
  2608. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>
  2609. <dl class="params"><dt>Parameters</dt><dd>
  2610. <table class="params">
  2611. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>
  2612. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2613. </table>
  2614. </dd>
  2615. </dl>
  2616. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2617. </div>
  2618. </div>
  2619. <a id="a97ef39ec02c38c0772f0029d42edcb46"></a>
  2620. <h2 class="memtitle"><span class="permalink"><a href="#a97ef39ec02c38c0772f0029d42edcb46">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>
  2621. <div class="memitem">
  2622. <div class="memproto">
  2623. <table class="mlabels">
  2624. <tr>
  2625. <td class="mlabels-left">
  2626. <table class="memname">
  2627. <tr>
  2628. <td class="memname">bool FatVolume::truncate </td>
  2629. <td>(</td>
  2630. <td class="paramtype">const String &amp;&#160;</td>
  2631. <td class="paramname"><em>path</em>, </td>
  2632. </tr>
  2633. <tr>
  2634. <td class="paramkey"></td>
  2635. <td></td>
  2636. <td class="paramtype">uint32_t&#160;</td>
  2637. <td class="paramname"><em>length</em>&#160;</td>
  2638. </tr>
  2639. <tr>
  2640. <td></td>
  2641. <td>)</td>
  2642. <td></td><td></td>
  2643. </tr>
  2644. </table>
  2645. </td>
  2646. <td class="mlabels-right">
  2647. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2648. </tr>
  2649. </table>
  2650. </div><div class="memdoc">
  2651. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>
  2652. <dl class="params"><dt>Parameters</dt><dd>
  2653. <table class="params">
  2654. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>
  2655. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2656. </table>
  2657. </dd>
  2658. </dl>
  2659. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2660. </div>
  2661. </div>
  2662. <a id="a20ed1868a6498cd336364c22d1df28a5"></a>
  2663. <h2 class="memtitle"><span class="permalink"><a href="#a20ed1868a6498cd336364c22d1df28a5">&#9670;&nbsp;</a></span>vol()</h2>
  2664. <div class="memitem">
  2665. <div class="memproto">
  2666. <table class="mlabels">
  2667. <tr>
  2668. <td class="mlabels-left">
  2669. <table class="memname">
  2670. <tr>
  2671. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a> * <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::vol </td>
  2672. <td>(</td>
  2673. <td class="paramname"></td><td>)</td>
  2674. <td></td>
  2675. </tr>
  2676. </table>
  2677. </td>
  2678. <td class="mlabels-right">
  2679. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2680. </tr>
  2681. </table>
  2682. </div><div class="memdoc">
  2683. <dl class="section return"><dt>Returns</dt><dd>pointer to base volume </dd></dl>
  2684. </div>
  2685. </div>
  2686. <a id="a1f1de2aac5384475b67506f86199e4c8"></a>
  2687. <h2 class="memtitle"><span class="permalink"><a href="#a1f1de2aac5384475b67506f86199e4c8">&#9670;&nbsp;</a></span>volumeBegin()</h2>
  2688. <div class="memitem">
  2689. <div class="memproto">
  2690. <table class="mlabels">
  2691. <tr>
  2692. <td class="mlabels-left">
  2693. <table class="memname">
  2694. <tr>
  2695. <td class="memname">bool <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fat_volume.html">FatVolume</a> &gt;::volumeBegin </td>
  2696. <td>(</td>
  2697. <td class="paramname"></td><td>)</td>
  2698. <td></td>
  2699. </tr>
  2700. </table>
  2701. </td>
  2702. <td class="mlabels-right">
  2703. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2704. </tr>
  2705. </table>
  2706. </div><div class="memdoc">
  2707. <p>Initialize file system after call to cardBegin.</p>
  2708. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2709. </div>
  2710. </div>
  2711. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>
  2712. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>
  2713. <div class="memitem">
  2714. <div class="memproto">
  2715. <table class="mlabels">
  2716. <tr>
  2717. <td class="mlabels-left">
  2718. <table class="memname">
  2719. <tr>
  2720. <td class="memname">uint32_t FatPartition::volumeSectorCount </td>
  2721. <td>(</td>
  2722. <td class="paramname"></td><td>)</td>
  2723. <td> const</td>
  2724. </tr>
  2725. </table>
  2726. </td>
  2727. <td class="mlabels-right">
  2728. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2729. </tr>
  2730. </table>
  2731. </div><div class="memdoc">
  2732. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>
  2733. </div>
  2734. </div>
  2735. <hr/>The documentation for this class was generated from the following file:<ul>
  2736. <li>ArduinoSdFat/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  2737. </ul>
  2738. </div><!-- contents -->
  2739. <!-- start footer part -->
  2740. <hr class="footer"/><address class="footer"><small>
  2741. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  2742. <img class="footer" src="doxygen.png" alt="doxygen"/>
  2743. </a> 1.8.16
  2744. </small></address>
  2745. </body>
  2746. </html>