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.

1297 lines
56KB

  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: FsVolume 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="#friends">Friends</a> &#124;
  66. <a href="class_fs_volume-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">FsVolume Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><a class="el" href="class_fs_volume.html" title="FsVolume class.">FsVolume</a> class.
  72. <a href="class_fs_volume.html#details">More...</a></p>
  73. <p><code>#include &lt;FsVolume.h&gt;</code></p>
  74. <div class="dynheader">
  75. Inheritance diagram for FsVolume:</div>
  76. <div class="dyncontent">
  77. <div class="center"><img src="class_fs_volume__inherit__graph.png" border="0" usemap="#_fs_volume_inherit__map" alt="Inheritance graph"/></div>
  78. <map name="_fs_volume_inherit__map" id="_fs_volume_inherit__map">
  79. <area shape="rect" title="FsVolume class." alt="" coords="40,5,121,32"/>
  80. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,80,156,107"/>
  81. <area shape="rect" href="class_sd_fs.html" title="SD file system class for FAT16, FAT32, and exFAT volumes." alt="" coords="54,155,107,181"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  86. Public Member Functions</h2></td></tr>
  87. <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>
  88. <tr class="separator:ae587e7c114b0af86ec0b2927300133b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:a770e0dca5ed7f8d3ca63768da38042cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:abcc645df09441d40c476e4981393c944"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:ac4f62724d5eeaec3582594bb3b4c3e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a6c0758acb32b59c1861cc143612765d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:a34a5bb7a97a081a7d74cf297f1fbee82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:abc9731fa79598460a37f10a2e561f29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:a79cebeb23cb3cdaa06550475fe24272a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:acd5a0e50a30334785d75a8c8bfc3e1f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:a9bece771399c97b136868f684c2b4496"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:a5cabbe39ffc114d79ebe4e793024354e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:ac5f4de35d2bfdd65bc38c2562b147a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:ad26b5c171ca4c6e953cfbdbfe0b9a988"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:af6dbe47dfe11adf752df95c351b10fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:aac4bf1f75fd37ba2e5a145569ab0790b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a212afe6a3393930b5d9ec6be86aabcd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:a679105032aa3e5c4585c63f8e7acfc02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:ab429316ed9e57a52ecfb938aca7dff6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:a5ce82e5970856d1e8d549c512ec8a253"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:aed1c1e5e351b442ad8c0030bc63c655f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a9d38c297dccceeb5f48dceb17232368d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:a5d07b87552368dc66e08aab2e7be14af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="separator:a2f28fc92b7a71607bc57aa72f5a4c0a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:a55804d14db55dd29bf7b26d692275ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:aaaa53cfc48602b3d1524508944bd112e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a069e1d9b3a6bba07b7edc5dcde434e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:aae3be08aff89f5a113cfa0b89c4a6004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a7da5cf51eceaa2ea8799be05c3bf9258"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:ad2457b491bf85495140fd4a8ca743513"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:a32cdbc9c2d29ed95b2a7ff8d117dadc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:acf62acd37d3f59dedd3e34b3e7d64da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table><table class="memberdecls">
  150. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  151. Static Public Member Functions</h2></td></tr>
  152. <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>
  153. <tr class="separator:ab4fa0f21669b84e00d00fd54c3144a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table><table class="memberdecls">
  155. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  156. Friends</h2></td></tr>
  157. <tr class="memitem:a1655636bca63e3ac7e7ab6a8d112a2f0"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a1655636bca63e3ac7e7ab6a8d112a2f0">FsBaseFile</a></td></tr>
  158. <tr class="separator:a1655636bca63e3ac7e7ab6a8d112a2f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table>
  160. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  161. <div class="textblock"><p><a class="el" href="class_fs_volume.html" title="FsVolume class.">FsVolume</a> class. </p>
  162. </div><h2 class="groupheader">Member Function Documentation</h2>
  163. <a id="ae587e7c114b0af86ec0b2927300133b0"></a>
  164. <h2 class="memtitle"><span class="permalink"><a href="#ae587e7c114b0af86ec0b2927300133b0">&#9670;&nbsp;</a></span>begin()</h2>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">bool FsVolume::begin </td>
  170. <td>(</td>
  171. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  172. <td class="paramname"><em>blockDev</em></td><td>)</td>
  173. <td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <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>
  178. <table class="params">
  179. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  184. </div>
  185. </div>
  186. <a id="a770e0dca5ed7f8d3ca63768da38042cb"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#a770e0dca5ed7f8d3ca63768da38042cb">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="mlabels">
  191. <tr>
  192. <td class="mlabels-left">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">uint32_t FsVolume::bytesPerCluster </td>
  196. <td>(</td>
  197. <td class="paramname"></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </td>
  202. <td class="mlabels-right">
  203. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>
  208. </div>
  209. </div>
  210. <a id="abcc645df09441d40c476e4981393c944"></a>
  211. <h2 class="memtitle"><span class="permalink"><a href="#abcc645df09441d40c476e4981393c944">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/3]</span></h2>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="mlabels">
  215. <tr>
  216. <td class="mlabels-left">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">bool FsVolume::chdir </td>
  220. <td>(</td>
  221. <td class="paramname"></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <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>
  232. </div>
  233. </div>
  234. <a id="ac4f62724d5eeaec3582594bb3b4c3e65"></a>
  235. <h2 class="memtitle"><span class="permalink"><a href="#ac4f62724d5eeaec3582594bb3b4c3e65">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/3]</span></h2>
  236. <div class="memitem">
  237. <div class="memproto">
  238. <table class="mlabels">
  239. <tr>
  240. <td class="mlabels-left">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">bool FsVolume::chdir </td>
  244. <td>(</td>
  245. <td class="paramtype">const char *&#160;</td>
  246. <td class="paramname"><em>path</em></td><td>)</td>
  247. <td></td>
  248. </tr>
  249. </table>
  250. </td>
  251. <td class="mlabels-right">
  252. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  257. <table class="params">
  258. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  259. </table>
  260. </dd>
  261. </dl>
  262. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  263. </div>
  264. </div>
  265. <a id="a6c0758acb32b59c1861cc143612765d2"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#a6c0758acb32b59c1861cc143612765d2">&#9670;&nbsp;</a></span>chdir() <span class="overload">[3/3]</span></h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">bool FsVolume::chdir </td>
  275. <td>(</td>
  276. <td class="paramtype">const String &amp;&#160;</td>
  277. <td class="paramname"><em>path</em></td><td>)</td>
  278. <td></td>
  279. </tr>
  280. </table>
  281. </td>
  282. <td class="mlabels-right">
  283. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  288. <table class="params">
  289. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  290. </table>
  291. </dd>
  292. </dl>
  293. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  294. </div>
  295. </div>
  296. <a id="a34a5bb7a97a081a7d74cf297f1fbee82"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a34a5bb7a97a081a7d74cf297f1fbee82">&#9670;&nbsp;</a></span>chvol()</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">void FsVolume::chvol </td>
  306. <td>(</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Change global working volume to this volume. </p>
  318. </div>
  319. </div>
  320. <a id="abc9731fa79598460a37f10a2e561f29c"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#abc9731fa79598460a37f10a2e561f29c">&#9670;&nbsp;</a></span>clusterCount()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="mlabels">
  325. <tr>
  326. <td class="mlabels-left">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">uint32_t FsVolume::clusterCount </td>
  330. <td>(</td>
  331. <td class="paramname"></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </td>
  336. <td class="mlabels-right">
  337. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  342. </div>
  343. </div>
  344. <a id="ab4fa0f21669b84e00d00fd54c3144a8f"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#ab4fa0f21669b84e00d00fd54c3144a8f">&#9670;&nbsp;</a></span>cwv()</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">static <a class="el" href="class_fs_volume.html">FsVolume</a>* FsVolume::cwv </td>
  354. <td>(</td>
  355. <td class="paramname"></td><td>)</td>
  356. <td></td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  366. </div>
  367. </div>
  368. <a id="a79cebeb23cb3cdaa06550475fe24272a"></a>
  369. <h2 class="memtitle"><span class="permalink"><a href="#a79cebeb23cb3cdaa06550475fe24272a">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="mlabels">
  373. <tr>
  374. <td class="mlabels-left">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname">uint32_t FsVolume::dataStartSector </td>
  378. <td>(</td>
  379. <td class="paramname"></td><td>)</td>
  380. <td> const</td>
  381. </tr>
  382. </table>
  383. </td>
  384. <td class="mlabels-right">
  385. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  390. </div>
  391. </div>
  392. <a id="acd5a0e50a30334785d75a8c8bfc3e1f9"></a>
  393. <h2 class="memtitle"><span class="permalink"><a href="#acd5a0e50a30334785d75a8c8bfc3e1f9">&#9670;&nbsp;</a></span>end()</h2>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="mlabels">
  397. <tr>
  398. <td class="mlabels-left">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">void FsVolume::end </td>
  402. <td>(</td>
  403. <td class="paramname"></td><td>)</td>
  404. <td></td>
  405. </tr>
  406. </table>
  407. </td>
  408. <td class="mlabels-right">
  409. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>free dynamic memory and end access to volume </p>
  414. </div>
  415. </div>
  416. <a id="a9bece771399c97b136868f684c2b4496"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#a9bece771399c97b136868f684c2b4496">&#9670;&nbsp;</a></span>exists() <span class="overload">[1/2]</span></h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="mlabels">
  421. <tr>
  422. <td class="mlabels-left">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">bool FsVolume::exists </td>
  426. <td>(</td>
  427. <td class="paramtype">const char *&#160;</td>
  428. <td class="paramname"><em>path</em></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Test for the existence of a file in a directory</p>
  439. <dl class="params"><dt>Parameters</dt><dd>
  440. <table class="params">
  441. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  442. </table>
  443. </dd>
  444. </dl>
  445. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  446. </div>
  447. </div>
  448. <a id="a5cabbe39ffc114d79ebe4e793024354e"></a>
  449. <h2 class="memtitle"><span class="permalink"><a href="#a5cabbe39ffc114d79ebe4e793024354e">&#9670;&nbsp;</a></span>exists() <span class="overload">[2/2]</span></h2>
  450. <div class="memitem">
  451. <div class="memproto">
  452. <table class="mlabels">
  453. <tr>
  454. <td class="mlabels-left">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname">bool FsVolume::exists </td>
  458. <td>(</td>
  459. <td class="paramtype">const String &amp;&#160;</td>
  460. <td class="paramname"><em>path</em></td><td>)</td>
  461. <td></td>
  462. </tr>
  463. </table>
  464. </td>
  465. <td class="mlabels-right">
  466. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Test for the existence of a file in a directory</p>
  471. <dl class="params"><dt>Parameters</dt><dd>
  472. <table class="params">
  473. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  474. </table>
  475. </dd>
  476. </dl>
  477. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  478. </div>
  479. </div>
  480. <a id="ac5f4de35d2bfdd65bc38c2562b147a26"></a>
  481. <h2 class="memtitle"><span class="permalink"><a href="#ac5f4de35d2bfdd65bc38c2562b147a26">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">uint32_t FsVolume::fatStartSector </td>
  490. <td>(</td>
  491. <td class="paramname"></td><td>)</td>
  492. <td> const</td>
  493. </tr>
  494. </table>
  495. </td>
  496. <td class="mlabels-right">
  497. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  502. </div>
  503. </div>
  504. <a id="ad26b5c171ca4c6e953cfbdbfe0b9a988"></a>
  505. <h2 class="memtitle"><span class="permalink"><a href="#ad26b5c171ca4c6e953cfbdbfe0b9a988">&#9670;&nbsp;</a></span>fatType()</h2>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="mlabels">
  509. <tr>
  510. <td class="mlabels-left">
  511. <table class="memname">
  512. <tr>
  513. <td class="memname">uint8_t FsVolume::fatType </td>
  514. <td>(</td>
  515. <td class="paramname"></td><td>)</td>
  516. <td> const</td>
  517. </tr>
  518. </table>
  519. </td>
  520. <td class="mlabels-right">
  521. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  522. </tr>
  523. </table>
  524. </div><div class="memdoc">
  525. <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>
  526. </div>
  527. </div>
  528. <a id="af6dbe47dfe11adf752df95c351b10fdd"></a>
  529. <h2 class="memtitle"><span class="permalink"><a href="#af6dbe47dfe11adf752df95c351b10fdd">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="mlabels">
  533. <tr>
  534. <td class="mlabels-left">
  535. <table class="memname">
  536. <tr>
  537. <td class="memname">uint32_t FsVolume::freeClusterCount </td>
  538. <td>(</td>
  539. <td class="paramname"></td><td>)</td>
  540. <td></td>
  541. </tr>
  542. </table>
  543. </td>
  544. <td class="mlabels-right">
  545. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  546. </tr>
  547. </table>
  548. </div><div class="memdoc">
  549. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>
  550. </div>
  551. </div>
  552. <a id="aac4bf1f75fd37ba2e5a145569ab0790b"></a>
  553. <h2 class="memtitle"><span class="permalink"><a href="#aac4bf1f75fd37ba2e5a145569ab0790b">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/6]</span></h2>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <table class="mlabels">
  557. <tr>
  558. <td class="mlabels-left">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname">bool FsVolume::ls </td>
  562. <td>(</td>
  563. <td class="paramname"></td><td>)</td>
  564. <td></td>
  565. </tr>
  566. </table>
  567. </td>
  568. <td class="mlabels-right">
  569. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  570. </tr>
  571. </table>
  572. </div><div class="memdoc">
  573. <p>List directory contents. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  574. </div>
  575. </div>
  576. <a id="a212afe6a3393930b5d9ec6be86aabcd2"></a>
  577. <h2 class="memtitle"><span class="permalink"><a href="#a212afe6a3393930b5d9ec6be86aabcd2">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/6]</span></h2>
  578. <div class="memitem">
  579. <div class="memproto">
  580. <table class="mlabels">
  581. <tr>
  582. <td class="mlabels-left">
  583. <table class="memname">
  584. <tr>
  585. <td class="memname">bool FsVolume::ls </td>
  586. <td>(</td>
  587. <td class="paramtype">const char *&#160;</td>
  588. <td class="paramname"><em>path</em>, </td>
  589. </tr>
  590. <tr>
  591. <td class="paramkey"></td>
  592. <td></td>
  593. <td class="paramtype">uint8_t&#160;</td>
  594. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  595. </tr>
  596. <tr>
  597. <td></td>
  598. <td>)</td>
  599. <td></td><td></td>
  600. </tr>
  601. </table>
  602. </td>
  603. <td class="mlabels-right">
  604. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  605. </tr>
  606. </table>
  607. </div><div class="memdoc">
  608. <p>List the directory contents of a directory to Serial.</p>
  609. <dl class="params"><dt>Parameters</dt><dd>
  610. <table class="params">
  611. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  612. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  613. </table>
  614. </dd>
  615. </dl>
  616. <p>LS_DATE - Print file modification date</p>
  617. <p>LS_SIZE - Print file size.</p>
  618. <p>LS_R - Recursive list of subdirectories.</p>
  619. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure.</dd>
  620. <dd>
  621. true for success or false for failure. </dd></dl>
  622. </div>
  623. </div>
  624. <a id="a679105032aa3e5c4585c63f8e7acfc02"></a>
  625. <h2 class="memtitle"><span class="permalink"><a href="#a679105032aa3e5c4585c63f8e7acfc02">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/6]</span></h2>
  626. <div class="memitem">
  627. <div class="memproto">
  628. <table class="mlabels">
  629. <tr>
  630. <td class="mlabels-left">
  631. <table class="memname">
  632. <tr>
  633. <td class="memname">bool FsVolume::ls </td>
  634. <td>(</td>
  635. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  636. <td class="paramname"><em>pr</em></td><td>)</td>
  637. <td></td>
  638. </tr>
  639. </table>
  640. </td>
  641. <td class="mlabels-right">
  642. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  643. </tr>
  644. </table>
  645. </div><div class="memdoc">
  646. <p>List directory contents.</p>
  647. <dl class="params"><dt>Parameters</dt><dd>
  648. <table class="params">
  649. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object.</td></tr>
  650. </table>
  651. </dd>
  652. </dl>
  653. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  654. </div>
  655. </div>
  656. <a id="ab429316ed9e57a52ecfb938aca7dff6c"></a>
  657. <h2 class="memtitle"><span class="permalink"><a href="#ab429316ed9e57a52ecfb938aca7dff6c">&#9670;&nbsp;</a></span>ls() <span class="overload">[4/6]</span></h2>
  658. <div class="memitem">
  659. <div class="memproto">
  660. <table class="memname">
  661. <tr>
  662. <td class="memname">bool FsVolume::ls </td>
  663. <td>(</td>
  664. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  665. <td class="paramname"><em>pr</em>, </td>
  666. </tr>
  667. <tr>
  668. <td class="paramkey"></td>
  669. <td></td>
  670. <td class="paramtype">const char *&#160;</td>
  671. <td class="paramname"><em>path</em>, </td>
  672. </tr>
  673. <tr>
  674. <td class="paramkey"></td>
  675. <td></td>
  676. <td class="paramtype">uint8_t&#160;</td>
  677. <td class="paramname"><em>flags</em>&#160;</td>
  678. </tr>
  679. <tr>
  680. <td></td>
  681. <td>)</td>
  682. <td></td><td></td>
  683. </tr>
  684. </table>
  685. </div><div class="memdoc">
  686. <p>List the directory contents of a directory.</p>
  687. <dl class="params"><dt>Parameters</dt><dd>
  688. <table class="params">
  689. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  690. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  691. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  692. </table>
  693. </dd>
  694. </dl>
  695. <p>LS_DATE - Print file modification date</p>
  696. <p>LS_SIZE - Print file size.</p>
  697. <p>LS_R - Recursive list of subdirectories.</p>
  698. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  699. </div>
  700. </div>
  701. <a id="a5ce82e5970856d1e8d549c512ec8a253"></a>
  702. <h2 class="memtitle"><span class="permalink"><a href="#a5ce82e5970856d1e8d549c512ec8a253">&#9670;&nbsp;</a></span>ls() <span class="overload">[5/6]</span></h2>
  703. <div class="memitem">
  704. <div class="memproto">
  705. <table class="mlabels">
  706. <tr>
  707. <td class="mlabels-left">
  708. <table class="memname">
  709. <tr>
  710. <td class="memname">bool FsVolume::ls </td>
  711. <td>(</td>
  712. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  713. <td class="paramname"><em>pr</em>, </td>
  714. </tr>
  715. <tr>
  716. <td class="paramkey"></td>
  717. <td></td>
  718. <td class="paramtype">uint8_t&#160;</td>
  719. <td class="paramname"><em>flags</em>&#160;</td>
  720. </tr>
  721. <tr>
  722. <td></td>
  723. <td>)</td>
  724. <td></td><td></td>
  725. </tr>
  726. </table>
  727. </td>
  728. <td class="mlabels-right">
  729. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  730. </tr>
  731. </table>
  732. </div><div class="memdoc">
  733. <p>List directory contents.</p>
  734. <dl class="params"><dt>Parameters</dt><dd>
  735. <table class="params">
  736. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object. </td></tr>
  737. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  738. </table>
  739. </dd>
  740. </dl>
  741. <p>LS_DATE - Print file modification date</p>
  742. <p>LS_SIZE - Print file size.</p>
  743. <p>LS_R - Recursive list of subdirectories.</p>
  744. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  745. </div>
  746. </div>
  747. <a id="aed1c1e5e351b442ad8c0030bc63c655f"></a>
  748. <h2 class="memtitle"><span class="permalink"><a href="#aed1c1e5e351b442ad8c0030bc63c655f">&#9670;&nbsp;</a></span>ls() <span class="overload">[6/6]</span></h2>
  749. <div class="memitem">
  750. <div class="memproto">
  751. <table class="mlabels">
  752. <tr>
  753. <td class="mlabels-left">
  754. <table class="memname">
  755. <tr>
  756. <td class="memname">bool FsVolume::ls </td>
  757. <td>(</td>
  758. <td class="paramtype">uint8_t&#160;</td>
  759. <td class="paramname"><em>flags</em></td><td>)</td>
  760. <td></td>
  761. </tr>
  762. </table>
  763. </td>
  764. <td class="mlabels-right">
  765. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  766. </tr>
  767. </table>
  768. </div><div class="memdoc">
  769. <p>List directory contents.</p>
  770. <dl class="params"><dt>Parameters</dt><dd>
  771. <table class="params">
  772. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  773. </table>
  774. </dd>
  775. </dl>
  776. <p>LS_DATE - Print file modification date</p>
  777. <p>LS_SIZE - Print file size.</p>
  778. <p>LS_R - Recursive list of subdirectories.</p>
  779. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  780. </div>
  781. </div>
  782. <a id="a9d38c297dccceeb5f48dceb17232368d"></a>
  783. <h2 class="memtitle"><span class="permalink"><a href="#a9d38c297dccceeb5f48dceb17232368d">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[1/2]</span></h2>
  784. <div class="memitem">
  785. <div class="memproto">
  786. <table class="mlabels">
  787. <tr>
  788. <td class="mlabels-left">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname">bool FsVolume::mkdir </td>
  792. <td>(</td>
  793. <td class="paramtype">const char *&#160;</td>
  794. <td class="paramname"><em>path</em>, </td>
  795. </tr>
  796. <tr>
  797. <td class="paramkey"></td>
  798. <td></td>
  799. <td class="paramtype">bool&#160;</td>
  800. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  801. </tr>
  802. <tr>
  803. <td></td>
  804. <td>)</td>
  805. <td></td><td></td>
  806. </tr>
  807. </table>
  808. </td>
  809. <td class="mlabels-right">
  810. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  811. </tr>
  812. </table>
  813. </div><div class="memdoc">
  814. <p>Make a subdirectory in the volume root directory.</p>
  815. <dl class="params"><dt>Parameters</dt><dd>
  816. <table class="params">
  817. <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>
  818. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  819. </table>
  820. </dd>
  821. </dl>
  822. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  823. </div>
  824. </div>
  825. <a id="a5d07b87552368dc66e08aab2e7be14af"></a>
  826. <h2 class="memtitle"><span class="permalink"><a href="#a5d07b87552368dc66e08aab2e7be14af">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[2/2]</span></h2>
  827. <div class="memitem">
  828. <div class="memproto">
  829. <table class="mlabels">
  830. <tr>
  831. <td class="mlabels-left">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname">bool FsVolume::mkdir </td>
  835. <td>(</td>
  836. <td class="paramtype">const String &amp;&#160;</td>
  837. <td class="paramname"><em>path</em>, </td>
  838. </tr>
  839. <tr>
  840. <td class="paramkey"></td>
  841. <td></td>
  842. <td class="paramtype">bool&#160;</td>
  843. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  844. </tr>
  845. <tr>
  846. <td></td>
  847. <td>)</td>
  848. <td></td><td></td>
  849. </tr>
  850. </table>
  851. </td>
  852. <td class="mlabels-right">
  853. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  854. </tr>
  855. </table>
  856. </div><div class="memdoc">
  857. <p>Make a subdirectory in the volume root directory.</p>
  858. <dl class="params"><dt>Parameters</dt><dd>
  859. <table class="params">
  860. <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>
  861. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  862. </table>
  863. </dd>
  864. </dl>
  865. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  866. </div>
  867. </div>
  868. <a id="a2f28fc92b7a71607bc57aa72f5a4c0a7"></a>
  869. <h2 class="memtitle"><span class="permalink"><a href="#a2f28fc92b7a71607bc57aa72f5a4c0a7">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>
  870. <div class="memitem">
  871. <div class="memproto">
  872. <table class="memname">
  873. <tr>
  874. <td class="memname"><a class="el" href="class_fs_file.html">FsFile</a> FsVolume::open </td>
  875. <td>(</td>
  876. <td class="paramtype">const char *&#160;</td>
  877. <td class="paramname"><em>path</em>, </td>
  878. </tr>
  879. <tr>
  880. <td class="paramkey"></td>
  881. <td></td>
  882. <td class="paramtype">oflag_t&#160;</td>
  883. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  884. </tr>
  885. <tr>
  886. <td></td>
  887. <td>)</td>
  888. <td></td><td></td>
  889. </tr>
  890. </table>
  891. </div><div class="memdoc">
  892. <p>open a file</p>
  893. <dl class="params"><dt>Parameters</dt><dd>
  894. <table class="params">
  895. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  896. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  897. </table>
  898. </dd>
  899. </dl>
  900. <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>
  901. </div>
  902. </div>
  903. <a id="a55804d14db55dd29bf7b26d692275ac9"></a>
  904. <h2 class="memtitle"><span class="permalink"><a href="#a55804d14db55dd29bf7b26d692275ac9">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>
  905. <div class="memitem">
  906. <div class="memproto">
  907. <table class="memname">
  908. <tr>
  909. <td class="memname"><a class="el" href="class_fs_file.html">FsFile</a> FsVolume::open </td>
  910. <td>(</td>
  911. <td class="paramtype">const String &amp;&#160;</td>
  912. <td class="paramname"><em>path</em>, </td>
  913. </tr>
  914. <tr>
  915. <td class="paramkey"></td>
  916. <td></td>
  917. <td class="paramtype">oflag_t&#160;</td>
  918. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  919. </tr>
  920. <tr>
  921. <td></td>
  922. <td>)</td>
  923. <td></td><td></td>
  924. </tr>
  925. </table>
  926. </div><div class="memdoc">
  927. <p>open a file</p>
  928. <dl class="params"><dt>Parameters</dt><dd>
  929. <table class="params">
  930. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  931. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  932. </table>
  933. </dd>
  934. </dl>
  935. <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>
  936. </div>
  937. </div>
  938. <a id="aaaa53cfc48602b3d1524508944bd112e"></a>
  939. <h2 class="memtitle"><span class="permalink"><a href="#aaaa53cfc48602b3d1524508944bd112e">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  940. <div class="memitem">
  941. <div class="memproto">
  942. <table class="mlabels">
  943. <tr>
  944. <td class="mlabels-left">
  945. <table class="memname">
  946. <tr>
  947. <td class="memname">bool FsVolume::remove </td>
  948. <td>(</td>
  949. <td class="paramtype">const char *&#160;</td>
  950. <td class="paramname"><em>path</em></td><td>)</td>
  951. <td></td>
  952. </tr>
  953. </table>
  954. </td>
  955. <td class="mlabels-right">
  956. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  957. </tr>
  958. </table>
  959. </div><div class="memdoc">
  960. <p>Remove a file from the volume root directory.</p>
  961. <dl class="params"><dt>Parameters</dt><dd>
  962. <table class="params">
  963. <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>
  964. </table>
  965. </dd>
  966. </dl>
  967. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  968. </div>
  969. </div>
  970. <a id="a069e1d9b3a6bba07b7edc5dcde434e0c"></a>
  971. <h2 class="memtitle"><span class="permalink"><a href="#a069e1d9b3a6bba07b7edc5dcde434e0c">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  972. <div class="memitem">
  973. <div class="memproto">
  974. <table class="mlabels">
  975. <tr>
  976. <td class="mlabels-left">
  977. <table class="memname">
  978. <tr>
  979. <td class="memname">bool FsVolume::remove </td>
  980. <td>(</td>
  981. <td class="paramtype">const String &amp;&#160;</td>
  982. <td class="paramname"><em>path</em></td><td>)</td>
  983. <td></td>
  984. </tr>
  985. </table>
  986. </td>
  987. <td class="mlabels-right">
  988. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  989. </tr>
  990. </table>
  991. </div><div class="memdoc">
  992. <p>Remove a file from the volume root directory.</p>
  993. <dl class="params"><dt>Parameters</dt><dd>
  994. <table class="params">
  995. <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>
  996. </table>
  997. </dd>
  998. </dl>
  999. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1000. </div>
  1001. </div>
  1002. <a id="aae3be08aff89f5a113cfa0b89c4a6004"></a>
  1003. <h2 class="memtitle"><span class="permalink"><a href="#aae3be08aff89f5a113cfa0b89c4a6004">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  1004. <div class="memitem">
  1005. <div class="memproto">
  1006. <table class="mlabels">
  1007. <tr>
  1008. <td class="mlabels-left">
  1009. <table class="memname">
  1010. <tr>
  1011. <td class="memname">bool FsVolume::rename </td>
  1012. <td>(</td>
  1013. <td class="paramtype">const char *&#160;</td>
  1014. <td class="paramname"><em>oldPath</em>, </td>
  1015. </tr>
  1016. <tr>
  1017. <td class="paramkey"></td>
  1018. <td></td>
  1019. <td class="paramtype">const char *&#160;</td>
  1020. <td class="paramname"><em>newPath</em>&#160;</td>
  1021. </tr>
  1022. <tr>
  1023. <td></td>
  1024. <td>)</td>
  1025. <td></td><td></td>
  1026. </tr>
  1027. </table>
  1028. </td>
  1029. <td class="mlabels-right">
  1030. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1031. </tr>
  1032. </table>
  1033. </div><div class="memdoc">
  1034. <p>Rename a file or subdirectory.</p>
  1035. <dl class="params"><dt>Parameters</dt><dd>
  1036. <table class="params">
  1037. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1038. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1039. </table>
  1040. </dd>
  1041. </dl>
  1042. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1043. <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>
  1044. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1045. </div>
  1046. </div>
  1047. <a id="a7da5cf51eceaa2ea8799be05c3bf9258"></a>
  1048. <h2 class="memtitle"><span class="permalink"><a href="#a7da5cf51eceaa2ea8799be05c3bf9258">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  1049. <div class="memitem">
  1050. <div class="memproto">
  1051. <table class="mlabels">
  1052. <tr>
  1053. <td class="mlabels-left">
  1054. <table class="memname">
  1055. <tr>
  1056. <td class="memname">bool FsVolume::rename </td>
  1057. <td>(</td>
  1058. <td class="paramtype">const String &amp;&#160;</td>
  1059. <td class="paramname"><em>oldPath</em>, </td>
  1060. </tr>
  1061. <tr>
  1062. <td class="paramkey"></td>
  1063. <td></td>
  1064. <td class="paramtype">const String &amp;&#160;</td>
  1065. <td class="paramname"><em>newPath</em>&#160;</td>
  1066. </tr>
  1067. <tr>
  1068. <td></td>
  1069. <td>)</td>
  1070. <td></td><td></td>
  1071. </tr>
  1072. </table>
  1073. </td>
  1074. <td class="mlabels-right">
  1075. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1076. </tr>
  1077. </table>
  1078. </div><div class="memdoc">
  1079. <p>Rename a file or subdirectory.</p>
  1080. <dl class="params"><dt>Parameters</dt><dd>
  1081. <table class="params">
  1082. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1083. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1084. </table>
  1085. </dd>
  1086. </dl>
  1087. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1088. <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>
  1089. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1090. </div>
  1091. </div>
  1092. <a id="ad2457b491bf85495140fd4a8ca743513"></a>
  1093. <h2 class="memtitle"><span class="permalink"><a href="#ad2457b491bf85495140fd4a8ca743513">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[1/2]</span></h2>
  1094. <div class="memitem">
  1095. <div class="memproto">
  1096. <table class="mlabels">
  1097. <tr>
  1098. <td class="mlabels-left">
  1099. <table class="memname">
  1100. <tr>
  1101. <td class="memname">bool FsVolume::rmdir </td>
  1102. <td>(</td>
  1103. <td class="paramtype">const char *&#160;</td>
  1104. <td class="paramname"><em>path</em></td><td>)</td>
  1105. <td></td>
  1106. </tr>
  1107. </table>
  1108. </td>
  1109. <td class="mlabels-right">
  1110. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1111. </tr>
  1112. </table>
  1113. </div><div class="memdoc">
  1114. <p>Remove a subdirectory from the volume's root directory.</p>
  1115. <dl class="params"><dt>Parameters</dt><dd>
  1116. <table class="params">
  1117. <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>
  1118. </table>
  1119. </dd>
  1120. </dl>
  1121. <p>The subdirectory file will be removed only if it is empty.</p>
  1122. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1123. </div>
  1124. </div>
  1125. <a id="a32cdbc9c2d29ed95b2a7ff8d117dadc8"></a>
  1126. <h2 class="memtitle"><span class="permalink"><a href="#a32cdbc9c2d29ed95b2a7ff8d117dadc8">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[2/2]</span></h2>
  1127. <div class="memitem">
  1128. <div class="memproto">
  1129. <table class="mlabels">
  1130. <tr>
  1131. <td class="mlabels-left">
  1132. <table class="memname">
  1133. <tr>
  1134. <td class="memname">bool FsVolume::rmdir </td>
  1135. <td>(</td>
  1136. <td class="paramtype">const String &amp;&#160;</td>
  1137. <td class="paramname"><em>path</em></td><td>)</td>
  1138. <td></td>
  1139. </tr>
  1140. </table>
  1141. </td>
  1142. <td class="mlabels-right">
  1143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1144. </tr>
  1145. </table>
  1146. </div><div class="memdoc">
  1147. <p>Remove a subdirectory from the volume's root directory.</p>
  1148. <dl class="params"><dt>Parameters</dt><dd>
  1149. <table class="params">
  1150. <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>
  1151. </table>
  1152. </dd>
  1153. </dl>
  1154. <p>The subdirectory file will be removed only if it is empty.</p>
  1155. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1156. </div>
  1157. </div>
  1158. <a id="acf62acd37d3f59dedd3e34b3e7d64da0"></a>
  1159. <h2 class="memtitle"><span class="permalink"><a href="#acf62acd37d3f59dedd3e34b3e7d64da0">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  1160. <div class="memitem">
  1161. <div class="memproto">
  1162. <table class="mlabels">
  1163. <tr>
  1164. <td class="mlabels-left">
  1165. <table class="memname">
  1166. <tr>
  1167. <td class="memname">uint32_t FsVolume::sectorsPerCluster </td>
  1168. <td>(</td>
  1169. <td class="paramname"></td><td>)</td>
  1170. <td> const</td>
  1171. </tr>
  1172. </table>
  1173. </td>
  1174. <td class="mlabels-right">
  1175. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1176. </tr>
  1177. </table>
  1178. </div><div class="memdoc">
  1179. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  1180. </div>
  1181. </div>
  1182. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  1183. <a id="a1655636bca63e3ac7e7ab6a8d112a2f0"></a>
  1184. <h2 class="memtitle"><span class="permalink"><a href="#a1655636bca63e3ac7e7ab6a8d112a2f0">&#9670;&nbsp;</a></span>FsBaseFile</h2>
  1185. <div class="memitem">
  1186. <div class="memproto">
  1187. <table class="mlabels">
  1188. <tr>
  1189. <td class="mlabels-left">
  1190. <table class="memname">
  1191. <tr>
  1192. <td class="memname">friend class <a class="el" href="class_fs_base_file.html">FsBaseFile</a></td>
  1193. </tr>
  1194. </table>
  1195. </td>
  1196. <td class="mlabels-right">
  1197. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  1198. </tr>
  1199. </table>
  1200. </div><div class="memdoc">
  1201. <p>Rename a file or subdirectory.</p>
  1202. <dl class="params"><dt>Parameters</dt><dd>
  1203. <table class="params">
  1204. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1205. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1206. </table>
  1207. </dd>
  1208. </dl>
  1209. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1210. <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>
  1211. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. <a class="el" href="class_fs_base_file.html" title="FsBaseFile class.">FsBaseFile</a> allowed access to private members. </dd></dl>
  1212. </div>
  1213. </div>
  1214. <hr/>The documentation for this class was generated from the following files:<ul>
  1215. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/<a class="el" href="_fs_volume_8h.html">FsVolume.h</a></li>
  1216. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/FsVolume.cpp</li>
  1217. </ul>
  1218. </div><!-- contents -->
  1219. <!-- start footer part -->
  1220. <hr class="footer"/><address class="footer"><small>
  1221. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1222. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1223. </a> 1.8.16
  1224. </small></address>
  1225. </body>
  1226. </html>