visus
/
teensy-sdfat
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
32 коммитов
1 ветка
Дерево: 9c407b3e9f
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '9c407b3e9f'
${ noResults }
teensy-sdfat/html/class_fat_file_system.html

1338 lines
58KB
Исходник Blame История 

  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.10"/>

  7. <title>SdFat: FatFileSystem Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/searchdata.js"></script>

  13. <script type="text/javascript" src="search/search.js"></script>

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

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

  16. </script>

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  18. </head>

  19. <body>

  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  21. <div id="titlearea">

  22. <table cellspacing="0" cellpadding="0">

  23.  <tbody>

  24.  <tr style="height: 56px;">

  25.   <td id="projectalign" style="padding-left: 0.5em;">

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

  33. <!-- end header part -->

  34. <!-- Generated by Doxygen 1.8.10 -->

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

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

  37. </script>

  38.   <div id="navrow1" class="tabs">

  39.     <ul class="tablist">

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

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

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

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  65.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

  73. </div>

  74. 

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

  76. <div id="MSearchResultsWindow">

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

  78.         name="MSearchResults" id="MSearchResults">

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

  86. <a href="class_fat_file_system-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">FatFileSystem Class Reference</div>  </div>

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

  90. <div class="contents">

  91. 

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

  93.  <a href="class_fat_file_system.html#details">More...</a></p>

  94. 

  95. <p><code>#include &lt;FatFileSystem.h&gt;</code></p>

  96. <div class="dynheader">

  97. Inheritance diagram for FatFileSystem:</div>

  98. <div class="dyncontent">

  99. <div class="center"><img src="class_fat_file_system__inherit__graph.png" border="0" usemap="#_fat_file_system_inherit__map" alt="Inheritance graph"/></div>

  100. <map name="_fat_file_system_inherit__map" id="_fat_file_system_inherit__map">

  101. <area shape="rect" id="node3" href="class_sd_file_system.html" title="Virtual base class for SdFat library. " alt="" coords="301,13,511,40"/>

  102. <area shape="rect" id="node4" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriver \&gt;" alt="" coords="301,64,511,91"/>

  103. <area shape="rect" id="node7" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriverEX \&gt;" alt="" coords="293,123,519,149"/>

  104. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="5,64,91,91"/>

  105. <area shape="rect" id="node5" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="627,5,685,32"/>

  106. <area shape="rect" id="node6" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="575,57,737,98"/>

  107. <area shape="rect" id="node8" href="class_sd_fat_e_x.html" title="SdFat class with extended SD I/O. " alt="" coords="619,123,693,149"/>

  108. <area shape="rect" id="node9" href="class_sd_fat_soft_spi_e_x.html" title="SdFat class using software SPI and extended SD I/O. " alt="" coords="567,174,745,215"/>

  109. </map>

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

  111. <div class="dynheader">

  112. Collaboration diagram for FatFileSystem:</div>

  113. <div class="dyncontent">

  114. <div class="center"><img src="class_fat_file_system__coll__graph.png" border="0" usemap="#_fat_file_system_coll__map" alt="Collaboration graph"/></div>

  115. <map name="_fat_file_system_coll__map" id="_fat_file_system_coll__map">

  116. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="16,5,101,32"/>

  117. </map>

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

  119. <table class="memberdecls">

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

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

  122. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>

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

  124. <tr class="memitem:a06beed4cea5e38116b58254a57125442"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06beed4cea5e38116b58254a57125442">blocksPerCluster</a> () const </td></tr>

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

  126. <tr class="memitem:abc66d856d05198d9ebe7104c8c4155d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abc66d856d05198d9ebe7104c8c4155d7">blocksPerFat</a> () const </td></tr>

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

  128. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><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_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>

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

  130. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>

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

  132. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>

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

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

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

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

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

  138. <tr class="memitem:ac0e63f33d71d5dc95a602834274def6a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0e63f33d71d5dc95a602834274def6a">clusterSizeShift</a> () const </td></tr>

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

  140. <tr class="memitem:a443364af257c219f8e908d5b073d8fa3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a443364af257c219f8e908d5b073d8fa3">dataStartBlock</a> () const </td></tr>

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

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

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

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

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

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

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

  148. <tr class="memitem:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0dd0cc689b63ef0702aed1cf36b1722d">fatStartBlock</a> () const </td></tr>

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

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

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

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

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

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

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

  156. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>

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

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

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

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

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

  162. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>

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

  164. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>

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

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

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

  168. <tr class="memitem:a947e4586077a922892b632edac33b67a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a947e4586077a922892b632edac33b67a">open</a> (const char *path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>

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

  170. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  184. <tr class="memitem:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a4ca68fe47bb675df0a80df1ed7a53698">vol</a> ()</td></tr>

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

  186. <tr class="memitem:a07bc98088ce4a9c725700899c184f7fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a07bc98088ce4a9c725700899c184f7fc">volumeBlockCount</a> () const </td></tr>

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

  188. <tr class="memitem:acf257d02b7166683bda2abc5058004bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#acf257d02b7166683bda2abc5058004bf">vwd</a> ()</td></tr>

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

  190. <tr class="memitem:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a36d7831f92acfbfef1c4a24dd7103dc4">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>

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

  192. </table>

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

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

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

  196. <a class="anchor" id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>

  197. <div class="memitem">

  198. <div class="memproto">

  199. <table class="mlabels">

  200.   <tr>

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

  202.       <table class="memname">

  203.         <tr>

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

  205.           <td>(</td>

  206.           <td class="paramtype"><a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *&#160;</td>

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

  208.         </tr>

  209.         <tr>

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

  211.           <td></td>

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

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

  214.         </tr>

  215.         <tr>

  216.           <td></td>

  217.           <td>)</td>

  218.           <td></td><td></td>

  219.         </tr>

  220.       </table>

  221.   </td>

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

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

  224.   </tr>

  225. </table>

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

  227. <p>Initialize an <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> object. </p><dl class="params"><dt>Parameters</dt><dd>

  228.   <table class="params">

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

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

  231.   </table>

  232.   </dd>

  233. </dl>

  234. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  235. 

  236. </div>

  237. </div>

  238. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>

  239. <div class="memitem">

  240. <div class="memproto">

  241. <table class="mlabels">

  242.   <tr>

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

  244.       <table class="memname">

  245.         <tr>

  246.           <td class="memname">uint8_t FatVolume::blocksPerCluster </td>

  247.           <td>(</td>

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

  249.           <td> const</td>

  250.         </tr>

  251.       </table>

  252.   </td>

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

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

  255.   </tr>

  256. </table>

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

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

  259. 

  260. </div>

  261. </div>

  262. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>

  263. <div class="memitem">

  264. <div class="memproto">

  265. <table class="mlabels">

  266.   <tr>

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

  268.       <table class="memname">

  269.         <tr>

  270.           <td class="memname">uint32_t FatVolume::blocksPerFat </td>

  271.           <td>(</td>

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

  273.           <td> const</td>

  274.         </tr>

  275.       </table>

  276.   </td>

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

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

  279.   </tr>

  280. </table>

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

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

  283. 

  284. </div>

  285. </div>

  286. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>

  287. <div class="memitem">

  288. <div class="memproto">

  289. <table class="mlabels">

  290.   <tr>

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

  292.       <table class="memname">

  293.         <tr>

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

  295.           <td>(</td>

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

  297.           <td></td>

  298.         </tr>

  299.       </table>

  300.   </td>

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

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

  303.   </tr>

  304. </table>

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

  306. <p>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>

  307. 

  308. </div>

  309. </div>

  310. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>

  311. <div class="memitem">

  312. <div class="memproto">

  313. <table class="mlabels">

  314.   <tr>

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

  316.       <table class="memname">

  317.         <tr>

  318.           <td class="memname">bool FatFileSystem::chdir </td>

  319.           <td>(</td>

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

  321.           <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>

  322.           <td></td>

  323.         </tr>

  324.       </table>

  325.   </td>

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

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

  328.   </tr>

  329. </table>

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

  331. <p>Change a volume's working directory to root</p>

  332. <p>Changes the volume's working directory to the SD's root directory. Optionally set the current working directory to the volume's working directory.</p>

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

  334.   <table class="params">

  335.     <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>

  336.   </table>

  337.   </dd>

  338. </dl>

  339. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  340. 

  341. </div>

  342. </div>

  343. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>

  344. <div class="memitem">

  345. <div class="memproto">

  346. <table class="mlabels">

  347.   <tr>

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

  349.       <table class="memname">

  350.         <tr>

  351.           <td class="memname">bool FatFileSystem::chdir </td>

  352.           <td>(</td>

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

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

  355.         </tr>

  356.         <tr>

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

  358.           <td></td>

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

  360.           <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>

  361.         </tr>

  362.         <tr>

  363.           <td></td>

  364.           <td>)</td>

  365.           <td></td><td></td>

  366.         </tr>

  367.       </table>

  368.   </td>

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

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

  371.   </tr>

  372. </table>

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

  374. <p>Change a volume's working directory</p>

  375. <p>Changes the volume working directory to the <em>path</em> subdirectory. Optionally set the current working directory to the volume's working directory.</p>

  376. <p>Example: If the volume's working directory is "/DIR", chdir("SUB") will change the volume's working directory from "/DIR" to "/DIR/SUB".</p>

  377. <p>If path is "/", the volume's working directory will be changed to the root directory</p>

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

  379.   <table class="params">

  380.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>

  381.     <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>

  382.   </table>

  383.   </dd>

  384. </dl>

  385. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  386. 

  387. </div>

  388. </div>

  389. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>

  390. <div class="memitem">

  391. <div class="memproto">

  392. <table class="mlabels">

  393.   <tr>

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

  395.       <table class="memname">

  396.         <tr>

  397.           <td class="memname">void FatFileSystem::chvol </td>

  398.           <td>(</td>

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

  400.           <td></td>

  401.         </tr>

  402.       </table>

  403.   </td>

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

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

  406.   </tr>

  407. </table>

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

  409. <p>Set the current working directory to a volume's working directory.</p>

  410. <p>This is useful with multiple SD cards.</p>

  411. <p>The current working directory is changed to this volume's working directory.</p>

  412. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>

  413. 

  414. </div>

  415. </div>

  416. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>

  417. <div class="memitem">

  418. <div class="memproto">

  419. <table class="mlabels">

  420.   <tr>

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

  422.       <table class="memname">

  423.         <tr>

  424.           <td class="memname">uint32_t FatVolume::clusterCount </td>

  425.           <td>(</td>

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

  427.           <td> const</td>

  428.         </tr>

  429.       </table>

  430.   </td>

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

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

  433.   </tr>

  434. </table>

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

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

  437. 

  438. </div>

  439. </div>

  440. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

  448.           <td class="memname">uint8_t FatVolume::clusterSizeShift </td>

  449.           <td>(</td>

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

  451.           <td> const</td>

  452.         </tr>

  453.       </table>

  454.   </td>

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

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

  457.   </tr>

  458. </table>

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

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

  461. 

  462. </div>

  463. </div>

  464. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>

  465. <div class="memitem">

  466. <div class="memproto">

  467. <table class="mlabels">

  468.   <tr>

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

  470.       <table class="memname">

  471.         <tr>

  472.           <td class="memname">uint32_t FatVolume::dataStartBlock </td>

  473.           <td>(</td>

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

  475.           <td> const</td>

  476.         </tr>

  477.       </table>

  478.   </td>

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

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

  481.   </tr>

  482. </table>

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

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

  485. 

  486. </div>

  487. </div>

  488. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>

  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">int8_t FatVolume::dbgFat </td>

  497.           <td>(</td>

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

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

  500.         </tr>

  501.         <tr>

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

  503.           <td></td>

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

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

  506.         </tr>

  507.         <tr>

  508.           <td></td>

  509.           <td>)</td>

  510.           <td></td><td></td>

  511.         </tr>

  512.       </table>

  513.   </td>

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

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

  516.   </tr>

  517. </table>

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

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

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

  521.   <table class="params">

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

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

  524.   </table>

  525.   </dd>

  526. </dl>

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

  528. 

  529. </div>

  530. </div>

  531. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>

  532. <div class="memitem">

  533. <div class="memproto">

  534. <table class="mlabels">

  535.   <tr>

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

  537.       <table class="memname">

  538.         <tr>

  539.           <td class="memname">bool FatFileSystem::exists </td>

  540.           <td>(</td>

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

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

  543.           <td></td>

  544.         </tr>

  545.       </table>

  546.   </td>

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

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

  549.   </tr>

  550. </table>

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

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

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

  554.   <table class="params">

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

  556.   </table>

  557.   </dd>

  558. </dl>

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

  560. 

  561. </div>

  562. </div>

  563. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>

  564. <div class="memitem">

  565. <div class="memproto">

  566. <table class="mlabels">

  567.   <tr>

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

  569.       <table class="memname">

  570.         <tr>

  571.           <td class="memname">uint8_t FatVolume::fatCount </td>

  572.           <td>(</td>

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

  574.           <td></td>

  575.         </tr>

  576.       </table>

  577.   </td>

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

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

  580.   </tr>

  581. </table>

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

  583. <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Allocation Tables. </dd></dl>

  584. 

  585. </div>

  586. </div>

  587. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>

  588. <div class="memitem">

  589. <div class="memproto">

  590. <table class="mlabels">

  591.   <tr>

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

  593.       <table class="memname">

  594.         <tr>

  595.           <td class="memname">uint32_t FatVolume::fatStartBlock </td>

  596.           <td>(</td>

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

  598.           <td> const</td>

  599.         </tr>

  600.       </table>

  601.   </td>

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

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

  604.   </tr>

  605. </table>

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

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

  608. 

  609. </div>

  610. </div>

  611. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>

  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">uint8_t FatVolume::fatType </td>

  620.           <td>(</td>

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

  622.           <td> const</td>

  623.         </tr>

  624.       </table>

  625.   </td>

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

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

  628.   </tr>

  629. </table>

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

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

  632. 

  633. </div>

  634. </div>

  635. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>

  636. <div class="memitem">

  637. <div class="memproto">

  638. <table class="mlabels">

  639.   <tr>

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

  641.       <table class="memname">

  642.         <tr>

  643.           <td class="memname">int32_t FatVolume::freeClusterCount </td>

  644.           <td>(</td>

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

  646.           <td></td>

  647.         </tr>

  648.       </table>

  649.   </td>

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

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

  652.   </tr>

  653. </table>

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

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

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

  657. 

  658. </div>

  659. </div>

  660. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>

  661. <div class="memitem">

  662. <div class="memproto">

  663. <table class="mlabels">

  664.   <tr>

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

  666.       <table class="memname">

  667.         <tr>

  668.           <td class="memname">bool FatVolume::init </td>

  669.           <td>(</td>

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

  671.           <td></td>

  672.         </tr>

  673.       </table>

  674.   </td>

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

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

  677.   </tr>

  678. </table>

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

  680. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>

  681. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  682. 

  683. </div>

  684. </div>

  685. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>

  686. <div class="memitem">

  687. <div class="memproto">

  688. <table class="mlabels">

  689.   <tr>

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

  691.       <table class="memname">

  692.         <tr>

  693.           <td class="memname">bool FatVolume::init </td>

  694.           <td>(</td>

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

  696.           <td class="paramname"><em>part</em></td><td>)</td>

  697.           <td></td>

  698.         </tr>

  699.       </table>

  700.   </td>

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

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

  703.   </tr>

  704. </table>

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

  706. <p>Initialize a FAT volume.</p>

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

  708.   <table class="params">

  709.     <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 block zero.</td></tr>

  710.   </table>

  711.   </dd>

  712. </dl>

  713. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  714. 

  715. </div>

  716. </div>

  717. <a class="anchor" id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>

  718. <div class="memitem">

  719. <div class="memproto">

  720. <table class="mlabels">

  721.   <tr>

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

  723.       <table class="memname">

  724.         <tr>

  725.           <td class="memname">void FatFileSystem::ls </td>

  726.           <td>(</td>

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

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

  729.           <td></td>

  730.         </tr>

  731.       </table>

  732.   </td>

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

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

  735.   </tr>

  736. </table>

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

  738. <p>List the directory contents of the volume working directory to Serial.</p>

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

  740.   <table class="params">

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

  742.   </table>

  743.   </dd>

  744. </dl>

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

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

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

  748. 

  749. </div>

  750. </div>

  751. <a class="anchor" id="a122b61dbec5051304bcc81bc08b1b99d"></a>

  752. <div class="memitem">

  753. <div class="memproto">

  754. <table class="mlabels">

  755.   <tr>

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

  757.       <table class="memname">

  758.         <tr>

  759.           <td class="memname">void FatFileSystem::ls </td>

  760.           <td>(</td>

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

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

  763.         </tr>

  764.         <tr>

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

  766.           <td></td>

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

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

  769.         </tr>

  770.         <tr>

  771.           <td></td>

  772.           <td>)</td>

  773.           <td></td><td></td>

  774.         </tr>

  775.       </table>

  776.   </td>

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

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

  779.   </tr>

  780. </table>

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

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

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

  784.   <table class="params">

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

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

  787.   </table>

  788.   </dd>

  789. </dl>

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

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

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

  793. 

  794. </div>

  795. </div>

  796. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>

  797. <div class="memitem">

  798. <div class="memproto">

  799. <table class="mlabels">

  800.   <tr>

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

  802.       <table class="memname">

  803.         <tr>

  804.           <td class="memname">void FatFileSystem::ls </td>

  805.           <td>(</td>

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

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

  808.         </tr>

  809.         <tr>

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

  811.           <td></td>

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

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

  814.         </tr>

  815.         <tr>

  816.           <td></td>

  817.           <td>)</td>

  818.           <td></td><td></td>

  819.         </tr>

  820.       </table>

  821.   </td>

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

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

  824.   </tr>

  825. </table>

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

  827. <p>List the directory contents of the volume working directory.</p>

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

  829.   <table class="params">

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

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

  832.   </table>

  833.   </dd>

  834. </dl>

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

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

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

  838. 

  839. </div>

  840. </div>

  841. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>

  842. <div class="memitem">

  843. <div class="memproto">

  844. <table class="mlabels">

  845.   <tr>

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

  847.       <table class="memname">

  848.         <tr>

  849.           <td class="memname">void FatFileSystem::ls </td>

  850.           <td>(</td>

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

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

  853.         </tr>

  854.         <tr>

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

  856.           <td></td>

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

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

  859.         </tr>

  860.         <tr>

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

  862.           <td></td>

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

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

  865.         </tr>

  866.         <tr>

  867.           <td></td>

  868.           <td>)</td>

  869.           <td></td><td></td>

  870.         </tr>

  871.       </table>

  872.   </td>

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

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

  875.   </tr>

  876. </table>

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

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

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

  880.   <table class="params">

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

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

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

  884.   </table>

  885.   </dd>

  886. </dl>

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

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

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

  890. 

  891. </div>

  892. </div>

  893. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>

  894. <div class="memitem">

  895. <div class="memproto">

  896. <table class="mlabels">

  897.   <tr>

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

  899.       <table class="memname">

  900.         <tr>

  901.           <td class="memname">bool FatFileSystem::mkdir </td>

  902.           <td>(</td>

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

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

  905.         </tr>

  906.         <tr>

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

  908.           <td></td>

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

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

  911.         </tr>

  912.         <tr>

  913.           <td></td>

  914.           <td>)</td>

  915.           <td></td><td></td>

  916.         </tr>

  917.       </table>

  918.   </td>

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

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

  921.   </tr>

  922. </table>

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

  924. <p>Make a subdirectory in the volume working directory.</p>

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

  926.   <table class="params">

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

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

  929.   </table>

  930.   </dd>

  931. </dl>

  932. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  933. 

  934. </div>

  935. </div>

  936. <a class="anchor" id="a947e4586077a922892b632edac33b67a"></a>

  937. <div class="memitem">

  938. <div class="memproto">

  939. <table class="mlabels">

  940.   <tr>

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

  942.       <table class="memname">

  943.         <tr>

  944.           <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>

  945.           <td>(</td>

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

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

  948.         </tr>

  949.         <tr>

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

  951.           <td></td>

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

  953.           <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>

  954.         </tr>

  955.         <tr>

  956.           <td></td>

  957.           <td>)</td>

  958.           <td></td><td></td>

  959.         </tr>

  960.       </table>

  961.   </td>

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

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

  964.   </tr>

  965. </table>

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

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

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

  969.   <table class="params">

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

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

  972.   </table>

  973.   </dd>

  974. </dl>

  975. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>

  976. 

  977. </div>

  978. </div>

  979. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>

  980. <div class="memitem">

  981. <div class="memproto">

  982. <table class="mlabels">

  983.   <tr>

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

  985.       <table class="memname">

  986.         <tr>

  987.           <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>

  988.           <td>(</td>

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

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

  991.         </tr>

  992.         <tr>

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

  994.           <td></td>

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

  996.           <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>

  997.         </tr>

  998.         <tr>

  999.           <td></td>

  1000.           <td>)</td>

  1001.           <td></td><td></td>

  1002.         </tr>

  1003.       </table>

  1004.   </td>

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

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

  1007.   </tr>

  1008. </table>

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

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

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

  1012.   <table class="params">

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

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

  1015.   </table>

  1016.   </dd>

  1017. </dl>

  1018. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>

  1019. 

  1020. </div>

  1021. </div>

  1022. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>

  1023. <div class="memitem">

  1024. <div class="memproto">

  1025. <table class="mlabels">

  1026.   <tr>

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

  1028.       <table class="memname">

  1029.         <tr>

  1030.           <td class="memname">bool FatFileSystem::remove </td>

  1031.           <td>(</td>

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

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

  1034.           <td></td>

  1035.         </tr>

  1036.       </table>

  1037.   </td>

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

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

  1040.   </tr>

  1041. </table>

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

  1043. <p>Remove a file from the volume working directory.</p>

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

  1045.   <table class="params">

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

  1047.   </table>

  1048.   </dd>

  1049. </dl>

  1050. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1051. 

  1052. </div>

  1053. </div>

  1054. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>

  1055. <div class="memitem">

  1056. <div class="memproto">

  1057. <table class="mlabels">

  1058.   <tr>

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

  1060.       <table class="memname">

  1061.         <tr>

  1062.           <td class="memname">bool FatFileSystem::rename </td>

  1063.           <td>(</td>

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

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

  1066.         </tr>

  1067.         <tr>

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

  1069.           <td></td>

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

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

  1072.         </tr>

  1073.         <tr>

  1074.           <td></td>

  1075.           <td>)</td>

  1076.           <td></td><td></td>

  1077.         </tr>

  1078.       </table>

  1079.   </td>

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

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

  1082.   </tr>

  1083. </table>

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

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

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

  1087.   <table class="params">

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

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

  1090.   </table>

  1091.   </dd>

  1092. </dl>

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

  1094. <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_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename()</a> call.</p>

  1095. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1096. 

  1097. </div>

  1098. </div>

  1099. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>

  1100. <div class="memitem">

  1101. <div class="memproto">

  1102. <table class="mlabels">

  1103.   <tr>

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

  1105.       <table class="memname">

  1106.         <tr>

  1107.           <td class="memname">bool FatFileSystem::rmdir </td>

  1108.           <td>(</td>

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

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

  1111.           <td></td>

  1112.         </tr>

  1113.       </table>

  1114.   </td>

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

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

  1117.   </tr>

  1118. </table>

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

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

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

  1122.   <table class="params">

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

  1124.   </table>

  1125.   </dd>

  1126. </dl>

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

  1128. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1129. 

  1130. </div>

  1131. </div>

  1132. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>

  1133. <div class="memitem">

  1134. <div class="memproto">

  1135. <table class="mlabels">

  1136.   <tr>

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

  1138.       <table class="memname">

  1139.         <tr>

  1140.           <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>

  1141.           <td>(</td>

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

  1143.           <td> const</td>

  1144.         </tr>

  1145.       </table>

  1146.   </td>

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

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

  1149.   </tr>

  1150. </table>

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

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

  1153. 

  1154. </div>

  1155. </div>

  1156. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>

  1157. <div class="memitem">

  1158. <div class="memproto">

  1159. <table class="mlabels">

  1160.   <tr>

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

  1162.       <table class="memname">

  1163.         <tr>

  1164.           <td class="memname">uint32_t FatVolume::rootDirStart </td>

  1165.           <td>(</td>

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

  1167.           <td> const</td>

  1168.         </tr>

  1169.       </table>

  1170.   </td>

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

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

  1173.   </tr>

  1174. </table>

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

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

  1177. 

  1178. </div>

  1179. </div>

  1180. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>

  1181. <div class="memitem">

  1182. <div class="memproto">

  1183. <table class="mlabels">

  1184.   <tr>

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

  1186.       <table class="memname">

  1187.         <tr>

  1188.           <td class="memname">bool FatFileSystem::truncate </td>

  1189.           <td>(</td>

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

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

  1192.         </tr>

  1193.         <tr>

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

  1195.           <td></td>

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

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

  1198.         </tr>

  1199.         <tr>

  1200.           <td></td>

  1201.           <td>)</td>

  1202.           <td></td><td></td>

  1203.         </tr>

  1204.       </table>

  1205.   </td>

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

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

  1208.   </tr>

  1209. </table>

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

  1211. <p>Truncate a file to a specified length. The current file position will be maintained if it is less than or equal to <em>length</em> otherwise it will be set to end of file.</p>

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

  1213.   <table class="params">

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

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

  1216.   </table>

  1217.   </dd>

  1218. </dl>

  1219. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1220. 

  1221. </div>

  1222. </div>

  1223. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>

  1224. <div class="memitem">

  1225. <div class="memproto">

  1226. <table class="mlabels">

  1227.   <tr>

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

  1229.       <table class="memname">

  1230.         <tr>

  1231.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>

  1232.           <td>(</td>

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

  1234.           <td></td>

  1235.         </tr>

  1236.       </table>

  1237.   </td>

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

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

  1240.   </tr>

  1241. </table>

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

  1243. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> object. </dd></dl>

  1244. 

  1245. </div>

  1246. </div>

  1247. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>

  1248. <div class="memitem">

  1249. <div class="memproto">

  1250. <table class="mlabels">

  1251.   <tr>

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

  1253.       <table class="memname">

  1254.         <tr>

  1255.           <td class="memname">uint32_t FatVolume::volumeBlockCount </td>

  1256.           <td>(</td>

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

  1258.           <td> const</td>

  1259.         </tr>

  1260.       </table>

  1261.   </td>

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

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

  1264.   </tr>

  1265. </table>

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

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

  1268. 

  1269. </div>

  1270. </div>

  1271. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>

  1272. <div class="memitem">

  1273. <div class="memproto">

  1274. <table class="mlabels">

  1275.   <tr>

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

  1277.       <table class="memname">

  1278.         <tr>

  1279.           <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>

  1280.           <td>(</td>

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

  1282.           <td></td>

  1283.         </tr>

  1284.       </table>

  1285.   </td>

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

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

  1288.   </tr>

  1289. </table>

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

  1291. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  1292. 

  1293. </div>

  1294. </div>

  1295. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>

  1296. <div class="memitem">

  1297. <div class="memproto">

  1298. <table class="mlabels">

  1299.   <tr>

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

  1301.       <table class="memname">

  1302.         <tr>

  1303.           <td class="memname">bool FatFileSystem::wipe </td>

  1304.           <td>(</td>

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

  1306.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  1307.           <td></td>

  1308.         </tr>

  1309.       </table>

  1310.   </td>

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

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

  1313.   </tr>

  1314. </table>

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

  1316. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>

  1317.   <table class="params">

  1318.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  1319.   </table>

  1320.   </dd>

  1321. </dl>

  1322. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  1323. 

  1324. </div>

  1325. </div>

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

  1327. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_system_8h.html">FatFileSystem.h</a></li>

  1328. </ul>

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

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

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

  1332. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  1334. </a> 1.8.10

  1335. </small></address>

  1336. </body>

  1337. </html>