visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_ex_fat_volume.html

1613 lines
70KB
Raw Permalink Blame History 

  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: ExFatVolume 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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  67. <a href="class_ex_fat_volume-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">ExFatVolume Class Reference</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. 

  73. <p>exFAT volume.  

  74.  <a href="class_ex_fat_volume.html#details">More...</a></p>

  75. 

  76. <p><code>#include &lt;ExFatVolume.h&gt;</code></p>

  77. <div class="dynheader">

  78. Inheritance diagram for ExFatVolume:</div>

  79. <div class="dyncontent">

  80. <div class="center"><img src="class_ex_fat_volume__inherit__graph.png" border="0" usemap="#_ex_fat_volume_inherit__map" alt="Inheritance graph"/></div>

  81. <map name="_ex_fat_volume_inherit__map" id="_ex_fat_volume_inherit__map">

  82. <area shape="rect" title="exFAT volume." alt="" coords="40,80,141,107"/>

  83. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,176,181"/>

  84. <area shape="rect" href="class_ex_fat_partition.html" title="Access exFat partitions on raw file devices." alt="" coords="38,5,143,32"/>

  85. <area shape="rect" href="class_sd_ex_fat.html" title="SD file system class for exFAT volumes." alt="" coords="54,229,127,256"/>

  86. </map>

  87. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  88. <div class="dynheader">

  89. Collaboration diagram for ExFatVolume:</div>

  90. <div class="dyncontent">

  91. <div class="center"><img src="class_ex_fat_volume__coll__graph.png" border="0" usemap="#_ex_fat_volume_coll__map" alt="Collaboration graph"/></div>

  92. <map name="_ex_fat_volume_coll__map" id="_ex_fat_volume_coll__map">

  93. <area shape="rect" title="exFAT volume." alt="" coords="7,80,109,107"/>

  94. <area shape="rect" href="class_ex_fat_partition.html" title="Access exFat partitions on raw file devices." alt="" coords="5,5,111,32"/>

  95. </map>

  96. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  97. <table class="memberdecls">

  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  99. Public Member Functions</h2></td></tr>

  100. <tr class="memitem:ade318d2517a1bd3abe56e9e530fdcd78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ade318d2517a1bd3abe56e9e530fdcd78">begin</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, bool setCwv=true, uint8_t part=1)</td></tr>

  101. <tr class="separator:ade318d2517a1bd3abe56e9e530fdcd78"><td class="memSeparator" colspan="2">&#160;</td></tr>

  102. <tr class="memitem:a1da789000f42592f9509df843fdd50c8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a1da789000f42592f9509df843fdd50c8">bytesPerCluster</a> ()</td></tr>

  103. <tr class="separator:a1da789000f42592f9509df843fdd50c8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  104. <tr class="memitem:a64825a52f754bdcb02c8632f5fd15373"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a64825a52f754bdcb02c8632f5fd15373">bytesPerClusterShift</a> ()</td></tr>

  105. <tr class="separator:a64825a52f754bdcb02c8632f5fd15373"><td class="memSeparator" colspan="2">&#160;</td></tr>

  106. <tr class="memitem:adea3221412eb4bf5c19b6311573135f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#adea3221412eb4bf5c19b6311573135f8">bytesPerSector</a> ()</td></tr>

  107. <tr class="separator:adea3221412eb4bf5c19b6311573135f8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  108. <tr class="memitem:a715f3574452c27ecf51b66208ce5e4a7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a715f3574452c27ecf51b66208ce5e4a7">bytesPerSectorShift</a> ()</td></tr>

  109. <tr class="separator:a715f3574452c27ecf51b66208ce5e4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  110. <tr class="memitem:a63fac808e421ed5c8e72a37616ac56ac"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a63fac808e421ed5c8e72a37616ac56ac">cacheClear</a> ()</td></tr>

  111. <tr class="separator:a63fac808e421ed5c8e72a37616ac56ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  112. <tr class="memitem:abdc1addfc9474bf42cab31bcb49b4b65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#abdc1addfc9474bf42cab31bcb49b4b65">chdir</a> ()</td></tr>

  113. <tr class="separator:abdc1addfc9474bf42cab31bcb49b4b65"><td class="memSeparator" colspan="2">&#160;</td></tr>

  114. <tr class="memitem:a4e0a0e838088f31b15a36925f21c314c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a4e0a0e838088f31b15a36925f21c314c">chdir</a> (const ExChar_t *path)</td></tr>

  115. <tr class="separator:a4e0a0e838088f31b15a36925f21c314c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. <tr class="memitem:afb7a1d7e4de9690b2c63cc8cd22ab4b5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#afb7a1d7e4de9690b2c63cc8cd22ab4b5">chdir</a> (const String &amp;path)</td></tr>

  117. <tr class="separator:afb7a1d7e4de9690b2c63cc8cd22ab4b5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <tr class="memitem:a6bcabab1ded2e71c1272c1baf009c2ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a6bcabab1ded2e71c1272c1baf009c2ab">chvol</a> ()</td></tr>

  119. <tr class="separator:a6bcabab1ded2e71c1272c1baf009c2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <tr class="memitem:ac01eb583924286617b0ee8fcf7409ac0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ac01eb583924286617b0ee8fcf7409ac0">clusterCount</a> ()</td></tr>

  121. <tr class="separator:ac01eb583924286617b0ee8fcf7409ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr class="memitem:a58b96587b787f4164eb719913dfbaaf5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a58b96587b787f4164eb719913dfbaaf5">clusterHeapStartSector</a> ()</td></tr>

  123. <tr class="separator:a58b96587b787f4164eb719913dfbaaf5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  124. <tr class="memitem:a7fdcdffb720a1cca5cfa73f4cfa281df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a7fdcdffb720a1cca5cfa73f4cfa281df">exists</a> (const ExChar_t *path)</td></tr>

  125. <tr class="separator:a7fdcdffb720a1cca5cfa73f4cfa281df"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <tr class="memitem:af705d3a2434d64efebaa5b3615131dc5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#af705d3a2434d64efebaa5b3615131dc5">exists</a> (const String &amp;path)</td></tr>

  127. <tr class="separator:af705d3a2434d64efebaa5b3615131dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#aa7d1ae15168896ccc2648b4c383b34eb">fatLength</a> ()</td></tr>

  129. <tr class="separator:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a9eff9e65b511ec06b62856bff8ed29eb">fatStartSector</a> ()</td></tr>

  131. <tr class="separator:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:a3e63d87b4ef985f92c1793d269274f44"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a3e63d87b4ef985f92c1793d269274f44">fatType</a> () const</td></tr>

  133. <tr class="separator:a3e63d87b4ef985f92c1793d269274f44"><td class="memSeparator" colspan="2">&#160;</td></tr>

  134. <tr class="memitem:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ae6d4414d6440b79b6314cd1edbaa35b0">freeClusterCount</a> ()</td></tr>

  135. <tr class="separator:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  136. <tr class="memitem:adb1d277492dccba09031e2064f4fa66f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#adb1d277492dccba09031e2064f4fa66f">init</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, uint8_t part)</td></tr>

  137. <tr class="separator:adb1d277492dccba09031e2064f4fa66f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:abe74c248cfe9d57d9a10f651203df9dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#abe74c248cfe9d57d9a10f651203df9dc">ls</a> ()</td></tr>

  139. <tr class="separator:abe74c248cfe9d57d9a10f651203df9dc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. <tr class="memitem:ad3a1aa9f64361b81d0cfe5b9f5de3891"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ad3a1aa9f64361b81d0cfe5b9f5de3891">ls</a> (const ExChar_t *path, uint8_t flags=0)</td></tr>

  141. <tr class="separator:ad3a1aa9f64361b81d0cfe5b9f5de3891"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:aad2de66514174edb37b0fe7e44b33abf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#aad2de66514174edb37b0fe7e44b33abf">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const ExChar_t *path, uint8_t flags)</td></tr>

  143. <tr class="separator:aad2de66514174edb37b0fe7e44b33abf"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:abe1e8cad0a5922984b28edfd987bc856"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#abe1e8cad0a5922984b28edfd987bc856">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>

  145. <tr class="separator:abe1e8cad0a5922984b28edfd987bc856"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. <tr class="memitem:ae883a72fbfe40f9a6fe6c6bf349d5c1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ae883a72fbfe40f9a6fe6c6bf349d5c1f">ls</a> (uint8_t flags)</td></tr>

  147. <tr class="separator:ae883a72fbfe40f9a6fe6c6bf349d5c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:a407b93b16554b26ff52f7b762a9217aa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a407b93b16554b26ff52f7b762a9217aa">mkdir</a> (const ExChar_t *path, bool pFlag=true)</td></tr>

  149. <tr class="separator:a407b93b16554b26ff52f7b762a9217aa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  150. <tr class="memitem:a0f4cf7e2853225380574724314327597"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a0f4cf7e2853225380574724314327597">mkdir</a> (const String &amp;path, bool pFlag=true)</td></tr>

  151. <tr class="separator:a0f4cf7e2853225380574724314327597"><td class="memSeparator" colspan="2">&#160;</td></tr>

  152. <tr class="memitem:a0807cfcef46ef74cfe238badb83f3dda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ex_file.html">ExFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a0807cfcef46ef74cfe238badb83f3dda">open</a> (const ExChar_t *path, oflag_t oflag=0X00)</td></tr>

  153. <tr class="separator:a0807cfcef46ef74cfe238badb83f3dda"><td class="memSeparator" colspan="2">&#160;</td></tr>

  154. <tr class="memitem:adce2c8ab2f73f56614b08fac42cabaea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ex_file.html">ExFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#adce2c8ab2f73f56614b08fac42cabaea">open</a> (const String &amp;path, oflag_t oflag=0X00)</td></tr>

  155. <tr class="separator:adce2c8ab2f73f56614b08fac42cabaea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  156. <tr class="memitem:a58061d05f5dc5a52706cdd61a1a86e80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a58061d05f5dc5a52706cdd61a1a86e80">remove</a> (const ExChar_t *path)</td></tr>

  157. <tr class="separator:a58061d05f5dc5a52706cdd61a1a86e80"><td class="memSeparator" colspan="2">&#160;</td></tr>

  158. <tr class="memitem:adc22ad4ce966654944b18d31fc6ac5ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#adc22ad4ce966654944b18d31fc6ac5ee">remove</a> (const String &amp;path)</td></tr>

  159. <tr class="separator:adc22ad4ce966654944b18d31fc6ac5ee"><td class="memSeparator" colspan="2">&#160;</td></tr>

  160. <tr class="memitem:a8dcd1b108167803a24f7314f5fce6bc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a8dcd1b108167803a24f7314f5fce6bc4">rename</a> (const ExChar_t *oldPath, const ExChar_t *newPath)</td></tr>

  161. <tr class="separator:a8dcd1b108167803a24f7314f5fce6bc4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  162. <tr class="memitem:a1396c06f6c5e138889125d2f62cdbdcb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a1396c06f6c5e138889125d2f62cdbdcb">rename</a> (const String &amp;oldPath, const String &amp;newPath)</td></tr>

  163. <tr class="separator:a1396c06f6c5e138889125d2f62cdbdcb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  164. <tr class="memitem:ab9e3e7d9538c905ca60b834e244943ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ab9e3e7d9538c905ca60b834e244943ee">rmdir</a> (const ExChar_t *path)</td></tr>

  165. <tr class="separator:ab9e3e7d9538c905ca60b834e244943ee"><td class="memSeparator" colspan="2">&#160;</td></tr>

  166. <tr class="memitem:af0adfad817e085d676479fefbb343197"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#af0adfad817e085d676479fefbb343197">rmdir</a> (const String &amp;path)</td></tr>

  167. <tr class="separator:af0adfad817e085d676479fefbb343197"><td class="memSeparator" colspan="2">&#160;</td></tr>

  168. <tr class="memitem:a658c250984be29febf8f4d2a2ec312a1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a658c250984be29febf8f4d2a2ec312a1">rootDirectoryCluster</a> ()</td></tr>

  169. <tr class="separator:a658c250984be29febf8f4d2a2ec312a1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  170. <tr class="memitem:a9412bd687edc99266c88f8aa87f01c51"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a9412bd687edc99266c88f8aa87f01c51">rootLength</a> ()</td></tr>

  171. <tr class="separator:a9412bd687edc99266c88f8aa87f01c51"><td class="memSeparator" colspan="2">&#160;</td></tr>

  172. <tr class="memitem:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#aaa7306ac8ff29f50ec4d919ccaff10d7">sectorsPerCluster</a> ()</td></tr>

  173. <tr class="separator:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  174. <tr class="memitem:ab1624bf02690ee06365207cb8f1d48ac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ab1624bf02690ee06365207cb8f1d48ac">sectorsPerClusterShift</a> ()</td></tr>

  175. <tr class="separator:ab1624bf02690ee06365207cb8f1d48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  176. <tr class="memitem:ae5cbcdd7907a882b4686cb3ba7e85bcc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ae5cbcdd7907a882b4686cb3ba7e85bcc">truncate</a> (const ExChar_t *path, uint64_t length)</td></tr>

  177. <tr class="separator:ae5cbcdd7907a882b4686cb3ba7e85bcc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  178. <tr class="memitem:ae6d409b7f24593dca7aae70513e18b70"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#ae6d409b7f24593dca7aae70513e18b70">truncate</a> (const String &amp;path, uint64_t length)</td></tr>

  179. <tr class="separator:ae6d409b7f24593dca7aae70513e18b70"><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:a5b2a874ef0306425bf54c18454771b45"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_volume.html#a5b2a874ef0306425bf54c18454771b45">cwv</a> ()</td></tr>

  184. <tr class="separator:a5b2a874ef0306425bf54c18454771b45"><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>exFAT volume. </p>

  188. <p>Copyright (c) 2011-2019 Bill Greiman This file is part of the SdFat library for SD memory cards.</p>

  189. <p>MIT License</p>

  190. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>

  191. <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>

  192. <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>

  193. </div><h2 class="groupheader">Member Function Documentation</h2>

  194. <a id="ade318d2517a1bd3abe56e9e530fdcd78"></a>

  195. <h2 class="memtitle"><span class="permalink"><a href="#ade318d2517a1bd3abe56e9e530fdcd78">&#9670;&nbsp;</a></span>begin()</h2>

  196. 

  197. <div class="memitem">

  198. <div class="memproto">

  199. <table class="mlabels">

  200.   <tr>

  201.   <td class="mlabels-left">

  202.       <table class="memname">

  203.         <tr>

  204.           <td class="memname">bool ExFatVolume::begin </td>

  205.           <td>(</td>

  206.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>

  207.           <td class="paramname"><em>dev</em>, </td>

  208.         </tr>

  209.         <tr>

  210.           <td class="paramkey"></td>

  211.           <td></td>

  212.           <td class="paramtype">bool&#160;</td>

  213.           <td class="paramname"><em>setCwv</em> = <code>true</code>, </td>

  214.         </tr>

  215.         <tr>

  216.           <td class="paramkey"></td>

  217.           <td></td>

  218.           <td class="paramtype">uint8_t&#160;</td>

  219.           <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>

  220.         </tr>

  221.         <tr>

  222.           <td></td>

  223.           <td>)</td>

  224.           <td></td><td></td>

  225.         </tr>

  226.       </table>

  227.   </td>

  228.   <td class="mlabels-right">

  229. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  230.   </tr>

  231. </table>

  232. </div><div class="memdoc">

  233. <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>

  234.   <table class="params">

  235.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Device block driver. </td></tr>

  236.     <tr><td class="paramdir">[in]</td><td class="paramname">setCwv</td><td>Set current working volume if true. </td></tr>

  237.     <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>

  238.   </table>

  239.   </dd>

  240. </dl>

  241. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  242. 

  243. </div>

  244. </div>

  245. <a id="a1da789000f42592f9509df843fdd50c8"></a>

  246. <h2 class="memtitle"><span class="permalink"><a href="#a1da789000f42592f9509df843fdd50c8">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>

  247. 

  248. <div class="memitem">

  249. <div class="memproto">

  250. <table class="mlabels">

  251.   <tr>

  252.   <td class="mlabels-left">

  253.       <table class="memname">

  254.         <tr>

  255.           <td class="memname">uint32_t ExFatPartition::bytesPerCluster </td>

  256.           <td>(</td>

  257.           <td class="paramname"></td><td>)</td>

  258.           <td></td>

  259.         </tr>

  260.       </table>

  261.   </td>

  262.   <td class="mlabels-right">

  263. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  264.   </tr>

  265. </table>

  266. </div><div class="memdoc">

  267. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>

  268. 

  269. </div>

  270. </div>

  271. <a id="a64825a52f754bdcb02c8632f5fd15373"></a>

  272. <h2 class="memtitle"><span class="permalink"><a href="#a64825a52f754bdcb02c8632f5fd15373">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>

  273. 

  274. <div class="memitem">

  275. <div class="memproto">

  276. <table class="mlabels">

  277.   <tr>

  278.   <td class="mlabels-left">

  279.       <table class="memname">

  280.         <tr>

  281.           <td class="memname">uint8_t ExFatPartition::bytesPerClusterShift </td>

  282.           <td>(</td>

  283.           <td class="paramname"></td><td>)</td>

  284.           <td></td>

  285.         </tr>

  286.       </table>

  287.   </td>

  288.   <td class="mlabels-right">

  289. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  290.   </tr>

  291. </table>

  292. </div><div class="memdoc">

  293. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerCluster. </dd></dl>

  294. 

  295. </div>

  296. </div>

  297. <a id="adea3221412eb4bf5c19b6311573135f8"></a>

  298. <h2 class="memtitle"><span class="permalink"><a href="#adea3221412eb4bf5c19b6311573135f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>

  299. 

  300. <div class="memitem">

  301. <div class="memproto">

  302. <table class="mlabels">

  303.   <tr>

  304.   <td class="mlabels-left">

  305.       <table class="memname">

  306.         <tr>

  307.           <td class="memname">uint16_t ExFatPartition::bytesPerSector </td>

  308.           <td>(</td>

  309.           <td class="paramname"></td><td>)</td>

  310.           <td></td>

  311.         </tr>

  312.       </table>

  313.   </td>

  314.   <td class="mlabels-right">

  315. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  316.   </tr>

  317. </table>

  318. </div><div class="memdoc">

  319. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a sector. </dd></dl>

  320. 

  321. </div>

  322. </div>

  323. <a id="a715f3574452c27ecf51b66208ce5e4a7"></a>

  324. <h2 class="memtitle"><span class="permalink"><a href="#a715f3574452c27ecf51b66208ce5e4a7">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

  330.   <td class="mlabels-left">

  331.       <table class="memname">

  332.         <tr>

  333.           <td class="memname">uint8_t ExFatPartition::bytesPerSectorShift </td>

  334.           <td>(</td>

  335.           <td class="paramname"></td><td>)</td>

  336.           <td></td>

  337.         </tr>

  338.       </table>

  339.   </td>

  340.   <td class="mlabels-right">

  341. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  342.   </tr>

  343. </table>

  344. </div><div class="memdoc">

  345. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerSector. </dd></dl>

  346. 

  347. </div>

  348. </div>

  349. <a id="a63fac808e421ed5c8e72a37616ac56ac"></a>

  350. <h2 class="memtitle"><span class="permalink"><a href="#a63fac808e421ed5c8e72a37616ac56ac">&#9670;&nbsp;</a></span>cacheClear()</h2>

  351. 

  352. <div class="memitem">

  353. <div class="memproto">

  354. <table class="mlabels">

  355.   <tr>

  356.   <td class="mlabels-left">

  357.       <table class="memname">

  358.         <tr>

  359.           <td class="memname">uint8_t* ExFatPartition::cacheClear </td>

  360.           <td>(</td>

  361.           <td class="paramname"></td><td>)</td>

  362.           <td></td>

  363.         </tr>

  364.       </table>

  365.   </td>

  366.   <td class="mlabels-right">

  367. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  368.   </tr>

  369. </table>

  370. </div><div class="memdoc">

  371. <p>Clear the cache and returns a pointer to the cache. Not for normal apps. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>

  372. 

  373. </div>

  374. </div>

  375. <a id="abdc1addfc9474bf42cab31bcb49b4b65"></a>

  376. <h2 class="memtitle"><span class="permalink"><a href="#abdc1addfc9474bf42cab31bcb49b4b65">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/3]</span></h2>

  377. 

  378. <div class="memitem">

  379. <div class="memproto">

  380. <table class="mlabels">

  381.   <tr>

  382.   <td class="mlabels-left">

  383.       <table class="memname">

  384.         <tr>

  385.           <td class="memname">bool ExFatVolume::chdir </td>

  386.           <td>(</td>

  387.           <td class="paramname"></td><td>)</td>

  388.           <td></td>

  389.         </tr>

  390.       </table>

  391.   </td>

  392.   <td class="mlabels-right">

  393. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  394.   </tr>

  395. </table>

  396. </div><div class="memdoc">

  397. <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>

  398. 

  399. </div>

  400. </div>

  401. <a id="a4e0a0e838088f31b15a36925f21c314c"></a>

  402. <h2 class="memtitle"><span class="permalink"><a href="#a4e0a0e838088f31b15a36925f21c314c">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/3]</span></h2>

  403. 

  404. <div class="memitem">

  405. <div class="memproto">

  406.       <table class="memname">

  407.         <tr>

  408.           <td class="memname">bool ExFatVolume::chdir </td>

  409.           <td>(</td>

  410.           <td class="paramtype">const ExChar_t *&#160;</td>

  411.           <td class="paramname"><em>path</em></td><td>)</td>

  412.           <td></td>

  413.         </tr>

  414.       </table>

  415. </div><div class="memdoc">

  416. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>

  417.   <table class="params">

  418.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>

  419.   </table>

  420.   </dd>

  421. </dl>

  422. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  423. 

  424. </div>

  425. </div>

  426. <a id="afb7a1d7e4de9690b2c63cc8cd22ab4b5"></a>

  427. <h2 class="memtitle"><span class="permalink"><a href="#afb7a1d7e4de9690b2c63cc8cd22ab4b5">&#9670;&nbsp;</a></span>chdir() <span class="overload">[3/3]</span></h2>

  428. 

  429. <div class="memitem">

  430. <div class="memproto">

  431. <table class="mlabels">

  432.   <tr>

  433.   <td class="mlabels-left">

  434.       <table class="memname">

  435.         <tr>

  436.           <td class="memname">bool ExFatVolume::chdir </td>

  437.           <td>(</td>

  438.           <td class="paramtype">const String &amp;&#160;</td>

  439.           <td class="paramname"><em>path</em></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>  </td>

  446.   </tr>

  447. </table>

  448. </div><div class="memdoc">

  449. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>

  450.   <table class="params">

  451.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>

  452.   </table>

  453.   </dd>

  454. </dl>

  455. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  456. 

  457. </div>

  458. </div>

  459. <a id="a6bcabab1ded2e71c1272c1baf009c2ab"></a>

  460. <h2 class="memtitle"><span class="permalink"><a href="#a6bcabab1ded2e71c1272c1baf009c2ab">&#9670;&nbsp;</a></span>chvol()</h2>

  461. 

  462. <div class="memitem">

  463. <div class="memproto">

  464. <table class="mlabels">

  465.   <tr>

  466.   <td class="mlabels-left">

  467.       <table class="memname">

  468.         <tr>

  469.           <td class="memname">void ExFatVolume::chvol </td>

  470.           <td>(</td>

  471.           <td class="paramname"></td><td>)</td>

  472.           <td></td>

  473.         </tr>

  474.       </table>

  475.   </td>

  476.   <td class="mlabels-right">

  477. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  478.   </tr>

  479. </table>

  480. </div><div class="memdoc">

  481. <p>Change global working volume to this volume. </p>

  482. 

  483. </div>

  484. </div>

  485. <a id="ac01eb583924286617b0ee8fcf7409ac0"></a>

  486. <h2 class="memtitle"><span class="permalink"><a href="#ac01eb583924286617b0ee8fcf7409ac0">&#9670;&nbsp;</a></span>clusterCount()</h2>

  487. 

  488. <div class="memitem">

  489. <div class="memproto">

  490. <table class="mlabels">

  491.   <tr>

  492.   <td class="mlabels-left">

  493.       <table class="memname">

  494.         <tr>

  495.           <td class="memname">uint32_t ExFatPartition::clusterCount </td>

  496.           <td>(</td>

  497.           <td class="paramname"></td><td>)</td>

  498.           <td></td>

  499.         </tr>

  500.       </table>

  501.   </td>

  502.   <td class="mlabels-right">

  503. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  504.   </tr>

  505. </table>

  506. </div><div class="memdoc">

  507. <dl class="section return"><dt>Returns</dt><dd>the cluster count for the partition. </dd></dl>

  508. 

  509. </div>

  510. </div>

  511. <a id="a58b96587b787f4164eb719913dfbaaf5"></a>

  512. <h2 class="memtitle"><span class="permalink"><a href="#a58b96587b787f4164eb719913dfbaaf5">&#9670;&nbsp;</a></span>clusterHeapStartSector()</h2>

  513. 

  514. <div class="memitem">

  515. <div class="memproto">

  516. <table class="mlabels">

  517.   <tr>

  518.   <td class="mlabels-left">

  519.       <table class="memname">

  520.         <tr>

  521.           <td class="memname">uint32_t ExFatPartition::clusterHeapStartSector </td>

  522.           <td>(</td>

  523.           <td class="paramname"></td><td>)</td>

  524.           <td></td>

  525.         </tr>

  526.       </table>

  527.   </td>

  528.   <td class="mlabels-right">

  529. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  530.   </tr>

  531. </table>

  532. </div><div class="memdoc">

  533. <dl class="section return"><dt>Returns</dt><dd>the cluster heap start sector. </dd></dl>

  534. 

  535. </div>

  536. </div>

  537. <a id="a5b2a874ef0306425bf54c18454771b45"></a>

  538. <h2 class="memtitle"><span class="permalink"><a href="#a5b2a874ef0306425bf54c18454771b45">&#9670;&nbsp;</a></span>cwv()</h2>

  539. 

  540. <div class="memitem">

  541. <div class="memproto">

  542. <table class="mlabels">

  543.   <tr>

  544.   <td class="mlabels-left">

  545.       <table class="memname">

  546.         <tr>

  547.           <td class="memname">static <a class="el" href="class_ex_fat_volume.html">ExFatVolume</a>* ExFatVolume::cwv </td>

  548.           <td>(</td>

  549.           <td class="paramname"></td><td>)</td>

  550.           <td></td>

  551.         </tr>

  552.       </table>

  553.   </td>

  554.   <td class="mlabels-right">

  555. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  556.   </tr>

  557. </table>

  558. </div><div class="memdoc">

  559. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>

  560. 

  561. </div>

  562. </div>

  563. <a id="a7fdcdffb720a1cca5cfa73f4cfa281df"></a>

  564. <h2 class="memtitle"><span class="permalink"><a href="#a7fdcdffb720a1cca5cfa73f4cfa281df">&#9670;&nbsp;</a></span>exists() <span class="overload">[1/2]</span></h2>

  565. 

  566. <div class="memitem">

  567. <div class="memproto">

  568. <table class="mlabels">

  569.   <tr>

  570.   <td class="mlabels-left">

  571.       <table class="memname">

  572.         <tr>

  573.           <td class="memname">bool ExFatVolume::exists </td>

  574.           <td>(</td>

  575.           <td class="paramtype">const ExChar_t *&#160;</td>

  576.           <td class="paramname"><em>path</em></td><td>)</td>

  577.           <td></td>

  578.         </tr>

  579.       </table>

  580.   </td>

  581.   <td class="mlabels-right">

  582. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  583.   </tr>

  584. </table>

  585. </div><div class="memdoc">

  586. <p>Test for the existence of a file.</p>

  587. <dl class="params"><dt>Parameters</dt><dd>

  588.   <table class="params">

  589.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>

  590.   </table>

  591.   </dd>

  592. </dl>

  593. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>

  594. 

  595. </div>

  596. </div>

  597. <a id="af705d3a2434d64efebaa5b3615131dc5"></a>

  598. <h2 class="memtitle"><span class="permalink"><a href="#af705d3a2434d64efebaa5b3615131dc5">&#9670;&nbsp;</a></span>exists() <span class="overload">[2/2]</span></h2>

  599. 

  600. <div class="memitem">

  601. <div class="memproto">

  602. <table class="mlabels">

  603.   <tr>

  604.   <td class="mlabels-left">

  605.       <table class="memname">

  606.         <tr>

  607.           <td class="memname">bool ExFatVolume::exists </td>

  608.           <td>(</td>

  609.           <td class="paramtype">const String &amp;&#160;</td>

  610.           <td class="paramname"><em>path</em></td><td>)</td>

  611.           <td></td>

  612.         </tr>

  613.       </table>

  614.   </td>

  615.   <td class="mlabels-right">

  616. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  617.   </tr>

  618. </table>

  619. </div><div class="memdoc">

  620. <p>Test for the existence of a file in a directory</p>

  621. <dl class="params"><dt>Parameters</dt><dd>

  622.   <table class="params">

  623.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>

  624.   </table>

  625.   </dd>

  626. </dl>

  627. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>

  628. 

  629. </div>

  630. </div>

  631. <a id="aa7d1ae15168896ccc2648b4c383b34eb"></a>

  632. <h2 class="memtitle"><span class="permalink"><a href="#aa7d1ae15168896ccc2648b4c383b34eb">&#9670;&nbsp;</a></span>fatLength()</h2>

  633. 

  634. <div class="memitem">

  635. <div class="memproto">

  636. <table class="mlabels">

  637.   <tr>

  638.   <td class="mlabels-left">

  639.       <table class="memname">

  640.         <tr>

  641.           <td class="memname">uint32_t ExFatPartition::fatLength </td>

  642.           <td>(</td>

  643.           <td class="paramname"></td><td>)</td>

  644.           <td></td>

  645.         </tr>

  646.       </table>

  647.   </td>

  648.   <td class="mlabels-right">

  649. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  650.   </tr>

  651. </table>

  652. </div><div class="memdoc">

  653. <dl class="section return"><dt>Returns</dt><dd>the FAT length in sectors </dd></dl>

  654. 

  655. </div>

  656. </div>

  657. <a id="a9eff9e65b511ec06b62856bff8ed29eb"></a>

  658. <h2 class="memtitle"><span class="permalink"><a href="#a9eff9e65b511ec06b62856bff8ed29eb">&#9670;&nbsp;</a></span>fatStartSector()</h2>

  659. 

  660. <div class="memitem">

  661. <div class="memproto">

  662. <table class="mlabels">

  663.   <tr>

  664.   <td class="mlabels-left">

  665.       <table class="memname">

  666.         <tr>

  667.           <td class="memname">uint32_t ExFatPartition::fatStartSector </td>

  668.           <td>(</td>

  669.           <td class="paramname"></td><td>)</td>

  670.           <td></td>

  671.         </tr>

  672.       </table>

  673.   </td>

  674.   <td class="mlabels-right">

  675. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  676.   </tr>

  677. </table>

  678. </div><div class="memdoc">

  679. <dl class="section return"><dt>Returns</dt><dd>the FAT start sector number. </dd></dl>

  680. 

  681. </div>

  682. </div>

  683. <a id="a3e63d87b4ef985f92c1793d269274f44"></a>

  684. <h2 class="memtitle"><span class="permalink"><a href="#a3e63d87b4ef985f92c1793d269274f44">&#9670;&nbsp;</a></span>fatType()</h2>

  685. 

  686. <div class="memitem">

  687. <div class="memproto">

  688. <table class="mlabels">

  689.   <tr>

  690.   <td class="mlabels-left">

  691.       <table class="memname">

  692.         <tr>

  693.           <td class="memname">uint8_t ExFatPartition::fatType </td>

  694.           <td>(</td>

  695.           <td class="paramname"></td><td>)</td>

  696.           <td> const</td>

  697.         </tr>

  698.       </table>

  699.   </td>

  700.   <td class="mlabels-right">

  701. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  702.   </tr>

  703. </table>

  704. </div><div class="memdoc">

  705. <dl class="section return"><dt>Returns</dt><dd>Type FAT_TYPE_EXFAT for exFAT partition or zero for error. </dd></dl>

  706. 

  707. </div>

  708. </div>

  709. <a id="ae6d4414d6440b79b6314cd1edbaa35b0"></a>

  710. <h2 class="memtitle"><span class="permalink"><a href="#ae6d4414d6440b79b6314cd1edbaa35b0">&#9670;&nbsp;</a></span>freeClusterCount()</h2>

  711. 

  712. <div class="memitem">

  713. <div class="memproto">

  714. <table class="mlabels">

  715.   <tr>

  716.   <td class="mlabels-left">

  717.       <table class="memname">

  718.         <tr>

  719.           <td class="memname">uint32_t ExFatPartition::freeClusterCount </td>

  720.           <td>(</td>

  721.           <td class="paramname"></td><td>)</td>

  722.           <td></td>

  723.         </tr>

  724.       </table>

  725.   </td>

  726.   <td class="mlabels-right">

  727. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  728.   </tr>

  729. </table>

  730. </div><div class="memdoc">

  731. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>

  732. 

  733. </div>

  734. </div>

  735. <a id="adb1d277492dccba09031e2064f4fa66f"></a>

  736. <h2 class="memtitle"><span class="permalink"><a href="#adb1d277492dccba09031e2064f4fa66f">&#9670;&nbsp;</a></span>init()</h2>

  737. 

  738. <div class="memitem">

  739. <div class="memproto">

  740. <table class="mlabels">

  741.   <tr>

  742.   <td class="mlabels-left">

  743.       <table class="memname">

  744.         <tr>

  745.           <td class="memname">bool ExFatPartition::init </td>

  746.           <td>(</td>

  747.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>

  748.           <td class="paramname"><em>dev</em>, </td>

  749.         </tr>

  750.         <tr>

  751.           <td class="paramkey"></td>

  752.           <td></td>

  753.           <td class="paramtype">uint8_t&#160;</td>

  754.           <td class="paramname"><em>part</em>&#160;</td>

  755.         </tr>

  756.         <tr>

  757.           <td></td>

  758.           <td>)</td>

  759.           <td></td><td></td>

  760.         </tr>

  761.       </table>

  762.   </td>

  763.   <td class="mlabels-right">

  764. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  765.   </tr>

  766. </table>

  767. </div><div class="memdoc">

  768. <p>Initialize a exFAT partition. </p><dl class="params"><dt>Parameters</dt><dd>

  769.   <table class="params">

  770.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The blockDevice for the partition. </td></tr>

  771.     <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in sector zero.</td></tr>

  772.   </table>

  773.   </dd>

  774. </dl>

  775. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  776. 

  777. </div>

  778. </div>

  779. <a id="abe74c248cfe9d57d9a10f651203df9dc"></a>

  780. <h2 class="memtitle"><span class="permalink"><a href="#abe74c248cfe9d57d9a10f651203df9dc">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/5]</span></h2>

  781. 

  782. <div class="memitem">

  783. <div class="memproto">

  784. <table class="mlabels">

  785.   <tr>

  786.   <td class="mlabels-left">

  787.       <table class="memname">

  788.         <tr>

  789.           <td class="memname">bool ExFatVolume::ls </td>

  790.           <td>(</td>

  791.           <td class="paramname"></td><td>)</td>

  792.           <td></td>

  793.         </tr>

  794.       </table>

  795.   </td>

  796.   <td class="mlabels-right">

  797. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  798.   </tr>

  799. </table>

  800. </div><div class="memdoc">

  801. <p>List the directory contents of the root directory to Serial.</p>

  802. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  803. 

  804. </div>

  805. </div>

  806. <a id="ad3a1aa9f64361b81d0cfe5b9f5de3891"></a>

  807. <h2 class="memtitle"><span class="permalink"><a href="#ad3a1aa9f64361b81d0cfe5b9f5de3891">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/5]</span></h2>

  808. 

  809. <div class="memitem">

  810. <div class="memproto">

  811. <table class="mlabels">

  812.   <tr>

  813.   <td class="mlabels-left">

  814.       <table class="memname">

  815.         <tr>

  816.           <td class="memname">bool ExFatVolume::ls </td>

  817.           <td>(</td>

  818.           <td class="paramtype">const ExChar_t *&#160;</td>

  819.           <td class="paramname"><em>path</em>, </td>

  820.         </tr>

  821.         <tr>

  822.           <td class="paramkey"></td>

  823.           <td></td>

  824.           <td class="paramtype">uint8_t&#160;</td>

  825.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  826.         </tr>

  827.         <tr>

  828.           <td></td>

  829.           <td>)</td>

  830.           <td></td><td></td>

  831.         </tr>

  832.       </table>

  833.   </td>

  834.   <td class="mlabels-right">

  835. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  836.   </tr>

  837. </table>

  838. </div><div class="memdoc">

  839. <p>List the directory contents of a directory to Serial.</p>

  840. <dl class="params"><dt>Parameters</dt><dd>

  841.   <table class="params">

  842.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  843.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  844.   </table>

  845.   </dd>

  846. </dl>

  847. <p>LS_DATE - Print file modification date</p>

  848. <p>LS_SIZE - Print file size.</p>

  849. <p>LS_R - Recursive list of subdirectories.</p>

  850. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  851. 

  852. </div>

  853. </div>

  854. <a id="aad2de66514174edb37b0fe7e44b33abf"></a>

  855. <h2 class="memtitle"><span class="permalink"><a href="#aad2de66514174edb37b0fe7e44b33abf">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/5]</span></h2>

  856. 

  857. <div class="memitem">

  858. <div class="memproto">

  859. <table class="mlabels">

  860.   <tr>

  861.   <td class="mlabels-left">

  862.       <table class="memname">

  863.         <tr>

  864.           <td class="memname">bool ExFatVolume::ls </td>

  865.           <td>(</td>

  866.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  867.           <td class="paramname"><em>pr</em>, </td>

  868.         </tr>

  869.         <tr>

  870.           <td class="paramkey"></td>

  871.           <td></td>

  872.           <td class="paramtype">const ExChar_t *&#160;</td>

  873.           <td class="paramname"><em>path</em>, </td>

  874.         </tr>

  875.         <tr>

  876.           <td class="paramkey"></td>

  877.           <td></td>

  878.           <td class="paramtype">uint8_t&#160;</td>

  879.           <td class="paramname"><em>flags</em>&#160;</td>

  880.         </tr>

  881.         <tr>

  882.           <td></td>

  883.           <td>)</td>

  884.           <td></td><td></td>

  885.         </tr>

  886.       </table>

  887.   </td>

  888.   <td class="mlabels-right">

  889. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  890.   </tr>

  891. </table>

  892. </div><div class="memdoc">

  893. <p>List the contents of a directory.</p>

  894. <dl class="params"><dt>Parameters</dt><dd>

  895.   <table class="params">

  896.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>

  897.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  898.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  899.   </table>

  900.   </dd>

  901. </dl>

  902. <p>LS_DATE - Print file modification date</p>

  903. <p>LS_SIZE - Print file size.</p>

  904. <p>LS_R - Recursive list of subdirectories.</p>

  905. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  906. 

  907. </div>

  908. </div>

  909. <a id="abe1e8cad0a5922984b28edfd987bc856"></a>

  910. <h2 class="memtitle"><span class="permalink"><a href="#abe1e8cad0a5922984b28edfd987bc856">&#9670;&nbsp;</a></span>ls() <span class="overload">[4/5]</span></h2>

  911. 

  912. <div class="memitem">

  913. <div class="memproto">

  914. <table class="mlabels">

  915.   <tr>

  916.   <td class="mlabels-left">

  917.       <table class="memname">

  918.         <tr>

  919.           <td class="memname">bool ExFatVolume::ls </td>

  920.           <td>(</td>

  921.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  922.           <td class="paramname"><em>pr</em>, </td>

  923.         </tr>

  924.         <tr>

  925.           <td class="paramkey"></td>

  926.           <td></td>

  927.           <td class="paramtype">uint8_t&#160;</td>

  928.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  929.         </tr>

  930.         <tr>

  931.           <td></td>

  932.           <td>)</td>

  933.           <td></td><td></td>

  934.         </tr>

  935.       </table>

  936.   </td>

  937.   <td class="mlabels-right">

  938. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  939.   </tr>

  940. </table>

  941. </div><div class="memdoc">

  942. <p>List the directory contents of the root directory.</p>

  943. <dl class="params"><dt>Parameters</dt><dd>

  944.   <table class="params">

  945.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>

  946.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  947.   </table>

  948.   </dd>

  949. </dl>

  950. <p>LS_DATE - Print file modification date</p>

  951. <p>LS_SIZE - Print file size.</p>

  952. <p>LS_R - Recursive list of subdirectories.</p>

  953. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  954. 

  955. </div>

  956. </div>

  957. <a id="ae883a72fbfe40f9a6fe6c6bf349d5c1f"></a>

  958. <h2 class="memtitle"><span class="permalink"><a href="#ae883a72fbfe40f9a6fe6c6bf349d5c1f">&#9670;&nbsp;</a></span>ls() <span class="overload">[5/5]</span></h2>

  959. 

  960. <div class="memitem">

  961. <div class="memproto">

  962. <table class="mlabels">

  963.   <tr>

  964.   <td class="mlabels-left">

  965.       <table class="memname">

  966.         <tr>

  967.           <td class="memname">bool ExFatVolume::ls </td>

  968.           <td>(</td>

  969.           <td class="paramtype">uint8_t&#160;</td>

  970.           <td class="paramname"><em>flags</em></td><td>)</td>

  971.           <td></td>

  972.         </tr>

  973.       </table>

  974.   </td>

  975.   <td class="mlabels-right">

  976. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  977.   </tr>

  978. </table>

  979. </div><div class="memdoc">

  980. <p>List the directory contents of the volume root to Serial.</p>

  981. <dl class="params"><dt>Parameters</dt><dd>

  982.   <table class="params">

  983.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  984.   </table>

  985.   </dd>

  986. </dl>

  987. <p>LS_DATE - Print file modification date</p>

  988. <p>LS_SIZE - Print file size.</p>

  989. <p>LS_R - Recursive list of subdirectories.</p>

  990. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  991. 

  992. </div>

  993. </div>

  994. <a id="a407b93b16554b26ff52f7b762a9217aa"></a>

  995. <h2 class="memtitle"><span class="permalink"><a href="#a407b93b16554b26ff52f7b762a9217aa">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[1/2]</span></h2>

  996. 

  997. <div class="memitem">

  998. <div class="memproto">

  999. <table class="mlabels">

  1000.   <tr>

  1001.   <td class="mlabels-left">

  1002.       <table class="memname">

  1003.         <tr>

  1004.           <td class="memname">bool ExFatVolume::mkdir </td>

  1005.           <td>(</td>

  1006.           <td class="paramtype">const ExChar_t *&#160;</td>

  1007.           <td class="paramname"><em>path</em>, </td>

  1008.         </tr>

  1009.         <tr>

  1010.           <td class="paramkey"></td>

  1011.           <td></td>

  1012.           <td class="paramtype">bool&#160;</td>

  1013.           <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>

  1014.         </tr>

  1015.         <tr>

  1016.           <td></td>

  1017.           <td>)</td>

  1018.           <td></td><td></td>

  1019.         </tr>

  1020.       </table>

  1021.   </td>

  1022.   <td class="mlabels-right">

  1023. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1024.   </tr>

  1025. </table>

  1026. </div><div class="memdoc">

  1027. <p>Make a subdirectory in the volume root directory.</p>

  1028. <dl class="params"><dt>Parameters</dt><dd>

  1029.   <table class="params">

  1030.     <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>

  1031.     <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>

  1032.   </table>

  1033.   </dd>

  1034. </dl>

  1035. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1036. 

  1037. </div>

  1038. </div>

  1039. <a id="a0f4cf7e2853225380574724314327597"></a>

  1040. <h2 class="memtitle"><span class="permalink"><a href="#a0f4cf7e2853225380574724314327597">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[2/2]</span></h2>

  1041. 

  1042. <div class="memitem">

  1043. <div class="memproto">

  1044. <table class="mlabels">

  1045.   <tr>

  1046.   <td class="mlabels-left">

  1047.       <table class="memname">

  1048.         <tr>

  1049.           <td class="memname">bool ExFatVolume::mkdir </td>

  1050.           <td>(</td>

  1051.           <td class="paramtype">const String &amp;&#160;</td>

  1052.           <td class="paramname"><em>path</em>, </td>

  1053.         </tr>

  1054.         <tr>

  1055.           <td class="paramkey"></td>

  1056.           <td></td>

  1057.           <td class="paramtype">bool&#160;</td>

  1058.           <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>

  1059.         </tr>

  1060.         <tr>

  1061.           <td></td>

  1062.           <td>)</td>

  1063.           <td></td><td></td>

  1064.         </tr>

  1065.       </table>

  1066.   </td>

  1067.   <td class="mlabels-right">

  1068. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1069.   </tr>

  1070. </table>

  1071. </div><div class="memdoc">

  1072. <p>Make a subdirectory in the volume root directory.</p>

  1073. <dl class="params"><dt>Parameters</dt><dd>

  1074.   <table class="params">

  1075.     <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>

  1076.     <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>

  1077.   </table>

  1078.   </dd>

  1079. </dl>

  1080. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1081. 

  1082. </div>

  1083. </div>

  1084. <a id="a0807cfcef46ef74cfe238badb83f3dda"></a>

  1085. <h2 class="memtitle"><span class="permalink"><a href="#a0807cfcef46ef74cfe238badb83f3dda">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>

  1086. 

  1087. <div class="memitem">

  1088. <div class="memproto">

  1089. <table class="mlabels">

  1090.   <tr>

  1091.   <td class="mlabels-left">

  1092.       <table class="memname">

  1093.         <tr>

  1094.           <td class="memname"><a class="el" href="class_ex_file.html">ExFile</a> ExFatVolume::open </td>

  1095.           <td>(</td>

  1096.           <td class="paramtype">const ExChar_t *&#160;</td>

  1097.           <td class="paramname"><em>path</em>, </td>

  1098.         </tr>

  1099.         <tr>

  1100.           <td class="paramkey"></td>

  1101.           <td></td>

  1102.           <td class="paramtype">oflag_t&#160;</td>

  1103.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1104.         </tr>

  1105.         <tr>

  1106.           <td></td>

  1107.           <td>)</td>

  1108.           <td></td><td></td>

  1109.         </tr>

  1110.       </table>

  1111.   </td>

  1112.   <td class="mlabels-right">

  1113. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1114.   </tr>

  1115. </table>

  1116. </div><div class="memdoc">

  1117. <p>open a file</p>

  1118. <dl class="params"><dt>Parameters</dt><dd>

  1119.   <table class="params">

  1120.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>

  1121.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  1122.   </table>

  1123.   </dd>

  1124. </dl>

  1125. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_ex_file.html" title="exFAT file with Arduino Stream.">ExFile</a> object. </dd></dl>

  1126. 

  1127. </div>

  1128. </div>

  1129. <a id="adce2c8ab2f73f56614b08fac42cabaea"></a>

  1130. <h2 class="memtitle"><span class="permalink"><a href="#adce2c8ab2f73f56614b08fac42cabaea">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>

  1131. 

  1132. <div class="memitem">

  1133. <div class="memproto">

  1134. <table class="mlabels">

  1135.   <tr>

  1136.   <td class="mlabels-left">

  1137.       <table class="memname">

  1138.         <tr>

  1139.           <td class="memname"><a class="el" href="class_ex_file.html">ExFile</a> ExFatVolume::open </td>

  1140.           <td>(</td>

  1141.           <td class="paramtype">const String &amp;&#160;</td>

  1142.           <td class="paramname"><em>path</em>, </td>

  1143.         </tr>

  1144.         <tr>

  1145.           <td class="paramkey"></td>

  1146.           <td></td>

  1147.           <td class="paramtype">oflag_t&#160;</td>

  1148.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1149.         </tr>

  1150.         <tr>

  1151.           <td></td>

  1152.           <td>)</td>

  1153.           <td></td><td></td>

  1154.         </tr>

  1155.       </table>

  1156.   </td>

  1157.   <td class="mlabels-right">

  1158. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1159.   </tr>

  1160. </table>

  1161. </div><div class="memdoc">

  1162. <p>open a file</p>

  1163. <dl class="params"><dt>Parameters</dt><dd>

  1164.   <table class="params">

  1165.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>

  1166.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open oflag flags. </td></tr>

  1167.   </table>

  1168.   </dd>

  1169. </dl>

  1170. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_ex_file.html" title="exFAT file with Arduino Stream.">ExFile</a> object. </dd></dl>

  1171. 

  1172. </div>

  1173. </div>

  1174. <a id="a58061d05f5dc5a52706cdd61a1a86e80"></a>

  1175. <h2 class="memtitle"><span class="permalink"><a href="#a58061d05f5dc5a52706cdd61a1a86e80">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  1176. 

  1177. <div class="memitem">

  1178. <div class="memproto">

  1179. <table class="mlabels">

  1180.   <tr>

  1181.   <td class="mlabels-left">

  1182.       <table class="memname">

  1183.         <tr>

  1184.           <td class="memname">bool ExFatVolume::remove </td>

  1185.           <td>(</td>

  1186.           <td class="paramtype">const ExChar_t *&#160;</td>

  1187.           <td class="paramname"><em>path</em></td><td>)</td>

  1188.           <td></td>

  1189.         </tr>

  1190.       </table>

  1191.   </td>

  1192.   <td class="mlabels-right">

  1193. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1194.   </tr>

  1195. </table>

  1196. </div><div class="memdoc">

  1197. <p>Remove a file from the volume root directory.</p>

  1198. <dl class="params"><dt>Parameters</dt><dd>

  1199.   <table class="params">

  1200.     <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>

  1201.   </table>

  1202.   </dd>

  1203. </dl>

  1204. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1205. 

  1206. </div>

  1207. </div>

  1208. <a id="adc22ad4ce966654944b18d31fc6ac5ee"></a>

  1209. <h2 class="memtitle"><span class="permalink"><a href="#adc22ad4ce966654944b18d31fc6ac5ee">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  1210. 

  1211. <div class="memitem">

  1212. <div class="memproto">

  1213. <table class="mlabels">

  1214.   <tr>

  1215.   <td class="mlabels-left">

  1216.       <table class="memname">

  1217.         <tr>

  1218.           <td class="memname">bool ExFatVolume::remove </td>

  1219.           <td>(</td>

  1220.           <td class="paramtype">const String &amp;&#160;</td>

  1221.           <td class="paramname"><em>path</em></td><td>)</td>

  1222.           <td></td>

  1223.         </tr>

  1224.       </table>

  1225.   </td>

  1226.   <td class="mlabels-right">

  1227. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1228.   </tr>

  1229. </table>

  1230. </div><div class="memdoc">

  1231. <p>Remove a file from the volume root directory.</p>

  1232. <dl class="params"><dt>Parameters</dt><dd>

  1233.   <table class="params">

  1234.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>

  1235.   </table>

  1236.   </dd>

  1237. </dl>

  1238. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1239. 

  1240. </div>

  1241. </div>

  1242. <a id="a8dcd1b108167803a24f7314f5fce6bc4"></a>

  1243. <h2 class="memtitle"><span class="permalink"><a href="#a8dcd1b108167803a24f7314f5fce6bc4">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  1244. 

  1245. <div class="memitem">

  1246. <div class="memproto">

  1247. <table class="mlabels">

  1248.   <tr>

  1249.   <td class="mlabels-left">

  1250.       <table class="memname">

  1251.         <tr>

  1252.           <td class="memname">bool ExFatVolume::rename </td>

  1253.           <td>(</td>

  1254.           <td class="paramtype">const ExChar_t *&#160;</td>

  1255.           <td class="paramname"><em>oldPath</em>, </td>

  1256.         </tr>

  1257.         <tr>

  1258.           <td class="paramkey"></td>

  1259.           <td></td>

  1260.           <td class="paramtype">const ExChar_t *&#160;</td>

  1261.           <td class="paramname"><em>newPath</em>&#160;</td>

  1262.         </tr>

  1263.         <tr>

  1264.           <td></td>

  1265.           <td>)</td>

  1266.           <td></td><td></td>

  1267.         </tr>

  1268.       </table>

  1269.   </td>

  1270.   <td class="mlabels-right">

  1271. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1272.   </tr>

  1273. </table>

  1274. </div><div class="memdoc">

  1275. <p>Rename a file or subdirectory.</p>

  1276. <dl class="params"><dt>Parameters</dt><dd>

  1277.   <table class="params">

  1278.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  1279.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  1280.   </table>

  1281.   </dd>

  1282. </dl>

  1283. <p>The <em>newPath</em> object must not exist before the rename call.</p>

  1284. <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_ex_fat_volume.html#a8dcd1b108167803a24f7314f5fce6bc4">rename()</a> call.</p>

  1285. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1286. 

  1287. </div>

  1288. </div>

  1289. <a id="a1396c06f6c5e138889125d2f62cdbdcb"></a>

  1290. <h2 class="memtitle"><span class="permalink"><a href="#a1396c06f6c5e138889125d2f62cdbdcb">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  1291. 

  1292. <div class="memitem">

  1293. <div class="memproto">

  1294. <table class="mlabels">

  1295.   <tr>

  1296.   <td class="mlabels-left">

  1297.       <table class="memname">

  1298.         <tr>

  1299.           <td class="memname">bool ExFatVolume::rename </td>

  1300.           <td>(</td>

  1301.           <td class="paramtype">const String &amp;&#160;</td>

  1302.           <td class="paramname"><em>oldPath</em>, </td>

  1303.         </tr>

  1304.         <tr>

  1305.           <td class="paramkey"></td>

  1306.           <td></td>

  1307.           <td class="paramtype">const String &amp;&#160;</td>

  1308.           <td class="paramname"><em>newPath</em>&#160;</td>

  1309.         </tr>

  1310.         <tr>

  1311.           <td></td>

  1312.           <td>)</td>

  1313.           <td></td><td></td>

  1314.         </tr>

  1315.       </table>

  1316.   </td>

  1317.   <td class="mlabels-right">

  1318. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1319.   </tr>

  1320. </table>

  1321. </div><div class="memdoc">

  1322. <p>Rename a file or subdirectory.</p>

  1323. <dl class="params"><dt>Parameters</dt><dd>

  1324.   <table class="params">

  1325.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  1326.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  1327.   </table>

  1328.   </dd>

  1329. </dl>

  1330. <p>The <em>newPath</em> object must not exist before the rename call.</p>

  1331. <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_ex_fat_volume.html#a8dcd1b108167803a24f7314f5fce6bc4">rename()</a> call.</p>

  1332. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1333. 

  1334. </div>

  1335. </div>

  1336. <a id="ab9e3e7d9538c905ca60b834e244943ee"></a>

  1337. <h2 class="memtitle"><span class="permalink"><a href="#ab9e3e7d9538c905ca60b834e244943ee">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[1/2]</span></h2>

  1338. 

  1339. <div class="memitem">

  1340. <div class="memproto">

  1341. <table class="mlabels">

  1342.   <tr>

  1343.   <td class="mlabels-left">

  1344.       <table class="memname">

  1345.         <tr>

  1346.           <td class="memname">bool ExFatVolume::rmdir </td>

  1347.           <td>(</td>

  1348.           <td class="paramtype">const ExChar_t *&#160;</td>

  1349.           <td class="paramname"><em>path</em></td><td>)</td>

  1350.           <td></td>

  1351.         </tr>

  1352.       </table>

  1353.   </td>

  1354.   <td class="mlabels-right">

  1355. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1356.   </tr>

  1357. </table>

  1358. </div><div class="memdoc">

  1359. <p>Remove a subdirectory from the volume's working directory.</p>

  1360. <dl class="params"><dt>Parameters</dt><dd>

  1361.   <table class="params">

  1362.     <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>

  1363.   </table>

  1364.   </dd>

  1365. </dl>

  1366. <p>The subdirectory file will be removed only if it is empty.</p>

  1367. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1368. 

  1369. </div>

  1370. </div>

  1371. <a id="af0adfad817e085d676479fefbb343197"></a>

  1372. <h2 class="memtitle"><span class="permalink"><a href="#af0adfad817e085d676479fefbb343197">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[2/2]</span></h2>

  1373. 

  1374. <div class="memitem">

  1375. <div class="memproto">

  1376. <table class="mlabels">

  1377.   <tr>

  1378.   <td class="mlabels-left">

  1379.       <table class="memname">

  1380.         <tr>

  1381.           <td class="memname">bool ExFatVolume::rmdir </td>

  1382.           <td>(</td>

  1383.           <td class="paramtype">const String &amp;&#160;</td>

  1384.           <td class="paramname"><em>path</em></td><td>)</td>

  1385.           <td></td>

  1386.         </tr>

  1387.       </table>

  1388.   </td>

  1389.   <td class="mlabels-right">

  1390. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1391.   </tr>

  1392. </table>

  1393. </div><div class="memdoc">

  1394. <p>Remove a subdirectory from the volume's working directory.</p>

  1395. <dl class="params"><dt>Parameters</dt><dd>

  1396.   <table class="params">

  1397.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>

  1398.   </table>

  1399.   </dd>

  1400. </dl>

  1401. <p>The subdirectory file will be removed only if it is empty.</p>

  1402. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1403. 

  1404. </div>

  1405. </div>

  1406. <a id="a658c250984be29febf8f4d2a2ec312a1"></a>

  1407. <h2 class="memtitle"><span class="permalink"><a href="#a658c250984be29febf8f4d2a2ec312a1">&#9670;&nbsp;</a></span>rootDirectoryCluster()</h2>

  1408. 

  1409. <div class="memitem">

  1410. <div class="memproto">

  1411. <table class="mlabels">

  1412.   <tr>

  1413.   <td class="mlabels-left">

  1414.       <table class="memname">

  1415.         <tr>

  1416.           <td class="memname">uint32_t ExFatPartition::rootDirectoryCluster </td>

  1417.           <td>(</td>

  1418.           <td class="paramname"></td><td>)</td>

  1419.           <td></td>

  1420.         </tr>

  1421.       </table>

  1422.   </td>

  1423.   <td class="mlabels-right">

  1424. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1425.   </tr>

  1426. </table>

  1427. </div><div class="memdoc">

  1428. <dl class="section return"><dt>Returns</dt><dd>the root directory start cluster number. </dd></dl>

  1429. 

  1430. </div>

  1431. </div>

  1432. <a id="a9412bd687edc99266c88f8aa87f01c51"></a>

  1433. <h2 class="memtitle"><span class="permalink"><a href="#a9412bd687edc99266c88f8aa87f01c51">&#9670;&nbsp;</a></span>rootLength()</h2>

  1434. 

  1435. <div class="memitem">

  1436. <div class="memproto">

  1437. <table class="mlabels">

  1438.   <tr>

  1439.   <td class="mlabels-left">

  1440.       <table class="memname">

  1441.         <tr>

  1442.           <td class="memname">uint32_t ExFatPartition::rootLength </td>

  1443.           <td>(</td>

  1444.           <td class="paramname"></td><td>)</td>

  1445.           <td></td>

  1446.         </tr>

  1447.       </table>

  1448.   </td>

  1449.   <td class="mlabels-right">

  1450. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1451.   </tr>

  1452. </table>

  1453. </div><div class="memdoc">

  1454. <dl class="section return"><dt>Returns</dt><dd>the root directory length. </dd></dl>

  1455. 

  1456. </div>

  1457. </div>

  1458. <a id="aaa7306ac8ff29f50ec4d919ccaff10d7"></a>

  1459. <h2 class="memtitle"><span class="permalink"><a href="#aaa7306ac8ff29f50ec4d919ccaff10d7">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>

  1460. 

  1461. <div class="memitem">

  1462. <div class="memproto">

  1463. <table class="mlabels">

  1464.   <tr>

  1465.   <td class="mlabels-left">

  1466.       <table class="memname">

  1467.         <tr>

  1468.           <td class="memname">uint32_t ExFatPartition::sectorsPerCluster </td>

  1469.           <td>(</td>

  1470.           <td class="paramname"></td><td>)</td>

  1471.           <td></td>

  1472.         </tr>

  1473.       </table>

  1474.   </td>

  1475.   <td class="mlabels-right">

  1476. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1477.   </tr>

  1478. </table>

  1479. </div><div class="memdoc">

  1480. <dl class="section return"><dt>Returns</dt><dd>the number of sectors in a cluster. </dd></dl>

  1481. 

  1482. </div>

  1483. </div>

  1484. <a id="ab1624bf02690ee06365207cb8f1d48ac"></a>

  1485. <h2 class="memtitle"><span class="permalink"><a href="#ab1624bf02690ee06365207cb8f1d48ac">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>

  1486. 

  1487. <div class="memitem">

  1488. <div class="memproto">

  1489. <table class="mlabels">

  1490.   <tr>

  1491.   <td class="mlabels-left">

  1492.       <table class="memname">

  1493.         <tr>

  1494.           <td class="memname">uint8_t ExFatPartition::sectorsPerClusterShift </td>

  1495.           <td>(</td>

  1496.           <td class="paramname"></td><td>)</td>

  1497.           <td></td>

  1498.         </tr>

  1499.       </table>

  1500.   </td>

  1501.   <td class="mlabels-right">

  1502. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1503.   </tr>

  1504. </table>

  1505. </div><div class="memdoc">

  1506. <dl class="section return"><dt>Returns</dt><dd>the power of two for sectors per cluster. </dd></dl>

  1507. 

  1508. </div>

  1509. </div>

  1510. <a id="ae5cbcdd7907a882b4686cb3ba7e85bcc"></a>

  1511. <h2 class="memtitle"><span class="permalink"><a href="#ae5cbcdd7907a882b4686cb3ba7e85bcc">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  1512. 

  1513. <div class="memitem">

  1514. <div class="memproto">

  1515. <table class="mlabels">

  1516.   <tr>

  1517.   <td class="mlabels-left">

  1518.       <table class="memname">

  1519.         <tr>

  1520.           <td class="memname">bool ExFatVolume::truncate </td>

  1521.           <td>(</td>

  1522.           <td class="paramtype">const ExChar_t *&#160;</td>

  1523.           <td class="paramname"><em>path</em>, </td>

  1524.         </tr>

  1525.         <tr>

  1526.           <td class="paramkey"></td>

  1527.           <td></td>

  1528.           <td class="paramtype">uint64_t&#160;</td>

  1529.           <td class="paramname"><em>length</em>&#160;</td>

  1530.         </tr>

  1531.         <tr>

  1532.           <td></td>

  1533.           <td>)</td>

  1534.           <td></td><td></td>

  1535.         </tr>

  1536.       </table>

  1537.   </td>

  1538.   <td class="mlabels-right">

  1539. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1540.   </tr>

  1541. </table>

  1542. </div><div class="memdoc">

  1543. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>

  1544. <dl class="params"><dt>Parameters</dt><dd>

  1545.   <table class="params">

  1546.     <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>

  1547.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  1548.   </table>

  1549.   </dd>

  1550. </dl>

  1551. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1552. 

  1553. </div>

  1554. </div>

  1555. <a id="ae6d409b7f24593dca7aae70513e18b70"></a>

  1556. <h2 class="memtitle"><span class="permalink"><a href="#ae6d409b7f24593dca7aae70513e18b70">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  1557. 

  1558. <div class="memitem">

  1559. <div class="memproto">

  1560. <table class="mlabels">

  1561.   <tr>

  1562.   <td class="mlabels-left">

  1563.       <table class="memname">

  1564.         <tr>

  1565.           <td class="memname">bool ExFatVolume::truncate </td>

  1566.           <td>(</td>

  1567.           <td class="paramtype">const String &amp;&#160;</td>

  1568.           <td class="paramname"><em>path</em>, </td>

  1569.         </tr>

  1570.         <tr>

  1571.           <td class="paramkey"></td>

  1572.           <td></td>

  1573.           <td class="paramtype">uint64_t&#160;</td>

  1574.           <td class="paramname"><em>length</em>&#160;</td>

  1575.         </tr>

  1576.         <tr>

  1577.           <td></td>

  1578.           <td>)</td>

  1579.           <td></td><td></td>

  1580.         </tr>

  1581.       </table>

  1582.   </td>

  1583.   <td class="mlabels-right">

  1584. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1585.   </tr>

  1586. </table>

  1587. </div><div class="memdoc">

  1588. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>

  1589. <dl class="params"><dt>Parameters</dt><dd>

  1590.   <table class="params">

  1591.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>

  1592.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  1593.   </table>

  1594.   </dd>

  1595. </dl>

  1596. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1597. 

  1598. </div>

  1599. </div>

  1600. <hr/>The documentation for this class was generated from the following files:<ul>

  1601. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatVolume.h</li>

  1602. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatVolume.cpp</li>

  1603. </ul>

  1604. </div><!-- contents -->

  1605. <!-- start footer part -->

  1606. <hr class="footer"/><address class="footer"><small>

  1607. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  1608. <img class="footer" src="doxygen.png" alt="doxygen"/>

  1609. </a> 1.8.16

  1610. </small></address>

  1611. </body>

  1612. </html>