visus
/
teensy-sdfat
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
53 Commity
1 Gałąź
Drzewo: c980c3e6ec
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'c980c3e6ec'
${ noResults }
teensy-sdfat/extras/html/class_fat_volume.html

1710 lines
73KB
Czysty Wina Historia 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.14"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: 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.14 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  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" id="node3" href="class_sd_base.html" title="SdBase\&lt; FatVolume \&gt;" alt="" coords="5,155,160,181"/>

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

  84. <area shape="rect" id="node4" href="class_sd_fat32.html" title="SD file system class for FAT volumes. " alt="" coords="47,229,118,256"/>

  85. </map>

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

  87. <div class="dynheader">

  88. Collaboration diagram for FatVolume:</div>

  89. <div class="dyncontent">

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

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

  92. <area shape="rect" id="node2" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices. " alt="" coords="5,5,95,32"/>

  93. </map>

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

  95. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  189. </table>

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

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

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

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

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

  195. 

  196. <div class="memitem">

  197. <div class="memproto">

  198. <table class="mlabels">

  199.   <tr>

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

  201.       <table class="memname">

  202.         <tr>

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

  204.           <td>(</td>

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

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

  207.         </tr>

  208.         <tr>

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

  210.           <td></td>

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

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

  213.         </tr>

  214.         <tr>

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

  216.           <td></td>

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

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

  219.         </tr>

  220.         <tr>

  221.           <td></td>

  222.           <td>)</td>

  223.           <td></td><td></td>

  224.         </tr>

  225.       </table>

  226.   </td>

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

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

  229.   </tr>

  230. </table>

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

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

  233.   <table class="params">

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

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

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

  237.   </table>

  238.   </dd>

  239. </dl>

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

  241. 

  242. </div>

  243. </div>

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

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

  246. 

  247. <div class="memitem">

  248. <div class="memproto">

  249. <table class="mlabels">

  250.   <tr>

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

  252.       <table class="memname">

  253.         <tr>

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

  255.           <td>(</td>

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

  257.           <td></td>

  258.         </tr>

  259.       </table>

  260.   </td>

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

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

  263.   </tr>

  264. </table>

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

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

  267. 

  268. </div>

  269. </div>

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

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

  272. 

  273. <div class="memitem">

  274. <div class="memproto">

  275. <table class="mlabels">

  276.   <tr>

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

  278.       <table class="memname">

  279.         <tr>

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

  281.           <td>(</td>

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

  283.           <td></td>

  284.         </tr>

  285.       </table>

  286.   </td>

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

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

  289.   </tr>

  290. </table>

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

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

  293. 

  294. </div>

  295. </div>

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

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

  298. 

  299. <div class="memitem">

  300. <div class="memproto">

  301. <table class="mlabels">

  302.   <tr>

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

  304.       <table class="memname">

  305.         <tr>

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

  307.           <td>(</td>

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

  309.           <td></td>

  310.         </tr>

  311.       </table>

  312.   </td>

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

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

  315.   </tr>

  316. </table>

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

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

  319. 

  320. </div>

  321. </div>

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

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

  324. 

  325. <div class="memitem">

  326. <div class="memproto">

  327. <table class="mlabels">

  328.   <tr>

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

  330.       <table class="memname">

  331.         <tr>

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

  333.           <td>(</td>

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

  335.           <td></td>

  336.         </tr>

  337.       </table>

  338.   </td>

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

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

  341.   </tr>

  342. </table>

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

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

  345. 

  346. </div>

  347. </div>

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

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

  350. 

  351. <div class="memitem">

  352. <div class="memproto">

  353. <table class="mlabels">

  354.   <tr>

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

  356.       <table class="memname">

  357.         <tr>

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

  359.           <td>(</td>

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

  361.           <td></td>

  362.         </tr>

  363.       </table>

  364.   </td>

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

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

  367.   </tr>

  368. </table>

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

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

  371. 

  372. </div>

  373. </div>

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

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

  376. 

  377. <div class="memitem">

  378. <div class="memproto">

  379. <table class="mlabels">

  380.   <tr>

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

  382.       <table class="memname">

  383.         <tr>

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

  385.           <td>(</td>

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

  387.           <td></td>

  388.         </tr>

  389.       </table>

  390.   </td>

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

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

  393.   </tr>

  394. </table>

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

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

  397. 

  398. </div>

  399. </div>

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

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

  402. 

  403. <div class="memitem">

  404. <div class="memproto">

  405.       <table class="memname">

  406.         <tr>

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

  408.           <td>(</td>

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

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

  411.           <td></td>

  412.         </tr>

  413.       </table>

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

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

  416.   <table class="params">

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

  418.   </table>

  419.   </dd>

  420. </dl>

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

  422. 

  423. </div>

  424. </div>

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

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

  427. 

  428. <div class="memitem">

  429. <div class="memproto">

  430. <table class="mlabels">

  431.   <tr>

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

  433.       <table class="memname">

  434.         <tr>

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

  436.           <td>(</td>

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

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

  439.           <td></td>

  440.         </tr>

  441.       </table>

  442.   </td>

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

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

  445.   </tr>

  446. </table>

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

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

  449.   <table class="params">

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

  451.   </table>

  452.   </dd>

  453. </dl>

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

  455. 

  456. </div>

  457. </div>

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

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

  460. 

  461. <div class="memitem">

  462. <div class="memproto">

  463. <table class="mlabels">

  464.   <tr>

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

  466.       <table class="memname">

  467.         <tr>

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

  469.           <td>(</td>

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

  471.           <td></td>

  472.         </tr>

  473.       </table>

  474.   </td>

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

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

  477.   </tr>

  478. </table>

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

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

  481. 

  482. </div>

  483. </div>

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

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

  486. 

  487. <div class="memitem">

  488. <div class="memproto">

  489. <table class="mlabels">

  490.   <tr>

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

  492.       <table class="memname">

  493.         <tr>

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

  495.           <td>(</td>

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

  497.           <td> const</td>

  498.         </tr>

  499.       </table>

  500.   </td>

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

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

  503.   </tr>

  504. </table>

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

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

  507. 

  508. </div>

  509. </div>

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

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

  512. 

  513. <div class="memitem">

  514. <div class="memproto">

  515. <table class="mlabels">

  516.   <tr>

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

  518.       <table class="memname">

  519.         <tr>

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

  521.           <td>(</td>

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

  523.           <td></td>

  524.         </tr>

  525.       </table>

  526.   </td>

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

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

  529.   </tr>

  530. </table>

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

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

  533. 

  534. </div>

  535. </div>

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

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

  538. 

  539. <div class="memitem">

  540. <div class="memproto">

  541. <table class="mlabels">

  542.   <tr>

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

  544.       <table class="memname">

  545.         <tr>

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

  547.           <td>(</td>

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

  549.           <td> const</td>

  550.         </tr>

  551.       </table>

  552.   </td>

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

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

  555.   </tr>

  556. </table>

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

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

  559. 

  560. </div>

  561. </div>

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

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

  564. 

  565. <div class="memitem">

  566. <div class="memproto">

  567. <table class="mlabels">

  568.   <tr>

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

  570.       <table class="memname">

  571.         <tr>

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

  573.           <td>(</td>

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

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

  576.         </tr>

  577.         <tr>

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

  579.           <td></td>

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

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

  582.         </tr>

  583.         <tr>

  584.           <td></td>

  585.           <td>)</td>

  586.           <td></td><td></td>

  587.         </tr>

  588.       </table>

  589.   </td>

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

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

  592.   </tr>

  593. </table>

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

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

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

  597.   <table class="params">

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

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

  600.   </table>

  601.   </dd>

  602. </dl>

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

  604. 

  605. </div>

  606. </div>

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

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

  609. 

  610. <div class="memitem">

  611. <div class="memproto">

  612. <table class="mlabels">

  613.   <tr>

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

  615.       <table class="memname">

  616.         <tr>

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

  618.           <td>(</td>

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

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

  621.           <td></td>

  622.         </tr>

  623.       </table>

  624.   </td>

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

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

  627.   </tr>

  628. </table>

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

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

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

  632.   <table class="params">

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

  634.   </table>

  635.   </dd>

  636. </dl>

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

  638. 

  639. </div>

  640. </div>

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

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

  643. 

  644. <div class="memitem">

  645. <div class="memproto">

  646. <table class="mlabels">

  647.   <tr>

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

  649.       <table class="memname">

  650.         <tr>

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

  652.           <td>(</td>

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

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

  655.           <td></td>

  656.         </tr>

  657.       </table>

  658.   </td>

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

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

  661.   </tr>

  662. </table>

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

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

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

  666.   <table class="params">

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

  668.   </table>

  669.   </dd>

  670. </dl>

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

  672. 

  673. </div>

  674. </div>

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

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

  677. 

  678. <div class="memitem">

  679. <div class="memproto">

  680. <table class="mlabels">

  681.   <tr>

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

  683.       <table class="memname">

  684.         <tr>

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

  686.           <td>(</td>

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

  688.           <td></td>

  689.         </tr>

  690.       </table>

  691.   </td>

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

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

  694.   </tr>

  695. </table>

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

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

  698. 

  699. </div>

  700. </div>

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

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

  703. 

  704. <div class="memitem">

  705. <div class="memproto">

  706. <table class="mlabels">

  707.   <tr>

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

  709.       <table class="memname">

  710.         <tr>

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

  712.           <td>(</td>

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

  714.           <td> const</td>

  715.         </tr>

  716.       </table>

  717.   </td>

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

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

  720.   </tr>

  721. </table>

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

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

  724. 

  725. </div>

  726. </div>

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

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

  729. 

  730. <div class="memitem">

  731. <div class="memproto">

  732. <table class="mlabels">

  733.   <tr>

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

  735.       <table class="memname">

  736.         <tr>

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

  738.           <td>(</td>

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

  740.           <td> const</td>

  741.         </tr>

  742.       </table>

  743.   </td>

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

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

  746.   </tr>

  747. </table>

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

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

  750. 

  751. </div>

  752. </div>

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

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

  755. 

  756. <div class="memitem">

  757. <div class="memproto">

  758. <table class="mlabels">

  759.   <tr>

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

  761.       <table class="memname">

  762.         <tr>

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

  764.           <td>(</td>

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

  766.           <td></td>

  767.         </tr>

  768.       </table>

  769.   </td>

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

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

  772.   </tr>

  773. </table>

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

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

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

  777. 

  778. </div>

  779. </div>

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

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

  782. 

  783. <div class="memitem">

  784. <div class="memproto">

  785. <table class="mlabels">

  786.   <tr>

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

  788.       <table class="memname">

  789.         <tr>

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

  791.           <td>(</td>

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

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

  794.         </tr>

  795.         <tr>

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

  797.           <td></td>

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

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

  800.         </tr>

  801.         <tr>

  802.           <td></td>

  803.           <td>)</td>

  804.           <td></td><td></td>

  805.         </tr>

  806.       </table>

  807.   </td>

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

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

  810.   </tr>

  811. </table>

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

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

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

  815.   <table class="params">

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

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

  818.   </table>

  819.   </dd>

  820. </dl>

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

  822. 

  823. </div>

  824. </div>

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

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

  827. 

  828. <div class="memitem">

  829. <div class="memproto">

  830. <table class="mlabels">

  831.   <tr>

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

  833.       <table class="memname">

  834.         <tr>

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

  836.           <td>(</td>

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

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

  839.         </tr>

  840.         <tr>

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

  842.           <td></td>

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

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

  845.         </tr>

  846.         <tr>

  847.           <td></td>

  848.           <td>)</td>

  849.           <td></td><td></td>

  850.         </tr>

  851.       </table>

  852.   </td>

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

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

  855.   </tr>

  856. </table>

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

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

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

  860.   <table class="params">

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

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

  863.   </table>

  864.   </dd>

  865. </dl>

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

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

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

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

  870. 

  871. </div>

  872. </div>

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

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

  875. 

  876. <div class="memitem">

  877. <div class="memproto">

  878. <table class="mlabels">

  879.   <tr>

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

  881.       <table class="memname">

  882.         <tr>

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

  884.           <td>(</td>

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

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

  887.         </tr>

  888.         <tr>

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

  890.           <td></td>

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

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

  893.         </tr>

  894.         <tr>

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

  896.           <td></td>

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

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

  899.         </tr>

  900.         <tr>

  901.           <td></td>

  902.           <td>)</td>

  903.           <td></td><td></td>

  904.         </tr>

  905.       </table>

  906.   </td>

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

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

  909.   </tr>

  910. </table>

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

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

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

  914.   <table class="params">

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

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

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

  918.   </table>

  919.   </dd>

  920. </dl>

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

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

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

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

  925. 

  926. </div>

  927. </div>

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

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

  930. 

  931. <div class="memitem">

  932. <div class="memproto">

  933. <table class="mlabels">

  934.   <tr>

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

  936.       <table class="memname">

  937.         <tr>

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

  939.           <td>(</td>

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

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

  942.           <td></td>

  943.         </tr>

  944.       </table>

  945.   </td>

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

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

  948.   </tr>

  949. </table>

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

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

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

  953.   <table class="params">

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

  955.   </table>

  956.   </dd>

  957. </dl>

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

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

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

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

  962. 

  963. </div>

  964. </div>

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

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

  967. 

  968. <div class="memitem">

  969. <div class="memproto">

  970. <table class="mlabels">

  971.   <tr>

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

  973.       <table class="memname">

  974.         <tr>

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

  976.           <td>(</td>

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

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

  979.         </tr>

  980.         <tr>

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

  982.           <td></td>

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

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

  985.         </tr>

  986.         <tr>

  987.           <td></td>

  988.           <td>)</td>

  989.           <td></td><td></td>

  990.         </tr>

  991.       </table>

  992.   </td>

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

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

  995.   </tr>

  996. </table>

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

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

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

  1000.   <table class="params">

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

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

  1003.   </table>

  1004.   </dd>

  1005. </dl>

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

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

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

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

  1010. 

  1011. </div>

  1012. </div>

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

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

  1015. 

  1016. <div class="memitem">

  1017. <div class="memproto">

  1018. <table class="mlabels">

  1019.   <tr>

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

  1021.       <table class="memname">

  1022.         <tr>

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

  1024.           <td>(</td>

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

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

  1027.         </tr>

  1028.         <tr>

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

  1030.           <td></td>

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

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

  1033.         </tr>

  1034.         <tr>

  1035.           <td></td>

  1036.           <td>)</td>

  1037.           <td></td><td></td>

  1038.         </tr>

  1039.       </table>

  1040.   </td>

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

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

  1043.   </tr>

  1044. </table>

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

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

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

  1048.   <table class="params">

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

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

  1051.   </table>

  1052.   </dd>

  1053. </dl>

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

  1055. 

  1056. </div>

  1057. </div>

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

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

  1060. 

  1061. <div class="memitem">

  1062. <div class="memproto">

  1063. <table class="mlabels">

  1064.   <tr>

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

  1066.       <table class="memname">

  1067.         <tr>

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

  1069.           <td>(</td>

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

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

  1072.         </tr>

  1073.         <tr>

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

  1075.           <td></td>

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

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

  1078.         </tr>

  1079.         <tr>

  1080.           <td></td>

  1081.           <td>)</td>

  1082.           <td></td><td></td>

  1083.         </tr>

  1084.       </table>

  1085.   </td>

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

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

  1088.   </tr>

  1089. </table>

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

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

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

  1093.   <table class="params">

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

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

  1096.   </table>

  1097.   </dd>

  1098. </dl>

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

  1100. 

  1101. </div>

  1102. </div>

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

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

  1105. 

  1106. <div class="memitem">

  1107. <div class="memproto">

  1108. <table class="mlabels">

  1109.   <tr>

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

  1111.       <table class="memname">

  1112.         <tr>

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

  1114.           <td>(</td>

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

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

  1117.         </tr>

  1118.         <tr>

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

  1120.           <td></td>

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

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

  1123.         </tr>

  1124.         <tr>

  1125.           <td></td>

  1126.           <td>)</td>

  1127.           <td></td><td></td>

  1128.         </tr>

  1129.       </table>

  1130.   </td>

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

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

  1133.   </tr>

  1134. </table>

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

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

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

  1138.   <table class="params">

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

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

  1141.   </table>

  1142.   </dd>

  1143. </dl>

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

  1145. 

  1146. </div>

  1147. </div>

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

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

  1150. 

  1151. <div class="memitem">

  1152. <div class="memproto">

  1153. <table class="mlabels">

  1154.   <tr>

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

  1156.       <table class="memname">

  1157.         <tr>

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

  1159.           <td>(</td>

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

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

  1162.         </tr>

  1163.         <tr>

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

  1165.           <td></td>

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

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

  1168.         </tr>

  1169.         <tr>

  1170.           <td></td>

  1171.           <td>)</td>

  1172.           <td></td><td></td>

  1173.         </tr>

  1174.       </table>

  1175.   </td>

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

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

  1178.   </tr>

  1179. </table>

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

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

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

  1183.   <table class="params">

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

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

  1186.   </table>

  1187.   </dd>

  1188. </dl>

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

  1190. 

  1191. </div>

  1192. </div>

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

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

  1195. 

  1196. <div class="memitem">

  1197. <div class="memproto">

  1198. <table class="mlabels">

  1199.   <tr>

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

  1201.       <table class="memname">

  1202.         <tr>

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

  1204.           <td>(</td>

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

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

  1207.           <td></td>

  1208.         </tr>

  1209.       </table>

  1210.   </td>

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

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

  1213.   </tr>

  1214. </table>

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

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

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

  1218.   <table class="params">

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

  1220.   </table>

  1221.   </dd>

  1222. </dl>

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

  1224. 

  1225. </div>

  1226. </div>

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

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

  1229. 

  1230. <div class="memitem">

  1231. <div class="memproto">

  1232. <table class="mlabels">

  1233.   <tr>

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

  1235.       <table class="memname">

  1236.         <tr>

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

  1238.           <td>(</td>

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

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

  1241.           <td></td>

  1242.         </tr>

  1243.       </table>

  1244.   </td>

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

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

  1247.   </tr>

  1248. </table>

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

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

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

  1252.   <table class="params">

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

  1254.   </table>

  1255.   </dd>

  1256. </dl>

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

  1258. 

  1259. </div>

  1260. </div>

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

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

  1263. 

  1264. <div class="memitem">

  1265. <div class="memproto">

  1266. <table class="mlabels">

  1267.   <tr>

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

  1269.       <table class="memname">

  1270.         <tr>

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

  1272.           <td>(</td>

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

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

  1275.         </tr>

  1276.         <tr>

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

  1278.           <td></td>

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

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

  1281.         </tr>

  1282.         <tr>

  1283.           <td></td>

  1284.           <td>)</td>

  1285.           <td></td><td></td>

  1286.         </tr>

  1287.       </table>

  1288.   </td>

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

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

  1291.   </tr>

  1292. </table>

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

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

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

  1296.   <table class="params">

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

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

  1299.   </table>

  1300.   </dd>

  1301. </dl>

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

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

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

  1305. 

  1306. </div>

  1307. </div>

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

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

  1310. 

  1311. <div class="memitem">

  1312. <div class="memproto">

  1313. <table class="mlabels">

  1314.   <tr>

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

  1316.       <table class="memname">

  1317.         <tr>

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

  1319.           <td>(</td>

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

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

  1322.         </tr>

  1323.         <tr>

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

  1325.           <td></td>

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

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

  1328.         </tr>

  1329.         <tr>

  1330.           <td></td>

  1331.           <td>)</td>

  1332.           <td></td><td></td>

  1333.         </tr>

  1334.       </table>

  1335.   </td>

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

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

  1338.   </tr>

  1339. </table>

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

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

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

  1343.   <table class="params">

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

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

  1346.   </table>

  1347.   </dd>

  1348. </dl>

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

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

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

  1352. 

  1353. </div>

  1354. </div>

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

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

  1357. 

  1358. <div class="memitem">

  1359. <div class="memproto">

  1360. <table class="mlabels">

  1361.   <tr>

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

  1363.       <table class="memname">

  1364.         <tr>

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

  1366.           <td>(</td>

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

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

  1369.           <td></td>

  1370.         </tr>

  1371.       </table>

  1372.   </td>

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

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

  1375.   </tr>

  1376. </table>

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

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

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

  1380.   <table class="params">

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

  1382.   </table>

  1383.   </dd>

  1384. </dl>

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

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

  1387. 

  1388. </div>

  1389. </div>

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

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

  1392. 

  1393. <div class="memitem">

  1394. <div class="memproto">

  1395. <table class="mlabels">

  1396.   <tr>

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

  1398.       <table class="memname">

  1399.         <tr>

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

  1401.           <td>(</td>

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

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

  1404.           <td></td>

  1405.         </tr>

  1406.       </table>

  1407.   </td>

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

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

  1410.   </tr>

  1411. </table>

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

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

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

  1415.   <table class="params">

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

  1417.   </table>

  1418.   </dd>

  1419. </dl>

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

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

  1422. 

  1423. </div>

  1424. </div>

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

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

  1427. 

  1428. <div class="memitem">

  1429. <div class="memproto">

  1430. <table class="mlabels">

  1431.   <tr>

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

  1433.       <table class="memname">

  1434.         <tr>

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

  1436.           <td>(</td>

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

  1438.           <td> const</td>

  1439.         </tr>

  1440.       </table>

  1441.   </td>

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

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

  1444.   </tr>

  1445. </table>

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

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

  1448. 

  1449. </div>

  1450. </div>

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

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

  1453. 

  1454. <div class="memitem">

  1455. <div class="memproto">

  1456. <table class="mlabels">

  1457.   <tr>

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

  1459.       <table class="memname">

  1460.         <tr>

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

  1462.           <td>(</td>

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

  1464.           <td> const</td>

  1465.         </tr>

  1466.       </table>

  1467.   </td>

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

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

  1470.   </tr>

  1471. </table>

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

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

  1474. 

  1475. </div>

  1476. </div>

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

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

  1479. 

  1480. <div class="memitem">

  1481. <div class="memproto">

  1482. <table class="mlabels">

  1483.   <tr>

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

  1485.       <table class="memname">

  1486.         <tr>

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

  1488.           <td>(</td>

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

  1490.           <td></td>

  1491.         </tr>

  1492.       </table>

  1493.   </td>

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

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

  1496.   </tr>

  1497. </table>

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

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

  1500. 

  1501. </div>

  1502. </div>

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

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

  1505. 

  1506. <div class="memitem">

  1507. <div class="memproto">

  1508. <table class="mlabels">

  1509.   <tr>

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

  1511.       <table class="memname">

  1512.         <tr>

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

  1514.           <td>(</td>

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

  1516.           <td> const</td>

  1517.         </tr>

  1518.       </table>

  1519.   </td>

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

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

  1522.   </tr>

  1523. </table>

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

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

  1526. 

  1527. </div>

  1528. </div>

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

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

  1531. 

  1532. <div class="memitem">

  1533. <div class="memproto">

  1534. <table class="mlabels">

  1535.   <tr>

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

  1537.       <table class="memname">

  1538.         <tr>

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

  1540.           <td>(</td>

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

  1542.           <td> const</td>

  1543.         </tr>

  1544.       </table>

  1545.   </td>

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

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

  1548.   </tr>

  1549. </table>

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

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

  1552. 

  1553. </div>

  1554. </div>

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

  1556. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</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">uint32_t FatPartition::sectorsPerFat </td>

  1566.           <td>(</td>

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

  1568.           <td> const</td>

  1569.         </tr>

  1570.       </table>

  1571.   </td>

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

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

  1574.   </tr>

  1575. </table>

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

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

  1578. 

  1579. </div>

  1580. </div>

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

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

  1583. 

  1584. <div class="memitem">

  1585. <div class="memproto">

  1586. <table class="mlabels">

  1587.   <tr>

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

  1589.       <table class="memname">

  1590.         <tr>

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

  1592.           <td>(</td>

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

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

  1595.         </tr>

  1596.         <tr>

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

  1598.           <td></td>

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

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

  1601.         </tr>

  1602.         <tr>

  1603.           <td></td>

  1604.           <td>)</td>

  1605.           <td></td><td></td>

  1606.         </tr>

  1607.       </table>

  1608.   </td>

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

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

  1611.   </tr>

  1612. </table>

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

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

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

  1616.   <table class="params">

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

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

  1619.   </table>

  1620.   </dd>

  1621. </dl>

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

  1623. 

  1624. </div>

  1625. </div>

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

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

  1628. 

  1629. <div class="memitem">

  1630. <div class="memproto">

  1631. <table class="mlabels">

  1632.   <tr>

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

  1634.       <table class="memname">

  1635.         <tr>

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

  1637.           <td>(</td>

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

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

  1640.         </tr>

  1641.         <tr>

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

  1643.           <td></td>

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

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

  1646.         </tr>

  1647.         <tr>

  1648.           <td></td>

  1649.           <td>)</td>

  1650.           <td></td><td></td>

  1651.         </tr>

  1652.       </table>

  1653.   </td>

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

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

  1656.   </tr>

  1657. </table>

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

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

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

  1661.   <table class="params">

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

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

  1664.   </table>

  1665.   </dd>

  1666. </dl>

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

  1668. 

  1669. </div>

  1670. </div>

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

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

  1673. 

  1674. <div class="memitem">

  1675. <div class="memproto">

  1676. <table class="mlabels">

  1677.   <tr>

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

  1679.       <table class="memname">

  1680.         <tr>

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

  1682.           <td>(</td>

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

  1684.           <td> const</td>

  1685.         </tr>

  1686.       </table>

  1687.   </td>

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

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

  1690.   </tr>

  1691. </table>

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

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

  1694. 

  1695. </div>

  1696. </div>

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

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

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

  1700. </ul>

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

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

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

  1704. Generated on Mon Nov 18 2019 08:14:17 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  1706. </a> 1.8.14

  1707. </small></address>

  1708. </body>

  1709. </html>