Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

1697 rindas
75KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  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.14 -->
  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" id="node2" href="class_sd_base.html" title="SdBase\&lt; FsVolume \&gt;" alt="" coords="5,80,156,107"/>
  79. <area shape="rect" id="node3" href="class_fs_volume.html" title="FsVolume class. " alt="" coords="40,5,121,32"/>
  80. </map>
  81. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  82. <div class="dynheader">
  83. Collaboration diagram for SdFs:</div>
  84. <div class="dyncontent">
  85. <div class="center"><img src="class_sd_fs__coll__graph.png" border="0" usemap="#_sd_fs_coll__map" alt="Collaboration graph"/></div>
  86. <map name="_sd_fs_coll__map" id="_sd_fs_coll__map">
  87. <area shape="rect" id="node2" href="class_sd_base.html" title="SdBase\&lt; FsVolume \&gt;" alt="" coords="5,80,156,107"/>
  88. <area shape="rect" id="node3" href="class_fs_volume.html" title="FsVolume class. " alt="" coords="40,5,121,32"/>
  89. </map>
  90. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  93. Public Member Functions</h2></td></tr>
  94. <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>
  95. <tr class="separator:ae587e7c114b0af86ec0b2927300133b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a71f593c5a431b2cca0bd104af1a7e50a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base.html#a71f593c5a431b2cca0bd104af1a7e50a">begin</a> (uint8_t csPin=SS)</td></tr>
  97. <tr class="separator:a71f593c5a431b2cca0bd104af1a7e50a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a5748f43d73a4272ec8dc302fb0213556"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:ab6343925e4605897d4a1c39be6705760"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a770e0dca5ed7f8d3ca63768da38042cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a1516a55bdab1ee7fe56848808986ae34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:a7a5e3b08f6cdd94cfaa19a1b43df6ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a64cd10a3ce5ee342d0fd31738f385362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:abcc645df09441d40c476e4981393c944"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:ac4f62724d5eeaec3582594bb3b4c3e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a34a5bb7a97a081a7d74cf297f1fbee82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:abc9731fa79598460a37f10a2e561f29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a79cebeb23cb3cdaa06550475fe24272a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:acd5a0e50a30334785d75a8c8bfc3e1f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  123. <tr class="separator:ac9d239810a48c90bd0f3a3e9c4c606a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const char *msg)</td></tr>
  125. <tr class="separator:a1691b7a85fc11851a6942de035d73772"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const __FlashStringHelper *msg)</td></tr>
  127. <tr class="separator:ac530fe041855d994a53d2e1b9c33f22d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  129. <tr class="separator:a22d184b3266ae7cb31ab47b7203e91ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, char const *msg)</td></tr>
  131. <tr class="separator:a7d119e8ae896cc4caa073e9f54823f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a6793653198ce4c570ae92d2f9436dca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:a9bece771399c97b136868f684c2b4496"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:ac5f4de35d2bfdd65bc38c2562b147a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:ad26b5c171ca4c6e953cfbdbfe0b9a988"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:af6dbe47dfe11adf752df95c351b10fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  143. <tr class="separator:acb8180faf22cf72d97ec81330a700b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const char *msg)</td></tr>
  145. <tr class="separator:aef6fd47c67b9b8498c1398e58422f169"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a8a249b866a4b24ac0a0753f966aab299"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a918474d623107f64b7ab9ca88d6fe46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  151. <tr class="separator:a679105032aa3e5c4585c63f8e7acfc02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags)</td></tr>
  153. <tr class="separator:a5ce82e5970856d1e8d549c512ec8a253"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  155. <tr class="separator:ab429316ed9e57a52ecfb938aca7dff6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a9d38c297dccceeb5f48dceb17232368d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:a2f28fc92b7a71607bc57aa72f5a4c0a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  161. <tr class="separator:a234e80318c39229fe968a182b172148c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  163. <tr class="separator:a6a8ba118e754b2b9fa0f34410163e228"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <tr class="separator:aaaa53cfc48602b3d1524508944bd112e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <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>
  167. <tr class="separator:aae3be08aff89f5a113cfa0b89c4a6004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <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>
  169. <tr class="separator:ad2457b491bf85495140fd4a8ca743513"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <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>
  171. <tr class="separator:af2bb8fea732f9272a2e98772fbcc4595"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <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>
  173. <tr class="separator:a5f8f363b6c23f1d8bfeb858c946f1994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <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>
  175. <tr class="separator:acf62acd37d3f59dedd3e34b3e7d64da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <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>
  177. <tr class="separator:a20ed1868a6498cd336364c22d1df28a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <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>
  179. <tr class="separator:a1f1de2aac5384475b67506f86199e4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. </table><table class="memberdecls">
  181. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  182. Static Public Member Functions</h2></td></tr>
  183. <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>
  184. <tr class="separator:ab4fa0f21669b84e00d00fd54c3144a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table>
  186. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  187. <div class="textblock"><p>SD file system class for FAT16, FAT32, and exFAT volumes. </p>
  188. </div><h2 class="groupheader">Member Function Documentation</h2>
  189. <a id="ae587e7c114b0af86ec0b2927300133b0"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#ae587e7c114b0af86ec0b2927300133b0">&#9670;&nbsp;</a></span>begin() <span class="overload">[1/4]</span></h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">bool FsVolume::begin </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  201. <td class="paramname"><em>blockDev</em></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <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>
  212. <table class="params">
  213. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  214. </table>
  215. </dd>
  216. </dl>
  217. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  218. </div>
  219. </div>
  220. <a id="a71f593c5a431b2cca0bd104af1a7e50a"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a71f593c5a431b2cca0bd104af1a7e50a">&#9670;&nbsp;</a></span>begin() <span class="overload">[2/4]</span></h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <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>
  230. <td>(</td>
  231. <td class="paramtype">uint8_t&#160;</td>
  232. <td class="paramname"><em>csPin</em> = <code>SS</code></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Initialize SD card and file system.</p>
  243. <dl class="params"><dt>Parameters</dt><dd>
  244. <table class="params">
  245. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  246. </table>
  247. </dd>
  248. </dl>
  249. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  250. </div>
  251. </div>
  252. <a id="a5748f43d73a4272ec8dc302fb0213556"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#a5748f43d73a4272ec8dc302fb0213556">&#9670;&nbsp;</a></span>begin() <span class="overload">[3/4]</span></h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="mlabels">
  257. <tr>
  258. <td class="mlabels-left">
  259. <table class="memname">
  260. <tr>
  261. <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>
  262. <td>(</td>
  263. <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>
  264. <td class="paramname"><em>spiConfig</em></td><td>)</td>
  265. <td></td>
  266. </tr>
  267. </table>
  268. </td>
  269. <td class="mlabels-right">
  270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Initialize SD card and file system for SPI mode.</p>
  275. <dl class="params"><dt>Parameters</dt><dd>
  276. <table class="params">
  277. <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI configuration. </td></tr>
  278. </table>
  279. </dd>
  280. </dl>
  281. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  282. </div>
  283. </div>
  284. <a id="ab6343925e4605897d4a1c39be6705760"></a>
  285. <h2 class="memtitle"><span class="permalink"><a href="#ab6343925e4605897d4a1c39be6705760">&#9670;&nbsp;</a></span>begin() <span class="overload">[4/4]</span></h2>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <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>
  294. <td>(</td>
  295. <td class="paramtype"><a class="el" href="class_sdio_config.html">SdioConfig</a>&#160;</td>
  296. <td class="paramname"><em>sdioConfig</em></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </td>
  301. <td class="mlabels-right">
  302. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Initialize SD card and file system for SDIO mode.</p>
  307. <dl class="params"><dt>Parameters</dt><dd>
  308. <table class="params">
  309. <tr><td class="paramdir">[in]</td><td class="paramname">sdioConfig</td><td>SDIO configuration. </td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  314. </div>
  315. </div>
  316. <a id="a770e0dca5ed7f8d3ca63768da38042cb"></a>
  317. <h2 class="memtitle"><span class="permalink"><a href="#a770e0dca5ed7f8d3ca63768da38042cb">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="mlabels">
  321. <tr>
  322. <td class="mlabels-left">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">uint32_t FsVolume::bytesPerCluster </td>
  326. <td>(</td>
  327. <td class="paramname"></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>
  338. </div>
  339. </div>
  340. <a id="a1516a55bdab1ee7fe56848808986ae34"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a1516a55bdab1ee7fe56848808986ae34">&#9670;&nbsp;</a></span>card()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <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>
  350. <td>(</td>
  351. <td class="paramname"></td><td>)</td>
  352. <td></td>
  353. </tr>
  354. </table>
  355. </td>
  356. <td class="mlabels-right">
  357. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object. </dd></dl>
  362. </div>
  363. </div>
  364. <a id="a7a5e3b08f6cdd94cfaa19a1b43df6ed9"></a>
  365. <h2 class="memtitle"><span class="permalink"><a href="#a7a5e3b08f6cdd94cfaa19a1b43df6ed9">&#9670;&nbsp;</a></span>cardBegin() <span class="overload">[1/2]</span></h2>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="mlabels">
  369. <tr>
  370. <td class="mlabels-left">
  371. <table class="memname">
  372. <tr>
  373. <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>
  374. <td>(</td>
  375. <td class="paramtype"><a class="el" href="class_sd_spi_config.html">SdSpiConfig</a>&#160;</td>
  376. <td class="paramname"><em>spiConfig</em></td><td>)</td>
  377. <td></td>
  378. </tr>
  379. </table>
  380. </td>
  381. <td class="mlabels-right">
  382. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <p>Initialize SD card in SPI mode.</p>
  387. <dl class="params"><dt>Parameters</dt><dd>
  388. <table class="params">
  389. <tr><td class="paramdir">[in]</td><td class="paramname">spiConfig</td><td>SPI configuration. </td></tr>
  390. </table>
  391. </dd>
  392. </dl>
  393. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  394. </div>
  395. </div>
  396. <a id="a64cd10a3ce5ee342d0fd31738f385362"></a>
  397. <h2 class="memtitle"><span class="permalink"><a href="#a64cd10a3ce5ee342d0fd31738f385362">&#9670;&nbsp;</a></span>cardBegin() <span class="overload">[2/2]</span></h2>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="mlabels">
  401. <tr>
  402. <td class="mlabels-left">
  403. <table class="memname">
  404. <tr>
  405. <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>
  406. <td>(</td>
  407. <td class="paramtype"><a class="el" href="class_sdio_config.html">SdioConfig</a>&#160;</td>
  408. <td class="paramname"><em>sdioConfig</em></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </td>
  413. <td class="mlabels-right">
  414. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Initialize SD card in SDIO mode.</p>
  419. <dl class="params"><dt>Parameters</dt><dd>
  420. <table class="params">
  421. <tr><td class="paramdir">[in]</td><td class="paramname">sdioConfig</td><td>SDIO configuration. </td></tr>
  422. </table>
  423. </dd>
  424. </dl>
  425. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  426. </div>
  427. </div>
  428. <a id="abcc645df09441d40c476e4981393c944"></a>
  429. <h2 class="memtitle"><span class="permalink"><a href="#abcc645df09441d40c476e4981393c944">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/2]</span></h2>
  430. <div class="memitem">
  431. <div class="memproto">
  432. <table class="mlabels">
  433. <tr>
  434. <td class="mlabels-left">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname">bool FsVolume::chdir </td>
  438. <td>(</td>
  439. <td class="paramname"></td><td>)</td>
  440. <td></td>
  441. </tr>
  442. </table>
  443. </td>
  444. <td class="mlabels-right">
  445. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <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>
  450. </div>
  451. </div>
  452. <a id="ac4f62724d5eeaec3582594bb3b4c3e65"></a>
  453. <h2 class="memtitle"><span class="permalink"><a href="#ac4f62724d5eeaec3582594bb3b4c3e65">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/2]</span></h2>
  454. <div class="memitem">
  455. <div class="memproto">
  456. <table class="mlabels">
  457. <tr>
  458. <td class="mlabels-left">
  459. <table class="memname">
  460. <tr>
  461. <td class="memname">bool FsVolume::chdir </td>
  462. <td>(</td>
  463. <td class="paramtype">const char *&#160;</td>
  464. <td class="paramname"><em>path</em></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </td>
  469. <td class="mlabels-right">
  470. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  475. <table class="params">
  476. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  477. </table>
  478. </dd>
  479. </dl>
  480. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  481. </div>
  482. </div>
  483. <a id="a34a5bb7a97a081a7d74cf297f1fbee82"></a>
  484. <h2 class="memtitle"><span class="permalink"><a href="#a34a5bb7a97a081a7d74cf297f1fbee82">&#9670;&nbsp;</a></span>chvol()</h2>
  485. <div class="memitem">
  486. <div class="memproto">
  487. <table class="mlabels">
  488. <tr>
  489. <td class="mlabels-left">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">void FsVolume::chvol </td>
  493. <td>(</td>
  494. <td class="paramname"></td><td>)</td>
  495. <td></td>
  496. </tr>
  497. </table>
  498. </td>
  499. <td class="mlabels-right">
  500. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. <p>Change global working volume to this volume. </p>
  505. </div>
  506. </div>
  507. <a id="abc9731fa79598460a37f10a2e561f29c"></a>
  508. <h2 class="memtitle"><span class="permalink"><a href="#abc9731fa79598460a37f10a2e561f29c">&#9670;&nbsp;</a></span>clusterCount()</h2>
  509. <div class="memitem">
  510. <div class="memproto">
  511. <table class="mlabels">
  512. <tr>
  513. <td class="mlabels-left">
  514. <table class="memname">
  515. <tr>
  516. <td class="memname">uint32_t FsVolume::clusterCount </td>
  517. <td>(</td>
  518. <td class="paramname"></td><td>)</td>
  519. <td></td>
  520. </tr>
  521. </table>
  522. </td>
  523. <td class="mlabels-right">
  524. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  529. </div>
  530. </div>
  531. <a id="ab4fa0f21669b84e00d00fd54c3144a8f"></a>
  532. <h2 class="memtitle"><span class="permalink"><a href="#ab4fa0f21669b84e00d00fd54c3144a8f">&#9670;&nbsp;</a></span>cwv()</h2>
  533. <div class="memitem">
  534. <div class="memproto">
  535. <table class="mlabels">
  536. <tr>
  537. <td class="mlabels-left">
  538. <table class="memname">
  539. <tr>
  540. <td class="memname">static <a class="el" href="class_fs_volume.html">FsVolume</a>* FsVolume::cwv </td>
  541. <td>(</td>
  542. <td class="paramname"></td><td>)</td>
  543. <td></td>
  544. </tr>
  545. </table>
  546. </td>
  547. <td class="mlabels-right">
  548. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  553. </div>
  554. </div>
  555. <a id="a79cebeb23cb3cdaa06550475fe24272a"></a>
  556. <h2 class="memtitle"><span class="permalink"><a href="#a79cebeb23cb3cdaa06550475fe24272a">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="mlabels">
  560. <tr>
  561. <td class="mlabels-left">
  562. <table class="memname">
  563. <tr>
  564. <td class="memname">uint32_t FsVolume::dataStartSector </td>
  565. <td>(</td>
  566. <td class="paramname"></td><td>)</td>
  567. <td> const</td>
  568. </tr>
  569. </table>
  570. </td>
  571. <td class="mlabels-right">
  572. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  573. </tr>
  574. </table>
  575. </div><div class="memdoc">
  576. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  577. </div>
  578. </div>
  579. <a id="acd5a0e50a30334785d75a8c8bfc3e1f9"></a>
  580. <h2 class="memtitle"><span class="permalink"><a href="#acd5a0e50a30334785d75a8c8bfc3e1f9">&#9670;&nbsp;</a></span>end()</h2>
  581. <div class="memitem">
  582. <div class="memproto">
  583. <table class="mlabels">
  584. <tr>
  585. <td class="mlabels-left">
  586. <table class="memname">
  587. <tr>
  588. <td class="memname">void FsVolume::end </td>
  589. <td>(</td>
  590. <td class="paramname"></td><td>)</td>
  591. <td></td>
  592. </tr>
  593. </table>
  594. </td>
  595. <td class="mlabels-right">
  596. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  597. </tr>
  598. </table>
  599. </div><div class="memdoc">
  600. <p>free dynamic memory and end access to volume </p>
  601. </div>
  602. </div>
  603. <a id="ac9d239810a48c90bd0f3a3e9c4c606a9"></a>
  604. <h2 class="memtitle"><span class="permalink"><a href="#ac9d239810a48c90bd0f3a3e9c4c606a9">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[1/3]</span></h2>
  605. <div class="memitem">
  606. <div class="memproto">
  607. <table class="mlabels">
  608. <tr>
  609. <td class="mlabels-left">
  610. <table class="memname">
  611. <tr>
  612. <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>
  613. <td>(</td>
  614. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  615. <td class="paramname"><em>pr</em></td><td>)</td>
  616. <td></td>
  617. </tr>
  618. </table>
  619. </td>
  620. <td class="mlabels-right">
  621. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <p>Print error info and halt.</p>
  626. <dl class="params"><dt>Parameters</dt><dd>
  627. <table class="params">
  628. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  629. </table>
  630. </dd>
  631. </dl>
  632. </div>
  633. </div>
  634. <a id="a1691b7a85fc11851a6942de035d73772"></a>
  635. <h2 class="memtitle"><span class="permalink"><a href="#a1691b7a85fc11851a6942de035d73772">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[2/3]</span></h2>
  636. <div class="memitem">
  637. <div class="memproto">
  638. <table class="mlabels">
  639. <tr>
  640. <td class="mlabels-left">
  641. <table class="memname">
  642. <tr>
  643. <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>
  644. <td>(</td>
  645. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  646. <td class="paramname"><em>pr</em>, </td>
  647. </tr>
  648. <tr>
  649. <td class="paramkey"></td>
  650. <td></td>
  651. <td class="paramtype">const char *&#160;</td>
  652. <td class="paramname"><em>msg</em>&#160;</td>
  653. </tr>
  654. <tr>
  655. <td></td>
  656. <td>)</td>
  657. <td></td><td></td>
  658. </tr>
  659. </table>
  660. </td>
  661. <td class="mlabels-right">
  662. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  663. </tr>
  664. </table>
  665. </div><div class="memdoc">
  666. <p>Print error info and halt.</p>
  667. <dl class="params"><dt>Parameters</dt><dd>
  668. <table class="params">
  669. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  670. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  671. </table>
  672. </dd>
  673. </dl>
  674. </div>
  675. </div>
  676. <a id="ac530fe041855d994a53d2e1b9c33f22d"></a>
  677. <h2 class="memtitle"><span class="permalink"><a href="#ac530fe041855d994a53d2e1b9c33f22d">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[3/3]</span></h2>
  678. <div class="memitem">
  679. <div class="memproto">
  680. <table class="mlabels">
  681. <tr>
  682. <td class="mlabels-left">
  683. <table class="memname">
  684. <tr>
  685. <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>
  686. <td>(</td>
  687. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  688. <td class="paramname"><em>pr</em>, </td>
  689. </tr>
  690. <tr>
  691. <td class="paramkey"></td>
  692. <td></td>
  693. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  694. <td class="paramname"><em>msg</em>&#160;</td>
  695. </tr>
  696. <tr>
  697. <td></td>
  698. <td>)</td>
  699. <td></td><td></td>
  700. </tr>
  701. </table>
  702. </td>
  703. <td class="mlabels-right">
  704. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  705. </tr>
  706. </table>
  707. </div><div class="memdoc">
  708. <p>Print msg and halt.</p>
  709. <dl class="params"><dt>Parameters</dt><dd>
  710. <table class="params">
  711. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  712. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  713. </table>
  714. </dd>
  715. </dl>
  716. </div>
  717. </div>
  718. <a id="a22d184b3266ae7cb31ab47b7203e91ac"></a>
  719. <h2 class="memtitle"><span class="permalink"><a href="#a22d184b3266ae7cb31ab47b7203e91ac">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[1/3]</span></h2>
  720. <div class="memitem">
  721. <div class="memproto">
  722. <table class="mlabels">
  723. <tr>
  724. <td class="mlabels-left">
  725. <table class="memname">
  726. <tr>
  727. <td class="memname">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>
  728. <td>(</td>
  729. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  730. <td class="paramname"><em>pr</em></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 SD errorCode and errorData.</p>
  741. <dl class="params"><dt>Parameters</dt><dd>
  742. <table class="params">
  743. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  744. </table>
  745. </dd>
  746. </dl>
  747. </div>
  748. </div>
  749. <a id="a7d119e8ae896cc4caa073e9f54823f3e"></a>
  750. <h2 class="memtitle"><span class="permalink"><a href="#a7d119e8ae896cc4caa073e9f54823f3e">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[2/3]</span></h2>
  751. <div class="memitem">
  752. <div class="memproto">
  753. <table class="mlabels">
  754. <tr>
  755. <td class="mlabels-left">
  756. <table class="memname">
  757. <tr>
  758. <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>
  759. <td>(</td>
  760. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  761. <td class="paramname"><em>pr</em>, </td>
  762. </tr>
  763. <tr>
  764. <td class="paramkey"></td>
  765. <td></td>
  766. <td class="paramtype">char const *&#160;</td>
  767. <td class="paramname"><em>msg</em>&#160;</td>
  768. </tr>
  769. <tr>
  770. <td></td>
  771. <td>)</td>
  772. <td></td><td></td>
  773. </tr>
  774. </table>
  775. </td>
  776. <td class="mlabels-right">
  777. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>Print msg, any SD error code.</p>
  782. <dl class="params"><dt>Parameters</dt><dd>
  783. <table class="params">
  784. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  785. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  786. </table>
  787. </dd>
  788. </dl>
  789. </div>
  790. </div>
  791. <a id="a6793653198ce4c570ae92d2f9436dca9"></a>
  792. <h2 class="memtitle"><span class="permalink"><a href="#a6793653198ce4c570ae92d2f9436dca9">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[3/3]</span></h2>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="mlabels">
  796. <tr>
  797. <td class="mlabels-left">
  798. <table class="memname">
  799. <tr>
  800. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fs_volume.html">FsVolume</a> &gt;::errorPrint </td>
  801. <td>(</td>
  802. <td class="paramtype">Print *&#160;</td>
  803. <td class="paramname"><em>pr</em>, </td>
  804. </tr>
  805. <tr>
  806. <td class="paramkey"></td>
  807. <td></td>
  808. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  809. <td class="paramname"><em>msg</em>&#160;</td>
  810. </tr>
  811. <tr>
  812. <td></td>
  813. <td>)</td>
  814. <td></td><td></td>
  815. </tr>
  816. </table>
  817. </td>
  818. <td class="mlabels-right">
  819. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  820. </tr>
  821. </table>
  822. </div><div class="memdoc">
  823. <p>Print msg, any SD error code.</p>
  824. <dl class="params"><dt>Parameters</dt><dd>
  825. <table class="params">
  826. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  827. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  828. </table>
  829. </dd>
  830. </dl>
  831. </div>
  832. </div>
  833. <a id="a9bece771399c97b136868f684c2b4496"></a>
  834. <h2 class="memtitle"><span class="permalink"><a href="#a9bece771399c97b136868f684c2b4496">&#9670;&nbsp;</a></span>exists()</h2>
  835. <div class="memitem">
  836. <div class="memproto">
  837. <table class="mlabels">
  838. <tr>
  839. <td class="mlabels-left">
  840. <table class="memname">
  841. <tr>
  842. <td class="memname">bool FsVolume::exists </td>
  843. <td>(</td>
  844. <td class="paramtype">const char *&#160;</td>
  845. <td class="paramname"><em>path</em></td><td>)</td>
  846. <td></td>
  847. </tr>
  848. </table>
  849. </td>
  850. <td class="mlabels-right">
  851. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  852. </tr>
  853. </table>
  854. </div><div class="memdoc">
  855. <p>Test for the existence of a file in a directory</p>
  856. <dl class="params"><dt>Parameters</dt><dd>
  857. <table class="params">
  858. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  859. </table>
  860. </dd>
  861. </dl>
  862. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  863. </div>
  864. </div>
  865. <a id="ac5f4de35d2bfdd65bc38c2562b147a26"></a>
  866. <h2 class="memtitle"><span class="permalink"><a href="#ac5f4de35d2bfdd65bc38c2562b147a26">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  867. <div class="memitem">
  868. <div class="memproto">
  869. <table class="mlabels">
  870. <tr>
  871. <td class="mlabels-left">
  872. <table class="memname">
  873. <tr>
  874. <td class="memname">uint32_t FsVolume::fatStartSector </td>
  875. <td>(</td>
  876. <td class="paramname"></td><td>)</td>
  877. <td> const</td>
  878. </tr>
  879. </table>
  880. </td>
  881. <td class="mlabels-right">
  882. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  883. </tr>
  884. </table>
  885. </div><div class="memdoc">
  886. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  887. </div>
  888. </div>
  889. <a id="ad26b5c171ca4c6e953cfbdbfe0b9a988"></a>
  890. <h2 class="memtitle"><span class="permalink"><a href="#ad26b5c171ca4c6e953cfbdbfe0b9a988">&#9670;&nbsp;</a></span>fatType()</h2>
  891. <div class="memitem">
  892. <div class="memproto">
  893. <table class="mlabels">
  894. <tr>
  895. <td class="mlabels-left">
  896. <table class="memname">
  897. <tr>
  898. <td class="memname">uint8_t FsVolume::fatType </td>
  899. <td>(</td>
  900. <td class="paramname"></td><td>)</td>
  901. <td> const</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. <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>
  911. </div>
  912. </div>
  913. <a id="af6dbe47dfe11adf752df95c351b10fdd"></a>
  914. <h2 class="memtitle"><span class="permalink"><a href="#af6dbe47dfe11adf752df95c351b10fdd">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  915. <div class="memitem">
  916. <div class="memproto">
  917. <table class="mlabels">
  918. <tr>
  919. <td class="mlabels-left">
  920. <table class="memname">
  921. <tr>
  922. <td class="memname">uint32_t FsVolume::freeClusterCount </td>
  923. <td>(</td>
  924. <td class="paramname"></td><td>)</td>
  925. <td></td>
  926. </tr>
  927. </table>
  928. </td>
  929. <td class="mlabels-right">
  930. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  931. </tr>
  932. </table>
  933. </div><div class="memdoc">
  934. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>
  935. </div>
  936. </div>
  937. <a id="acb8180faf22cf72d97ec81330a700b05"></a>
  938. <h2 class="memtitle"><span class="permalink"><a href="#acb8180faf22cf72d97ec81330a700b05">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[1/3]</span></h2>
  939. <div class="memitem">
  940. <div class="memproto">
  941. <table class="mlabels">
  942. <tr>
  943. <td class="mlabels-left">
  944. <table class="memname">
  945. <tr>
  946. <td class="memname">void <a class="el" href="class_sd_base.html">SdBase</a>&lt; <a class="el" href="class_fs_volume.html">FsVolume</a> &gt;::initErrorHalt </td>
  947. <td>(</td>
  948. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  949. <td class="paramname"><em>pr</em></td><td>)</td>
  950. <td></td>
  951. </tr>
  952. </table>
  953. </td>
  954. <td class="mlabels-right">
  955. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  956. </tr>
  957. </table>
  958. </div><div class="memdoc">
  959. <p>Print error info and halt.</p>
  960. <dl class="params"><dt>Parameters</dt><dd>
  961. <table class="params">
  962. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  963. </table>
  964. </dd>
  965. </dl>
  966. </div>
  967. </div>
  968. <a id="aef6fd47c67b9b8498c1398e58422f169"></a>
  969. <h2 class="memtitle"><span class="permalink"><a href="#aef6fd47c67b9b8498c1398e58422f169">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[2/3]</span></h2>
  970. <div class="memitem">
  971. <div class="memproto">
  972. <table class="mlabels">
  973. <tr>
  974. <td class="mlabels-left">
  975. <table class="memname">
  976. <tr>
  977. <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>
  978. <td>(</td>
  979. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  980. <td class="paramname"><em>pr</em>, </td>
  981. </tr>
  982. <tr>
  983. <td class="paramkey"></td>
  984. <td></td>
  985. <td class="paramtype">const char *&#160;</td>
  986. <td class="paramname"><em>msg</em>&#160;</td>
  987. </tr>
  988. <tr>
  989. <td></td>
  990. <td>)</td>
  991. <td></td><td></td>
  992. </tr>
  993. </table>
  994. </td>
  995. <td class="mlabels-right">
  996. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  997. </tr>
  998. </table>
  999. </div><div class="memdoc">
  1000. <p>Print error info and halt.</p>
  1001. <dl class="params"><dt>Parameters</dt><dd>
  1002. <table class="params">
  1003. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1004. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1005. </table>
  1006. </dd>
  1007. </dl>
  1008. </div>
  1009. </div>
  1010. <a id="a8a249b866a4b24ac0a0753f966aab299"></a>
  1011. <h2 class="memtitle"><span class="permalink"><a href="#a8a249b866a4b24ac0a0753f966aab299">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[3/3]</span></h2>
  1012. <div class="memitem">
  1013. <div class="memproto">
  1014. <table class="mlabels">
  1015. <tr>
  1016. <td class="mlabels-left">
  1017. <table class="memname">
  1018. <tr>
  1019. <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>
  1020. <td>(</td>
  1021. <td class="paramtype">Print *&#160;</td>
  1022. <td class="paramname"><em>pr</em>, </td>
  1023. </tr>
  1024. <tr>
  1025. <td class="paramkey"></td>
  1026. <td></td>
  1027. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1028. <td class="paramname"><em>msg</em>&#160;</td>
  1029. </tr>
  1030. <tr>
  1031. <td></td>
  1032. <td>)</td>
  1033. <td></td><td></td>
  1034. </tr>
  1035. </table>
  1036. </td>
  1037. <td class="mlabels-right">
  1038. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1039. </tr>
  1040. </table>
  1041. </div><div class="memdoc">
  1042. <p>Print error info and halt.</p>
  1043. <dl class="params"><dt>Parameters</dt><dd>
  1044. <table class="params">
  1045. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1046. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1047. </table>
  1048. </dd>
  1049. </dl>
  1050. </div>
  1051. </div>
  1052. <a id="a918474d623107f64b7ab9ca88d6fe46f"></a>
  1053. <h2 class="memtitle"><span class="permalink"><a href="#a918474d623107f64b7ab9ca88d6fe46f">&#9670;&nbsp;</a></span>initErrorPrint()</h2>
  1054. <div class="memitem">
  1055. <div class="memproto">
  1056. <table class="mlabels">
  1057. <tr>
  1058. <td class="mlabels-left">
  1059. <table class="memname">
  1060. <tr>
  1061. <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>
  1062. <td>(</td>
  1063. <td class="paramtype">Print *&#160;</td>
  1064. <td class="paramname"><em>pr</em></td><td>)</td>
  1065. <td></td>
  1066. </tr>
  1067. </table>
  1068. </td>
  1069. <td class="mlabels-right">
  1070. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1071. </tr>
  1072. </table>
  1073. </div><div class="memdoc">
  1074. <p>Print error details after <a class="el" href="class_sd_base.html#a71f593c5a431b2cca0bd104af1a7e50a">begin()</a> fails.</p>
  1075. <dl class="params"><dt>Parameters</dt><dd>
  1076. <table class="params">
  1077. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1078. </table>
  1079. </dd>
  1080. </dl>
  1081. </div>
  1082. </div>
  1083. <a id="a679105032aa3e5c4585c63f8e7acfc02"></a>
  1084. <h2 class="memtitle"><span class="permalink"><a href="#a679105032aa3e5c4585c63f8e7acfc02">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/3]</span></h2>
  1085. <div class="memitem">
  1086. <div class="memproto">
  1087. <table class="mlabels">
  1088. <tr>
  1089. <td class="mlabels-left">
  1090. <table class="memname">
  1091. <tr>
  1092. <td class="memname">bool FsVolume::ls </td>
  1093. <td>(</td>
  1094. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1095. <td class="paramname"><em>pr</em></td><td>)</td>
  1096. <td></td>
  1097. </tr>
  1098. </table>
  1099. </td>
  1100. <td class="mlabels-right">
  1101. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1102. </tr>
  1103. </table>
  1104. </div><div class="memdoc">
  1105. <p>List directory contents.</p>
  1106. <dl class="params"><dt>Parameters</dt><dd>
  1107. <table class="params">
  1108. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object.</td></tr>
  1109. </table>
  1110. </dd>
  1111. </dl>
  1112. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1113. </div>
  1114. </div>
  1115. <a id="a5ce82e5970856d1e8d549c512ec8a253"></a>
  1116. <h2 class="memtitle"><span class="permalink"><a href="#a5ce82e5970856d1e8d549c512ec8a253">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/3]</span></h2>
  1117. <div class="memitem">
  1118. <div class="memproto">
  1119. <table class="mlabels">
  1120. <tr>
  1121. <td class="mlabels-left">
  1122. <table class="memname">
  1123. <tr>
  1124. <td class="memname">bool FsVolume::ls </td>
  1125. <td>(</td>
  1126. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1127. <td class="paramname"><em>pr</em>, </td>
  1128. </tr>
  1129. <tr>
  1130. <td class="paramkey"></td>
  1131. <td></td>
  1132. <td class="paramtype">uint8_t&#160;</td>
  1133. <td class="paramname"><em>flags</em>&#160;</td>
  1134. </tr>
  1135. <tr>
  1136. <td></td>
  1137. <td>)</td>
  1138. <td></td><td></td>
  1139. </tr>
  1140. </table>
  1141. </td>
  1142. <td class="mlabels-right">
  1143. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1144. </tr>
  1145. </table>
  1146. </div><div class="memdoc">
  1147. <p>List directory contents.</p>
  1148. <dl class="params"><dt>Parameters</dt><dd>
  1149. <table class="params">
  1150. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object. </td></tr>
  1151. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1152. </table>
  1153. </dd>
  1154. </dl>
  1155. <p>LS_DATE - Print file modification date</p>
  1156. <p>LS_SIZE - Print file size.</p>
  1157. <p>LS_R - Recursive list of subdirectories.</p>
  1158. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1159. </div>
  1160. </div>
  1161. <a id="ab429316ed9e57a52ecfb938aca7dff6c"></a>
  1162. <h2 class="memtitle"><span class="permalink"><a href="#ab429316ed9e57a52ecfb938aca7dff6c">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/3]</span></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">bool FsVolume::ls </td>
  1171. <td>(</td>
  1172. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1173. <td class="paramname"><em>pr</em>, </td>
  1174. </tr>
  1175. <tr>
  1176. <td class="paramkey"></td>
  1177. <td></td>
  1178. <td class="paramtype">const char *&#160;</td>
  1179. <td class="paramname"><em>path</em>, </td>
  1180. </tr>
  1181. <tr>
  1182. <td class="paramkey"></td>
  1183. <td></td>
  1184. <td class="paramtype">uint8_t&#160;</td>
  1185. <td class="paramname"><em>flags</em>&#160;</td>
  1186. </tr>
  1187. <tr>
  1188. <td></td>
  1189. <td>)</td>
  1190. <td></td><td></td>
  1191. </tr>
  1192. </table>
  1193. </td>
  1194. <td class="mlabels-right">
  1195. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1196. </tr>
  1197. </table>
  1198. </div><div class="memdoc">
  1199. <p>List the directory contents of a directory.</p>
  1200. <dl class="params"><dt>Parameters</dt><dd>
  1201. <table class="params">
  1202. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1203. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1204. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1205. </table>
  1206. </dd>
  1207. </dl>
  1208. <p>LS_DATE - Print file modification date</p>
  1209. <p>LS_SIZE - Print file size.</p>
  1210. <p>LS_R - Recursive list of subdirectories.</p>
  1211. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1212. </div>
  1213. </div>
  1214. <a id="a9d38c297dccceeb5f48dceb17232368d"></a>
  1215. <h2 class="memtitle"><span class="permalink"><a href="#a9d38c297dccceeb5f48dceb17232368d">&#9670;&nbsp;</a></span>mkdir()</h2>
  1216. <div class="memitem">
  1217. <div class="memproto">
  1218. <table class="mlabels">
  1219. <tr>
  1220. <td class="mlabels-left">
  1221. <table class="memname">
  1222. <tr>
  1223. <td class="memname">bool FsVolume::mkdir </td>
  1224. <td>(</td>
  1225. <td class="paramtype">const char *&#160;</td>
  1226. <td class="paramname"><em>path</em>, </td>
  1227. </tr>
  1228. <tr>
  1229. <td class="paramkey"></td>
  1230. <td></td>
  1231. <td class="paramtype">bool&#160;</td>
  1232. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1233. </tr>
  1234. <tr>
  1235. <td></td>
  1236. <td>)</td>
  1237. <td></td><td></td>
  1238. </tr>
  1239. </table>
  1240. </td>
  1241. <td class="mlabels-right">
  1242. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1243. </tr>
  1244. </table>
  1245. </div><div class="memdoc">
  1246. <p>Make a subdirectory in the volume root directory.</p>
  1247. <dl class="params"><dt>Parameters</dt><dd>
  1248. <table class="params">
  1249. <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>
  1250. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1251. </table>
  1252. </dd>
  1253. </dl>
  1254. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1255. </div>
  1256. </div>
  1257. <a id="a2f28fc92b7a71607bc57aa72f5a4c0a7"></a>
  1258. <h2 class="memtitle"><span class="permalink"><a href="#a2f28fc92b7a71607bc57aa72f5a4c0a7">&#9670;&nbsp;</a></span>open()</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"><a class="el" href="class_fs_file.html">FsFile</a> FsVolume::open </td>
  1267. <td>(</td>
  1268. <td class="paramtype">const char *&#160;</td>
  1269. <td class="paramname"><em>path</em>, </td>
  1270. </tr>
  1271. <tr>
  1272. <td class="paramkey"></td>
  1273. <td></td>
  1274. <td class="paramtype">oflag_t&#160;</td>
  1275. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1276. </tr>
  1277. <tr>
  1278. <td></td>
  1279. <td>)</td>
  1280. <td></td><td></td>
  1281. </tr>
  1282. </table>
  1283. </td>
  1284. <td class="mlabels-right">
  1285. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1286. </tr>
  1287. </table>
  1288. </div><div class="memdoc">
  1289. <p>open a file</p>
  1290. <dl class="params"><dt>Parameters</dt><dd>
  1291. <table class="params">
  1292. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1293. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1294. </table>
  1295. </dd>
  1296. </dl>
  1297. <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>
  1298. </div>
  1299. </div>
  1300. <a id="a234e80318c39229fe968a182b172148c"></a>
  1301. <h2 class="memtitle"><span class="permalink"><a href="#a234e80318c39229fe968a182b172148c">&#9670;&nbsp;</a></span>printFatType()</h2>
  1302. <div class="memitem">
  1303. <div class="memproto">
  1304. <table class="mlabels">
  1305. <tr>
  1306. <td class="mlabels-left">
  1307. <table class="memname">
  1308. <tr>
  1309. <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>
  1310. <td>(</td>
  1311. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1312. <td class="paramname"><em>pr</em></td><td>)</td>
  1313. <td></td>
  1314. </tr>
  1315. </table>
  1316. </td>
  1317. <td class="mlabels-right">
  1318. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1319. </tr>
  1320. </table>
  1321. </div><div class="memdoc">
  1322. <p>Print volume FAT/exFAT type.</p>
  1323. <dl class="params"><dt>Parameters</dt><dd>
  1324. <table class="params">
  1325. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1326. </table>
  1327. </dd>
  1328. </dl>
  1329. </div>
  1330. </div>
  1331. <a id="a6a8ba118e754b2b9fa0f34410163e228"></a>
  1332. <h2 class="memtitle"><span class="permalink"><a href="#a6a8ba118e754b2b9fa0f34410163e228">&#9670;&nbsp;</a></span>printSdError()</h2>
  1333. <div class="memitem">
  1334. <div class="memproto">
  1335. <table class="mlabels">
  1336. <tr>
  1337. <td class="mlabels-left">
  1338. <table class="memname">
  1339. <tr>
  1340. <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>
  1341. <td>(</td>
  1342. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1343. <td class="paramname"><em>pr</em></td><td>)</td>
  1344. <td></td>
  1345. </tr>
  1346. </table>
  1347. </td>
  1348. <td class="mlabels-right">
  1349. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1350. </tr>
  1351. </table>
  1352. </div><div class="memdoc">
  1353. <p>Print error info and return.</p>
  1354. <dl class="params"><dt>Parameters</dt><dd>
  1355. <table class="params">
  1356. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1357. </table>
  1358. </dd>
  1359. </dl>
  1360. </div>
  1361. </div>
  1362. <a id="aaaa53cfc48602b3d1524508944bd112e"></a>
  1363. <h2 class="memtitle"><span class="permalink"><a href="#aaaa53cfc48602b3d1524508944bd112e">&#9670;&nbsp;</a></span>remove()</h2>
  1364. <div class="memitem">
  1365. <div class="memproto">
  1366. <table class="mlabels">
  1367. <tr>
  1368. <td class="mlabels-left">
  1369. <table class="memname">
  1370. <tr>
  1371. <td class="memname">bool FsVolume::remove </td>
  1372. <td>(</td>
  1373. <td class="paramtype">const char *&#160;</td>
  1374. <td class="paramname"><em>path</em></td><td>)</td>
  1375. <td></td>
  1376. </tr>
  1377. </table>
  1378. </td>
  1379. <td class="mlabels-right">
  1380. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1381. </tr>
  1382. </table>
  1383. </div><div class="memdoc">
  1384. <p>Remove a file from the volume root directory.</p>
  1385. <dl class="params"><dt>Parameters</dt><dd>
  1386. <table class="params">
  1387. <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>
  1388. </table>
  1389. </dd>
  1390. </dl>
  1391. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1392. </div>
  1393. </div>
  1394. <a id="aae3be08aff89f5a113cfa0b89c4a6004"></a>
  1395. <h2 class="memtitle"><span class="permalink"><a href="#aae3be08aff89f5a113cfa0b89c4a6004">&#9670;&nbsp;</a></span>rename()</h2>
  1396. <div class="memitem">
  1397. <div class="memproto">
  1398. <table class="mlabels">
  1399. <tr>
  1400. <td class="mlabels-left">
  1401. <table class="memname">
  1402. <tr>
  1403. <td class="memname">bool FsVolume::rename </td>
  1404. <td>(</td>
  1405. <td class="paramtype">const char *&#160;</td>
  1406. <td class="paramname"><em>oldPath</em>, </td>
  1407. </tr>
  1408. <tr>
  1409. <td class="paramkey"></td>
  1410. <td></td>
  1411. <td class="paramtype">const char *&#160;</td>
  1412. <td class="paramname"><em>newPath</em>&#160;</td>
  1413. </tr>
  1414. <tr>
  1415. <td></td>
  1416. <td>)</td>
  1417. <td></td><td></td>
  1418. </tr>
  1419. </table>
  1420. </td>
  1421. <td class="mlabels-right">
  1422. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1423. </tr>
  1424. </table>
  1425. </div><div class="memdoc">
  1426. <p>Rename a file or subdirectory.</p>
  1427. <dl class="params"><dt>Parameters</dt><dd>
  1428. <table class="params">
  1429. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1430. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1431. </table>
  1432. </dd>
  1433. </dl>
  1434. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1435. <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>
  1436. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1437. </div>
  1438. </div>
  1439. <a id="ad2457b491bf85495140fd4a8ca743513"></a>
  1440. <h2 class="memtitle"><span class="permalink"><a href="#ad2457b491bf85495140fd4a8ca743513">&#9670;&nbsp;</a></span>rmdir()</h2>
  1441. <div class="memitem">
  1442. <div class="memproto">
  1443. <table class="mlabels">
  1444. <tr>
  1445. <td class="mlabels-left">
  1446. <table class="memname">
  1447. <tr>
  1448. <td class="memname">bool FsVolume::rmdir </td>
  1449. <td>(</td>
  1450. <td class="paramtype">const char *&#160;</td>
  1451. <td class="paramname"><em>path</em></td><td>)</td>
  1452. <td></td>
  1453. </tr>
  1454. </table>
  1455. </td>
  1456. <td class="mlabels-right">
  1457. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1458. </tr>
  1459. </table>
  1460. </div><div class="memdoc">
  1461. <p>Remove a subdirectory from the volume's root directory.</p>
  1462. <dl class="params"><dt>Parameters</dt><dd>
  1463. <table class="params">
  1464. <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>
  1465. </table>
  1466. </dd>
  1467. </dl>
  1468. <p>The subdirectory file will be removed only if it is empty.</p>
  1469. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1470. </div>
  1471. </div>
  1472. <a id="af2bb8fea732f9272a2e98772fbcc4595"></a>
  1473. <h2 class="memtitle"><span class="permalink"><a href="#af2bb8fea732f9272a2e98772fbcc4595">&#9670;&nbsp;</a></span>sdErrorCode()</h2>
  1474. <div class="memitem">
  1475. <div class="memproto">
  1476. <table class="mlabels">
  1477. <tr>
  1478. <td class="mlabels-left">
  1479. <table class="memname">
  1480. <tr>
  1481. <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>
  1482. <td>(</td>
  1483. <td class="paramname"></td><td>)</td>
  1484. <td></td>
  1485. </tr>
  1486. </table>
  1487. </td>
  1488. <td class="mlabels-right">
  1489. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1490. </tr>
  1491. </table>
  1492. </div><div class="memdoc">
  1493. <dl class="section return"><dt>Returns</dt><dd>SD card error code. </dd></dl>
  1494. </div>
  1495. </div>
  1496. <a id="a5f8f363b6c23f1d8bfeb858c946f1994"></a>
  1497. <h2 class="memtitle"><span class="permalink"><a href="#a5f8f363b6c23f1d8bfeb858c946f1994">&#9670;&nbsp;</a></span>sdErrorData()</h2>
  1498. <div class="memitem">
  1499. <div class="memproto">
  1500. <table class="mlabels">
  1501. <tr>
  1502. <td class="mlabels-left">
  1503. <table class="memname">
  1504. <tr>
  1505. <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>
  1506. <td>(</td>
  1507. <td class="paramname"></td><td>)</td>
  1508. <td></td>
  1509. </tr>
  1510. </table>
  1511. </td>
  1512. <td class="mlabels-right">
  1513. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1514. </tr>
  1515. </table>
  1516. </div><div class="memdoc">
  1517. <dl class="section return"><dt>Returns</dt><dd>SD card error data. </dd></dl>
  1518. </div>
  1519. </div>
  1520. <a id="acf62acd37d3f59dedd3e34b3e7d64da0"></a>
  1521. <h2 class="memtitle"><span class="permalink"><a href="#acf62acd37d3f59dedd3e34b3e7d64da0">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  1522. <div class="memitem">
  1523. <div class="memproto">
  1524. <table class="mlabels">
  1525. <tr>
  1526. <td class="mlabels-left">
  1527. <table class="memname">
  1528. <tr>
  1529. <td class="memname">uint32_t FsVolume::sectorsPerCluster </td>
  1530. <td>(</td>
  1531. <td class="paramname"></td><td>)</td>
  1532. <td> const</td>
  1533. </tr>
  1534. </table>
  1535. </td>
  1536. <td class="mlabels-right">
  1537. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1538. </tr>
  1539. </table>
  1540. </div><div class="memdoc">
  1541. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  1542. </div>
  1543. </div>
  1544. <a id="a20ed1868a6498cd336364c22d1df28a5"></a>
  1545. <h2 class="memtitle"><span class="permalink"><a href="#a20ed1868a6498cd336364c22d1df28a5">&#9670;&nbsp;</a></span>vol()</h2>
  1546. <div class="memitem">
  1547. <div class="memproto">
  1548. <table class="mlabels">
  1549. <tr>
  1550. <td class="mlabels-left">
  1551. <table class="memname">
  1552. <tr>
  1553. <td class="memname"><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>
  1554. <td>(</td>
  1555. <td class="paramname"></td><td>)</td>
  1556. <td></td>
  1557. </tr>
  1558. </table>
  1559. </td>
  1560. <td class="mlabels-right">
  1561. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1562. </tr>
  1563. </table>
  1564. </div><div class="memdoc">
  1565. <dl class="section return"><dt>Returns</dt><dd>pointer to base volume </dd></dl>
  1566. </div>
  1567. </div>
  1568. <a id="a1f1de2aac5384475b67506f86199e4c8"></a>
  1569. <h2 class="memtitle"><span class="permalink"><a href="#a1f1de2aac5384475b67506f86199e4c8">&#9670;&nbsp;</a></span>volumeBegin()</h2>
  1570. <div class="memitem">
  1571. <div class="memproto">
  1572. <table class="mlabels">
  1573. <tr>
  1574. <td class="mlabels-left">
  1575. <table class="memname">
  1576. <tr>
  1577. <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>
  1578. <td>(</td>
  1579. <td class="paramname"></td><td>)</td>
  1580. <td></td>
  1581. </tr>
  1582. </table>
  1583. </td>
  1584. <td class="mlabels-right">
  1585. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1586. </tr>
  1587. </table>
  1588. </div><div class="memdoc">
  1589. <p>Initialize file system after call to cardBegin.</p>
  1590. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1591. </div>
  1592. </div>
  1593. <hr/>The documentation for this class was generated from the following file:<ul>
  1594. <li>ArduinoSdFat/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  1595. </ul>
  1596. </div><!-- contents -->
  1597. <!-- start footer part -->
  1598. <hr class="footer"/><address class="footer"><small>
  1599. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1600. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1601. </a> 1.8.14
  1602. </small></address>
  1603. </body>
  1604. </html>