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.

2446 lines
108KB

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