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_fat_volume.html

1712 lines
73KB
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: FatVolume 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_fat_volume-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

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

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

  71. <div class="contents">

  72. 

  73. <p>Integration class for the FatLib library.  

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

  75. 

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

  77. <div class="dynheader">

  78. Inheritance diagram for FatVolume:</div>

  79. <div class="dyncontent">

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

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

  82. <area shape="rect" title="Integration class for the FatLib library." alt="" coords="40,80,125,107"/>

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

  84. <area shape="rect" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices." alt="" coords="38,5,127,32"/>

  85. <area shape="rect" href="class_sd_fat32.html" title="SD file system class for FAT volumes." alt="" coords="47,229,118,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 FatVolume:</div>

  90. <div class="dyncontent">

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

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

  93. <area shape="rect" title="Integration class for the FatLib library." alt="" coords="7,80,93,107"/>

  94. <area shape="rect" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices." alt="" coords="5,5,95,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:af3a219ea89bbbf310a61115c9a3d221a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af3a219ea89bbbf310a61115c9a3d221a">begin</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, bool setCwv=true, uint8_t part=1)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  124. <tr class="memitem:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a0af1e91a311180119b4a2c85d7e6e87e">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>

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

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

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

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

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

  130. <tr class="memitem:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a56b37c3230818b9ae8e0a25c01a370a3">fatCount</a> ()</td></tr>

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

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

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

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

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

  136. <tr class="memitem:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ac9689f1e11f59acc5f1b21ed9bb71174">freeClusterCount</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  152. <tr class="memitem:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a22923b86de9c797ce5e19f206dd4ce1f">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  168. <tr class="memitem:a6ba99b9711269b5ab6ca091b88e81288"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6ba99b9711269b5ab6ca091b88e81288">rootDirEntryCount</a> () const</td></tr>

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

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

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

  172. <tr class="memitem:a6b970fa2e06de1a826b09e251dc3119b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6b970fa2e06de1a826b09e251dc3119b">sectorMask</a> ()</td></tr>

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

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

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

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

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

  178. <tr class="memitem:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1f5c7599333dbe152a3cdd60623ce6d1">sectorsPerFat</a> () const</td></tr>

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

  180. <tr class="memitem:a86a08bf789e33567418465b9b12751e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a86a08bf789e33567418465b9b12751e2">truncate</a> (const char *path, uint32_t length)</td></tr>

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

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

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

  184. <tr class="memitem:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a916ba7d67711bb62daf12ecd47ca4b8e">volumeSectorCount</a> () const</td></tr>

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

  186. </table><table class="memberdecls">

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

  188. Static Public Member Functions</h2></td></tr>

  189. <tr class="memitem:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06acd4a434456b6a4644ff79a0bf0a24">cwv</a> ()</td></tr>

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

  191. </table>

  192. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  193. <div class="textblock"><p>Integration class for the FatLib library. </p>

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

  195. <a id="af3a219ea89bbbf310a61115c9a3d221a"></a>

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

  197. 

  198. <div class="memitem">

  199. <div class="memproto">

  200. <table class="mlabels">

  201.   <tr>

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

  203.       <table class="memname">

  204.         <tr>

  205.           <td class="memname">bool FatVolume::begin </td>

  206.           <td>(</td>

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

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

  209.         </tr>

  210.         <tr>

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

  212.           <td></td>

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

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

  215.         </tr>

  216.         <tr>

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

  218.           <td></td>

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

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

  221.         </tr>

  222.         <tr>

  223.           <td></td>

  224.           <td>)</td>

  225.           <td></td><td></td>

  226.         </tr>

  227.       </table>

  228.   </td>

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

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

  231.   </tr>

  232. </table>

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

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

  235.   <table class="params">

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

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

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

  239.   </table>

  240.   </dd>

  241. </dl>

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

  243. 

  244. </div>

  245. </div>

  246. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>

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

  248. 

  249. <div class="memitem">

  250. <div class="memproto">

  251. <table class="mlabels">

  252.   <tr>

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

  254.       <table class="memname">

  255.         <tr>

  256.           <td class="memname">uint16_t FatPartition::bytesPerCluster </td>

  257.           <td>(</td>

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

  259.           <td></td>

  260.         </tr>

  261.       </table>

  262.   </td>

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

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

  265.   </tr>

  266. </table>

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

  268. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>

  269. 

  270. </div>

  271. </div>

  272. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>

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

  274. 

  275. <div class="memitem">

  276. <div class="memproto">

  277. <table class="mlabels">

  278.   <tr>

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

  280.       <table class="memname">

  281.         <tr>

  282.           <td class="memname">uint8_t FatPartition::bytesPerClusterShift </td>

  283.           <td>(</td>

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

  285.           <td></td>

  286.         </tr>

  287.       </table>

  288.   </td>

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

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

  291.   </tr>

  292. </table>

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

  294. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>

  295. 

  296. </div>

  297. </div>

  298. <a id="a1eba03c763bab44263735488435731f8"></a>

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

  300. 

  301. <div class="memitem">

  302. <div class="memproto">

  303. <table class="mlabels">

  304.   <tr>

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

  306.       <table class="memname">

  307.         <tr>

  308.           <td class="memname">uint16_t FatPartition::bytesPerSector </td>

  309.           <td>(</td>

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

  311.           <td></td>

  312.         </tr>

  313.       </table>

  314.   </td>

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

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

  317.   </tr>

  318. </table>

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

  320. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>

  321. 

  322. </div>

  323. </div>

  324. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>

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

  326. 

  327. <div class="memitem">

  328. <div class="memproto">

  329. <table class="mlabels">

  330.   <tr>

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

  332.       <table class="memname">

  333.         <tr>

  334.           <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>

  335.           <td>(</td>

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

  337.           <td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

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

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

  343.   </tr>

  344. </table>

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

  346. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>

  347. 

  348. </div>

  349. </div>

  350. <a id="abf74c1e3c714b396e6271aee304c2448"></a>

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

  352. 

  353. <div class="memitem">

  354. <div class="memproto">

  355. <table class="mlabels">

  356.   <tr>

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

  358.       <table class="memname">

  359.         <tr>

  360.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>

  361.           <td>(</td>

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

  363.           <td></td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

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

  373. 

  374. </div>

  375. </div>

  376. <a id="a659d921b3efd52d310a33cba69eff18b"></a>

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

  378. 

  379. <div class="memitem">

  380. <div class="memproto">

  381. <table class="mlabels">

  382.   <tr>

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

  384.       <table class="memname">

  385.         <tr>

  386.           <td class="memname">bool FatVolume::chdir </td>

  387.           <td>(</td>

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

  389.           <td></td>

  390.         </tr>

  391.       </table>

  392.   </td>

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

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

  395.   </tr>

  396. </table>

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

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

  399. 

  400. </div>

  401. </div>

  402. <a id="ac0f6cf6ece2285af777c1fdf5cf8c219"></a>

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

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407.       <table class="memname">

  408.         <tr>

  409.           <td class="memname">bool FatVolume::chdir </td>

  410.           <td>(</td>

  411.           <td class="paramtype">const char *&#160;</td>

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

  413.           <td></td>

  414.         </tr>

  415.       </table>

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

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

  418.   <table class="params">

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

  420.   </table>

  421.   </dd>

  422. </dl>

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

  424. 

  425. </div>

  426. </div>

  427. <a id="ac591520e33ff8ba51e80782a87423872"></a>

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

  429. 

  430. <div class="memitem">

  431. <div class="memproto">

  432. <table class="mlabels">

  433.   <tr>

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

  435.       <table class="memname">

  436.         <tr>

  437.           <td class="memname">bool FatVolume::chdir </td>

  438.           <td>(</td>

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

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

  441.           <td></td>

  442.         </tr>

  443.       </table>

  444.   </td>

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

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

  447.   </tr>

  448. </table>

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

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

  451.   <table class="params">

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

  453.   </table>

  454.   </dd>

  455. </dl>

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

  457. 

  458. </div>

  459. </div>

  460. <a id="a36fbc19755b066068cac7c4ca578b27b"></a>

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

  462. 

  463. <div class="memitem">

  464. <div class="memproto">

  465. <table class="mlabels">

  466.   <tr>

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

  468.       <table class="memname">

  469.         <tr>

  470.           <td class="memname">void FatVolume::chvol </td>

  471.           <td>(</td>

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

  473.           <td></td>

  474.         </tr>

  475.       </table>

  476.   </td>

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

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

  479.   </tr>

  480. </table>

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

  482. <p>Change global current working volume to this volume. </p>

  483. 

  484. </div>

  485. </div>

  486. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>

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

  488. 

  489. <div class="memitem">

  490. <div class="memproto">

  491. <table class="mlabels">

  492.   <tr>

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

  494.       <table class="memname">

  495.         <tr>

  496.           <td class="memname">uint32_t FatPartition::clusterCount </td>

  497.           <td>(</td>

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

  499.           <td> const</td>

  500.         </tr>

  501.       </table>

  502.   </td>

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

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

  505.   </tr>

  506. </table>

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

  508. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>

  509. 

  510. </div>

  511. </div>

  512. <a id="a06acd4a434456b6a4644ff79a0bf0a24"></a>

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

  514. 

  515. <div class="memitem">

  516. <div class="memproto">

  517. <table class="mlabels">

  518.   <tr>

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

  520.       <table class="memname">

  521.         <tr>

  522.           <td class="memname">static <a class="el" href="class_fat_volume.html">FatVolume</a>* FatVolume::cwv </td>

  523.           <td>(</td>

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

  525.           <td></td>

  526.         </tr>

  527.       </table>

  528.   </td>

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

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

  531.   </tr>

  532. </table>

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

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

  535. 

  536. </div>

  537. </div>

  538. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>

  539. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>

  540. 

  541. <div class="memitem">

  542. <div class="memproto">

  543. <table class="mlabels">

  544.   <tr>

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

  546.       <table class="memname">

  547.         <tr>

  548.           <td class="memname">uint32_t FatPartition::dataStartSector </td>

  549.           <td>(</td>

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

  551.           <td> const</td>

  552.         </tr>

  553.       </table>

  554.   </td>

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

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

  557.   </tr>

  558. </table>

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

  560. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>

  561. 

  562. </div>

  563. </div>

  564. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>

  565. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>

  566. 

  567. <div class="memitem">

  568. <div class="memproto">

  569. <table class="mlabels">

  570.   <tr>

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

  572.       <table class="memname">

  573.         <tr>

  574.           <td class="memname">int8_t FatPartition::dbgFat </td>

  575.           <td>(</td>

  576.           <td class="paramtype">uint32_t&#160;</td>

  577.           <td class="paramname"><em>n</em>, </td>

  578.         </tr>

  579.         <tr>

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

  581.           <td></td>

  582.           <td class="paramtype">uint32_t *&#160;</td>

  583.           <td class="paramname"><em>v</em>&#160;</td>

  584.         </tr>

  585.         <tr>

  586.           <td></td>

  587.           <td>)</td>

  588.           <td></td><td></td>

  589.         </tr>

  590.       </table>

  591.   </td>

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

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

  594.   </tr>

  595. </table>

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

  597. <p>Debug access to FAT table</p>

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

  599.   <table class="params">

  600.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>

  601.     <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>

  602.   </table>

  603.   </dd>

  604. </dl>

  605. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>

  606. 

  607. </div>

  608. </div>

  609. <a id="a21541734ad76f64ea24b9f45e2bd6117"></a>

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

  611. 

  612. <div class="memitem">

  613. <div class="memproto">

  614. <table class="mlabels">

  615.   <tr>

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

  617.       <table class="memname">

  618.         <tr>

  619.           <td class="memname">bool FatVolume::exists </td>

  620.           <td>(</td>

  621.           <td class="paramtype">const char *&#160;</td>

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

  623.           <td></td>

  624.         </tr>

  625.       </table>

  626.   </td>

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

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

  629.   </tr>

  630. </table>

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

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

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

  634.   <table class="params">

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

  636.   </table>

  637.   </dd>

  638. </dl>

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

  640. 

  641. </div>

  642. </div>

  643. <a id="afb7709e5b9e04265467305b43adf7cef"></a>

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

  645. 

  646. <div class="memitem">

  647. <div class="memproto">

  648. <table class="mlabels">

  649.   <tr>

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

  651.       <table class="memname">

  652.         <tr>

  653.           <td class="memname">bool FatVolume::exists </td>

  654.           <td>(</td>

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

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

  657.           <td></td>

  658.         </tr>

  659.       </table>

  660.   </td>

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

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

  663.   </tr>

  664. </table>

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

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

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

  668.   <table class="params">

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

  670.   </table>

  671.   </dd>

  672. </dl>

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

  674. 

  675. </div>

  676. </div>

  677. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>

  678. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>

  679. 

  680. <div class="memitem">

  681. <div class="memproto">

  682. <table class="mlabels">

  683.   <tr>

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

  685.       <table class="memname">

  686.         <tr>

  687.           <td class="memname">uint8_t FatPartition::fatCount </td>

  688.           <td>(</td>

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

  690.           <td></td>

  691.         </tr>

  692.       </table>

  693.   </td>

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

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

  696.   </tr>

  697. </table>

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

  699. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>

  700. 

  701. </div>

  702. </div>

  703. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>

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

  705. 

  706. <div class="memitem">

  707. <div class="memproto">

  708. <table class="mlabels">

  709.   <tr>

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

  711.       <table class="memname">

  712.         <tr>

  713.           <td class="memname">uint32_t FatPartition::fatStartSector </td>

  714.           <td>(</td>

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

  716.           <td> const</td>

  717.         </tr>

  718.       </table>

  719.   </td>

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

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

  722.   </tr>

  723. </table>

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

  725. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>

  726. 

  727. </div>

  728. </div>

  729. <a id="ad45c276232d7093b82f1075e8c488bac"></a>

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

  731. 

  732. <div class="memitem">

  733. <div class="memproto">

  734. <table class="mlabels">

  735.   <tr>

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

  737.       <table class="memname">

  738.         <tr>

  739.           <td class="memname">uint8_t FatPartition::fatType </td>

  740.           <td>(</td>

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

  742.           <td> const</td>

  743.         </tr>

  744.       </table>

  745.   </td>

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

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

  748.   </tr>

  749. </table>

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

  751. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  752. 

  753. </div>

  754. </div>

  755. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>

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

  757. 

  758. <div class="memitem">

  759. <div class="memproto">

  760. <table class="mlabels">

  761.   <tr>

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

  763.       <table class="memname">

  764.         <tr>

  765.           <td class="memname">int32_t FatPartition::freeClusterCount </td>

  766.           <td>(</td>

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

  768.           <td></td>

  769.         </tr>

  770.       </table>

  771.   </td>

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

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

  774.   </tr>

  775. </table>

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

  777. <p>Volume free space in clusters.</p>

  778. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>

  779. 

  780. </div>

  781. </div>

  782. <a id="ab827224f30eec57255d21cae589911ef"></a>

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

  784. 

  785. <div class="memitem">

  786. <div class="memproto">

  787. <table class="mlabels">

  788.   <tr>

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

  790.       <table class="memname">

  791.         <tr>

  792.           <td class="memname">bool FatPartition::init </td>

  793.           <td>(</td>

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

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

  796.         </tr>

  797.         <tr>

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

  799.           <td></td>

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

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

  802.         </tr>

  803.         <tr>

  804.           <td></td>

  805.           <td>)</td>

  806.           <td></td><td></td>

  807.         </tr>

  808.       </table>

  809.   </td>

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

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

  812.   </tr>

  813. </table>

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

  815. <p>Initialize a FAT partition.</p>

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

  817.   <table class="params">

  818.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>

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

  820.   </table>

  821.   </dd>

  822. </dl>

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

  824. 

  825. </div>

  826. </div>

  827. <a id="a455ad7b2a5b6b31551dca08087a3c404"></a>

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

  829. 

  830. <div class="memitem">

  831. <div class="memproto">

  832. <table class="mlabels">

  833.   <tr>

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

  835.       <table class="memname">

  836.         <tr>

  837.           <td class="memname">bool FatVolume::ls </td>

  838.           <td>(</td>

  839.           <td class="paramtype">const char *&#160;</td>

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

  841.         </tr>

  842.         <tr>

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

  844.           <td></td>

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

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

  847.         </tr>

  848.         <tr>

  849.           <td></td>

  850.           <td>)</td>

  851.           <td></td><td></td>

  852.         </tr>

  853.       </table>

  854.   </td>

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

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

  857.   </tr>

  858. </table>

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

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

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

  862.   <table class="params">

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

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

  865.   </table>

  866.   </dd>

  867. </dl>

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

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

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

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

  872. 

  873. </div>

  874. </div>

  875. <a id="ac5fc83cac7fd3af0b140a7986b9472f8"></a>

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

  877. 

  878. <div class="memitem">

  879. <div class="memproto">

  880. <table class="mlabels">

  881.   <tr>

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

  883.       <table class="memname">

  884.         <tr>

  885.           <td class="memname">bool FatVolume::ls </td>

  886.           <td>(</td>

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

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

  889.         </tr>

  890.         <tr>

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

  892.           <td></td>

  893.           <td class="paramtype">const char *&#160;</td>

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

  895.         </tr>

  896.         <tr>

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

  898.           <td></td>

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

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

  901.         </tr>

  902.         <tr>

  903.           <td></td>

  904.           <td>)</td>

  905.           <td></td><td></td>

  906.         </tr>

  907.       </table>

  908.   </td>

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

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

  911.   </tr>

  912. </table>

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

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

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

  916.   <table class="params">

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

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

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

  920.   </table>

  921.   </dd>

  922. </dl>

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

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

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

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

  927. 

  928. </div>

  929. </div>

  930. <a id="ae40964f357cfff4208812344a0e6f26f"></a>

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

  932. 

  933. <div class="memitem">

  934. <div class="memproto">

  935. <table class="mlabels">

  936.   <tr>

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

  938.       <table class="memname">

  939.         <tr>

  940.           <td class="memname">bool FatVolume::ls </td>

  941.           <td>(</td>

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

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

  944.         </tr>

  945.         <tr>

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

  947.           <td></td>

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

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

  950.         </tr>

  951.         <tr>

  952.           <td></td>

  953.           <td>)</td>

  954.           <td></td><td></td>

  955.         </tr>

  956.       </table>

  957.   </td>

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

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

  960.   </tr>

  961. </table>

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

  963. <p>List the directory contents of the volume root directory.</p>

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

  965.   <table class="params">

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

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

  968.   </table>

  969.   </dd>

  970. </dl>

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

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

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

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

  975. 

  976. </div>

  977. </div>

  978. <a id="ad455ad05551329865c659cc4676f2d18"></a>

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

  980. 

  981. <div class="memitem">

  982. <div class="memproto">

  983. <table class="mlabels">

  984.   <tr>

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

  986.       <table class="memname">

  987.         <tr>

  988.           <td class="memname">bool FatVolume::ls </td>

  989.           <td>(</td>

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

  991.           <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>

  992.           <td></td>

  993.         </tr>

  994.       </table>

  995.   </td>

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

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

  998.   </tr>

  999. </table>

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

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

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

  1003.   <table class="params">

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

  1005.   </table>

  1006.   </dd>

  1007. </dl>

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

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

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

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

  1012. 

  1013. </div>

  1014. </div>

  1015. <a id="ad80bccf8f24ff001a7b9277effc2cc52"></a>

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

  1017. 

  1018. <div class="memitem">

  1019. <div class="memproto">

  1020. <table class="mlabels">

  1021.   <tr>

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

  1023.       <table class="memname">

  1024.         <tr>

  1025.           <td class="memname">bool FatVolume::mkdir </td>

  1026.           <td>(</td>

  1027.           <td class="paramtype">const char *&#160;</td>

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

  1029.         </tr>

  1030.         <tr>

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

  1032.           <td></td>

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

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

  1035.         </tr>

  1036.         <tr>

  1037.           <td></td>

  1038.           <td>)</td>

  1039.           <td></td><td></td>

  1040.         </tr>

  1041.       </table>

  1042.   </td>

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

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

  1045.   </tr>

  1046. </table>

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

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

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

  1050.   <table class="params">

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

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

  1053.   </table>

  1054.   </dd>

  1055. </dl>

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

  1057. 

  1058. </div>

  1059. </div>

  1060. <a id="ab423ec4f7e5b58a6d454f328f61fd864"></a>

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

  1062. 

  1063. <div class="memitem">

  1064. <div class="memproto">

  1065. <table class="mlabels">

  1066.   <tr>

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

  1068.       <table class="memname">

  1069.         <tr>

  1070.           <td class="memname">bool FatVolume::mkdir </td>

  1071.           <td>(</td>

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

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

  1074.         </tr>

  1075.         <tr>

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

  1077.           <td></td>

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

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

  1080.         </tr>

  1081.         <tr>

  1082.           <td></td>

  1083.           <td>)</td>

  1084.           <td></td><td></td>

  1085.         </tr>

  1086.       </table>

  1087.   </td>

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

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

  1090.   </tr>

  1091. </table>

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

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

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

  1095.   <table class="params">

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

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

  1098.   </table>

  1099.   </dd>

  1100. </dl>

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

  1102. 

  1103. </div>

  1104. </div>

  1105. <a id="a22923b86de9c797ce5e19f206dd4ce1f"></a>

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

  1107. 

  1108. <div class="memitem">

  1109. <div class="memproto">

  1110. <table class="mlabels">

  1111.   <tr>

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

  1113.       <table class="memname">

  1114.         <tr>

  1115.           <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>

  1116.           <td>(</td>

  1117.           <td class="paramtype">const char *&#160;</td>

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

  1119.         </tr>

  1120.         <tr>

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

  1122.           <td></td>

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

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

  1125.         </tr>

  1126.         <tr>

  1127.           <td></td>

  1128.           <td>)</td>

  1129.           <td></td><td></td>

  1130.         </tr>

  1131.       </table>

  1132.   </td>

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

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

  1135.   </tr>

  1136. </table>

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

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

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

  1140.   <table class="params">

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

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

  1143.   </table>

  1144.   </dd>

  1145. </dl>

  1146. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream.">File32</a> object. </dd></dl>

  1147. 

  1148. </div>

  1149. </div>

  1150. <a id="af7178b7f13eeae7748640b6268a34812"></a>

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

  1152. 

  1153. <div class="memitem">

  1154. <div class="memproto">

  1155. <table class="mlabels">

  1156.   <tr>

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

  1158.       <table class="memname">

  1159.         <tr>

  1160.           <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>

  1161.           <td>(</td>

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

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

  1164.         </tr>

  1165.         <tr>

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

  1167.           <td></td>

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

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

  1170.         </tr>

  1171.         <tr>

  1172.           <td></td>

  1173.           <td>)</td>

  1174.           <td></td><td></td>

  1175.         </tr>

  1176.       </table>

  1177.   </td>

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

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

  1180.   </tr>

  1181. </table>

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

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

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

  1185.   <table class="params">

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

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

  1188.   </table>

  1189.   </dd>

  1190. </dl>

  1191. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream.">File32</a> object. </dd></dl>

  1192. 

  1193. </div>

  1194. </div>

  1195. <a id="abb11d05ef407775bcdb9b14a6c608433"></a>

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

  1197. 

  1198. <div class="memitem">

  1199. <div class="memproto">

  1200. <table class="mlabels">

  1201.   <tr>

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

  1203.       <table class="memname">

  1204.         <tr>

  1205.           <td class="memname">bool FatVolume::remove </td>

  1206.           <td>(</td>

  1207.           <td class="paramtype">const char *&#160;</td>

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

  1209.           <td></td>

  1210.         </tr>

  1211.       </table>

  1212.   </td>

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

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

  1215.   </tr>

  1216. </table>

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

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

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

  1220.   <table class="params">

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

  1222.   </table>

  1223.   </dd>

  1224. </dl>

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

  1226. 

  1227. </div>

  1228. </div>

  1229. <a id="a994411f55df474be6be87f06100c2c39"></a>

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

  1231. 

  1232. <div class="memitem">

  1233. <div class="memproto">

  1234. <table class="mlabels">

  1235.   <tr>

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

  1237.       <table class="memname">

  1238.         <tr>

  1239.           <td class="memname">bool FatVolume::remove </td>

  1240.           <td>(</td>

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

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

  1243.           <td></td>

  1244.         </tr>

  1245.       </table>

  1246.   </td>

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

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

  1249.   </tr>

  1250. </table>

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

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

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

  1254.   <table class="params">

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

  1256.   </table>

  1257.   </dd>

  1258. </dl>

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

  1260. 

  1261. </div>

  1262. </div>

  1263. <a id="a5e4ea6c91569dc435c7aacd7ba704911"></a>

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

  1265. 

  1266. <div class="memitem">

  1267. <div class="memproto">

  1268. <table class="mlabels">

  1269.   <tr>

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

  1271.       <table class="memname">

  1272.         <tr>

  1273.           <td class="memname">bool FatVolume::rename </td>

  1274.           <td>(</td>

  1275.           <td class="paramtype">const char *&#160;</td>

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

  1277.         </tr>

  1278.         <tr>

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

  1280.           <td></td>

  1281.           <td class="paramtype">const char *&#160;</td>

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

  1283.         </tr>

  1284.         <tr>

  1285.           <td></td>

  1286.           <td>)</td>

  1287.           <td></td><td></td>

  1288.         </tr>

  1289.       </table>

  1290.   </td>

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

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

  1293.   </tr>

  1294. </table>

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

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

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

  1298.   <table class="params">

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

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

  1301.   </table>

  1302.   </dd>

  1303. </dl>

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

  1305. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>

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

  1307. 

  1308. </div>

  1309. </div>

  1310. <a id="aa7015c0f694261780081c79c05d0882d"></a>

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

  1312. 

  1313. <div class="memitem">

  1314. <div class="memproto">

  1315. <table class="mlabels">

  1316.   <tr>

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

  1318.       <table class="memname">

  1319.         <tr>

  1320.           <td class="memname">bool FatVolume::rename </td>

  1321.           <td>(</td>

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

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

  1324.         </tr>

  1325.         <tr>

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

  1327.           <td></td>

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

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

  1330.         </tr>

  1331.         <tr>

  1332.           <td></td>

  1333.           <td>)</td>

  1334.           <td></td><td></td>

  1335.         </tr>

  1336.       </table>

  1337.   </td>

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

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

  1340.   </tr>

  1341. </table>

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

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

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

  1345.   <table class="params">

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

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

  1348.   </table>

  1349.   </dd>

  1350. </dl>

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

  1352. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>

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

  1354. 

  1355. </div>

  1356. </div>

  1357. <a id="af1181990bcece7dbb7d19293dd4fe11a"></a>

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

  1359. 

  1360. <div class="memitem">

  1361. <div class="memproto">

  1362. <table class="mlabels">

  1363.   <tr>

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

  1365.       <table class="memname">

  1366.         <tr>

  1367.           <td class="memname">bool FatVolume::rmdir </td>

  1368.           <td>(</td>

  1369.           <td class="paramtype">const char *&#160;</td>

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

  1371.           <td></td>

  1372.         </tr>

  1373.       </table>

  1374.   </td>

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

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

  1377.   </tr>

  1378. </table>

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

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

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

  1382.   <table class="params">

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

  1384.   </table>

  1385.   </dd>

  1386. </dl>

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

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

  1389. 

  1390. </div>

  1391. </div>

  1392. <a id="a105f437fb649b57ed3823f8ff1a2f37e"></a>

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

  1394. 

  1395. <div class="memitem">

  1396. <div class="memproto">

  1397. <table class="mlabels">

  1398.   <tr>

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

  1400.       <table class="memname">

  1401.         <tr>

  1402.           <td class="memname">bool FatVolume::rmdir </td>

  1403.           <td>(</td>

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

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

  1406.           <td></td>

  1407.         </tr>

  1408.       </table>

  1409.   </td>

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

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

  1412.   </tr>

  1413. </table>

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

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

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

  1417.   <table class="params">

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

  1419.   </table>

  1420.   </dd>

  1421. </dl>

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

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

  1424. 

  1425. </div>

  1426. </div>

  1427. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>

  1428. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>

  1429. 

  1430. <div class="memitem">

  1431. <div class="memproto">

  1432. <table class="mlabels">

  1433.   <tr>

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

  1435.       <table class="memname">

  1436.         <tr>

  1437.           <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>

  1438.           <td>(</td>

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

  1440.           <td> const</td>

  1441.         </tr>

  1442.       </table>

  1443.   </td>

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

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

  1446.   </tr>

  1447. </table>

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

  1449. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  1450. 

  1451. </div>

  1452. </div>

  1453. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>

  1454. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>

  1455. 

  1456. <div class="memitem">

  1457. <div class="memproto">

  1458. <table class="mlabels">

  1459.   <tr>

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

  1461.       <table class="memname">

  1462.         <tr>

  1463.           <td class="memname">uint32_t FatPartition::rootDirStart </td>

  1464.           <td>(</td>

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

  1466.           <td> const</td>

  1467.         </tr>

  1468.       </table>

  1469.   </td>

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

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

  1472.   </tr>

  1473. </table>

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

  1475. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>

  1476. 

  1477. </div>

  1478. </div>

  1479. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>

  1480. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>

  1481. 

  1482. <div class="memitem">

  1483. <div class="memproto">

  1484. <table class="mlabels">

  1485.   <tr>

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

  1487.       <table class="memname">

  1488.         <tr>

  1489.           <td class="memname">uint16_t FatPartition::sectorMask </td>

  1490.           <td>(</td>

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

  1492.           <td></td>

  1493.         </tr>

  1494.       </table>

  1495.   </td>

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

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

  1498.   </tr>

  1499. </table>

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

  1501. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>

  1502. 

  1503. </div>

  1504. </div>

  1505. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>

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

  1507. 

  1508. <div class="memitem">

  1509. <div class="memproto">

  1510. <table class="mlabels">

  1511.   <tr>

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

  1513.       <table class="memname">

  1514.         <tr>

  1515.           <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>

  1516.           <td>(</td>

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

  1518.           <td> const</td>

  1519.         </tr>

  1520.       </table>

  1521.   </td>

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

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

  1524.   </tr>

  1525. </table>

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

  1527. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>

  1528. 

  1529. </div>

  1530. </div>

  1531. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>

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

  1533. 

  1534. <div class="memitem">

  1535. <div class="memproto">

  1536. <table class="mlabels">

  1537.   <tr>

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

  1539.       <table class="memname">

  1540.         <tr>

  1541.           <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>

  1542.           <td>(</td>

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

  1544.           <td> const</td>

  1545.         </tr>

  1546.       </table>

  1547.   </td>

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

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

  1550.   </tr>

  1551. </table>

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

  1553. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>

  1554. 

  1555. </div>

  1556. </div>

  1557. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>

  1558. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>

  1559. 

  1560. <div class="memitem">

  1561. <div class="memproto">

  1562. <table class="mlabels">

  1563.   <tr>

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

  1565.       <table class="memname">

  1566.         <tr>

  1567.           <td class="memname">uint32_t FatPartition::sectorsPerFat </td>

  1568.           <td>(</td>

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

  1570.           <td> const</td>

  1571.         </tr>

  1572.       </table>

  1573.   </td>

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

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

  1576.   </tr>

  1577. </table>

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

  1579. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>

  1580. 

  1581. </div>

  1582. </div>

  1583. <a id="a86a08bf789e33567418465b9b12751e2"></a>

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

  1585. 

  1586. <div class="memitem">

  1587. <div class="memproto">

  1588. <table class="mlabels">

  1589.   <tr>

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

  1591.       <table class="memname">

  1592.         <tr>

  1593.           <td class="memname">bool FatVolume::truncate </td>

  1594.           <td>(</td>

  1595.           <td class="paramtype">const char *&#160;</td>

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

  1597.         </tr>

  1598.         <tr>

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

  1600.           <td></td>

  1601.           <td class="paramtype">uint32_t&#160;</td>

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

  1603.         </tr>

  1604.         <tr>

  1605.           <td></td>

  1606.           <td>)</td>

  1607.           <td></td><td></td>

  1608.         </tr>

  1609.       </table>

  1610.   </td>

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

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

  1613.   </tr>

  1614. </table>

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

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

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

  1618.   <table class="params">

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

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

  1621.   </table>

  1622.   </dd>

  1623. </dl>

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

  1625. 

  1626. </div>

  1627. </div>

  1628. <a id="a97ef39ec02c38c0772f0029d42edcb46"></a>

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

  1630. 

  1631. <div class="memitem">

  1632. <div class="memproto">

  1633. <table class="mlabels">

  1634.   <tr>

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

  1636.       <table class="memname">

  1637.         <tr>

  1638.           <td class="memname">bool FatVolume::truncate </td>

  1639.           <td>(</td>

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

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

  1642.         </tr>

  1643.         <tr>

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

  1645.           <td></td>

  1646.           <td class="paramtype">uint32_t&#160;</td>

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

  1648.         </tr>

  1649.         <tr>

  1650.           <td></td>

  1651.           <td>)</td>

  1652.           <td></td><td></td>

  1653.         </tr>

  1654.       </table>

  1655.   </td>

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

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

  1658.   </tr>

  1659. </table>

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

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

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

  1663.   <table class="params">

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

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

  1666.   </table>

  1667.   </dd>

  1668. </dl>

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

  1670. 

  1671. </div>

  1672. </div>

  1673. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>

  1674. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>

  1675. 

  1676. <div class="memitem">

  1677. <div class="memproto">

  1678. <table class="mlabels">

  1679.   <tr>

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

  1681.       <table class="memname">

  1682.         <tr>

  1683.           <td class="memname">uint32_t FatPartition::volumeSectorCount </td>

  1684.           <td>(</td>

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

  1686.           <td> const</td>

  1687.         </tr>

  1688.       </table>

  1689.   </td>

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

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

  1692.   </tr>

  1693. </table>

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

  1695. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>

  1696. 

  1697. </div>

  1698. </div>

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

  1700. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>

  1701. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatVolume.cpp</li>

  1702. </ul>

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

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

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

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

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

  1708. </a> 1.8.16

  1709. </small></address>

  1710. </body>

  1711. </html>