visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 Commits
1 Branch
Tree: 7871875f5c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/class_fat_file_system.html

1340 lines
58KB
Raw Blame History 

  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="293,5,503,32"/>

  102. <area shape="rect" id="node4" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdioCard \&gt;" alt="" coords="307,56,489,83"/>

  103. <area shape="rect" id="node6" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCard \&gt;" alt="" coords="303,107,493,133"/>

  104. <area shape="rect" id="node9" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCardEX \&gt;" alt="" coords="295,195,501,221"/>

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

  106. <area shape="rect" id="node5" href="class_sd_fat_sdio.html" title="SdFat class using SDIO. " alt="" coords="599,27,681,53"/>

  107. <area shape="rect" id="node7" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="611,77,669,104"/>

  108. <area shape="rect" id="node8" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="559,129,721,170"/>

  109. <area shape="rect" id="node10" href="class_sd_fat_e_x.html" title="SdFat class with extended SD I/O. " alt="" coords="603,195,677,221"/>

  110. <area shape="rect" id="node11" href="class_sd_fat_soft_spi_e_x.html" title="SdFat class using software SPI and extended SD I/O. " alt="" coords="551,246,729,287"/>

  111. </map>

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

  113. <div class="dynheader">

  114. Collaboration diagram for FatFileSystem:</div>

  115. <div class="dyncontent">

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

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

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

  119. </map>

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

  121. <table class="memberdecls">

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

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

  124. <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#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  194. </table>

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

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

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

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

  199. <div class="memitem">

  200. <div class="memproto">

  201. <table class="mlabels">

  202.   <tr>

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

  204.       <table class="memname">

  205.         <tr>

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

  207.           <td>(</td>

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

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

  210.         </tr>

  211.         <tr>

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

  213.           <td></td>

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

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

  216.         </tr>

  217.         <tr>

  218.           <td></td>

  219.           <td>)</td>

  220.           <td></td><td></td>

  221.         </tr>

  222.       </table>

  223.   </td>

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

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

  226.   </tr>

  227. </table>

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

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

  230.   <table class="params">

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

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

  233.   </table>

  234.   </dd>

  235. </dl>

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

  237. 

  238. </div>

  239. </div>

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

  241. <div class="memitem">

  242. <div class="memproto">

  243. <table class="mlabels">

  244.   <tr>

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

  246.       <table class="memname">

  247.         <tr>

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

  249.           <td>(</td>

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

  251.           <td> const</td>

  252.         </tr>

  253.       </table>

  254.   </td>

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

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

  257.   </tr>

  258. </table>

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

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

  261. 

  262. </div>

  263. </div>

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

  265. <div class="memitem">

  266. <div class="memproto">

  267. <table class="mlabels">

  268.   <tr>

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

  270.       <table class="memname">

  271.         <tr>

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

  273.           <td>(</td>

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

  275.           <td> const</td>

  276.         </tr>

  277.       </table>

  278.   </td>

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

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

  281.   </tr>

  282. </table>

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

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

  285. 

  286. </div>

  287. </div>

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

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

  299.           <td></td>

  300.         </tr>

  301.       </table>

  302.   </td>

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

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

  305.   </tr>

  306. </table>

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

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

  309. 

  310. </div>

  311. </div>

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

  313. <div class="memitem">

  314. <div class="memproto">

  315. <table class="mlabels">

  316.   <tr>

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

  318.       <table class="memname">

  319.         <tr>

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

  321.           <td>(</td>

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

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

  324.           <td></td>

  325.         </tr>

  326.       </table>

  327.   </td>

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

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

  330.   </tr>

  331. </table>

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

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

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

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

  336.   <table class="params">

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

  338.   </table>

  339.   </dd>

  340. </dl>

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

  342. 

  343. </div>

  344. </div>

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

  346. <div class="memitem">

  347. <div class="memproto">

  348. <table class="mlabels">

  349.   <tr>

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

  351.       <table class="memname">

  352.         <tr>

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

  354.           <td>(</td>

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

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

  357.         </tr>

  358.         <tr>

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

  360.           <td></td>

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

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

  363.         </tr>

  364.         <tr>

  365.           <td></td>

  366.           <td>)</td>

  367.           <td></td><td></td>

  368.         </tr>

  369.       </table>

  370.   </td>

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

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

  373.   </tr>

  374. </table>

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

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

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

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

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

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

  381.   <table class="params">

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

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

  384.   </table>

  385.   </dd>

  386. </dl>

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

  388. 

  389. </div>

  390. </div>

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

  392. <div class="memitem">

  393. <div class="memproto">

  394. <table class="mlabels">

  395.   <tr>

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

  397.       <table class="memname">

  398.         <tr>

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

  400.           <td>(</td>

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

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405.   </td>

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

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

  408.   </tr>

  409. </table>

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

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

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

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

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

  415. 

  416. </div>

  417. </div>

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

  419. <div class="memitem">

  420. <div class="memproto">

  421. <table class="mlabels">

  422.   <tr>

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

  424.       <table class="memname">

  425.         <tr>

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

  427.           <td>(</td>

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

  429.           <td> const</td>

  430.         </tr>

  431.       </table>

  432.   </td>

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

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

  435.   </tr>

  436. </table>

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

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

  439. 

  440. </div>

  441. </div>

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

  443. <div class="memitem">

  444. <div class="memproto">

  445. <table class="mlabels">

  446.   <tr>

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

  448.       <table class="memname">

  449.         <tr>

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

  451.           <td>(</td>

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

  453.           <td> const</td>

  454.         </tr>

  455.       </table>

  456.   </td>

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

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

  459.   </tr>

  460. </table>

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

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

  463. 

  464. </div>

  465. </div>

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

  467. <div class="memitem">

  468. <div class="memproto">

  469. <table class="mlabels">

  470.   <tr>

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

  472.       <table class="memname">

  473.         <tr>

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

  475.           <td>(</td>

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

  477.           <td> const</td>

  478.         </tr>

  479.       </table>

  480.   </td>

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

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

  483.   </tr>

  484. </table>

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

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

  487. 

  488. </div>

  489. </div>

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

  491. <div class="memitem">

  492. <div class="memproto">

  493. <table class="mlabels">

  494.   <tr>

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

  496.       <table class="memname">

  497.         <tr>

  498.           <td class="memname">int8_t FatVolume::dbgFat </td>

  499.           <td>(</td>

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

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

  502.         </tr>

  503.         <tr>

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

  505.           <td></td>

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

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

  508.         </tr>

  509.         <tr>

  510.           <td></td>

  511.           <td>)</td>

  512.           <td></td><td></td>

  513.         </tr>

  514.       </table>

  515.   </td>

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

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

  518.   </tr>

  519. </table>

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

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

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

  523.   <table class="params">

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

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

  526.   </table>

  527.   </dd>

  528. </dl>

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

  530. 

  531. </div>

  532. </div>

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

  534. <div class="memitem">

  535. <div class="memproto">

  536. <table class="mlabels">

  537.   <tr>

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

  539.       <table class="memname">

  540.         <tr>

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

  542.           <td>(</td>

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

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

  545.           <td></td>

  546.         </tr>

  547.       </table>

  548.   </td>

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

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

  551.   </tr>

  552. </table>

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

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

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

  556.   <table class="params">

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

  558.   </table>

  559.   </dd>

  560. </dl>

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

  562. 

  563. </div>

  564. </div>

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

  566. <div class="memitem">

  567. <div class="memproto">

  568. <table class="mlabels">

  569.   <tr>

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

  571.       <table class="memname">

  572.         <tr>

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

  574.           <td>(</td>

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

  576.           <td></td>

  577.         </tr>

  578.       </table>

  579.   </td>

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

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

  582.   </tr>

  583. </table>

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

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

  586. 

  587. </div>

  588. </div>

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

  590. <div class="memitem">

  591. <div class="memproto">

  592. <table class="mlabels">

  593.   <tr>

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

  595.       <table class="memname">

  596.         <tr>

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

  598.           <td>(</td>

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

  600.           <td> const</td>

  601.         </tr>

  602.       </table>

  603.   </td>

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

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

  606.   </tr>

  607. </table>

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

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

  610. 

  611. </div>

  612. </div>

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

  614. <div class="memitem">

  615. <div class="memproto">

  616. <table class="mlabels">

  617.   <tr>

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

  619.       <table class="memname">

  620.         <tr>

  621.           <td class="memname">uint8_t FatVolume::fatType </td>

  622.           <td>(</td>

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

  624.           <td> const</td>

  625.         </tr>

  626.       </table>

  627.   </td>

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

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

  630.   </tr>

  631. </table>

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

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

  634. 

  635. </div>

  636. </div>

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

  638. <div class="memitem">

  639. <div class="memproto">

  640. <table class="mlabels">

  641.   <tr>

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

  643.       <table class="memname">

  644.         <tr>

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

  646.           <td>(</td>

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

  648.           <td></td>

  649.         </tr>

  650.       </table>

  651.   </td>

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

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

  654.   </tr>

  655. </table>

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

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

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

  659. 

  660. </div>

  661. </div>

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

  663. <div class="memitem">

  664. <div class="memproto">

  665. <table class="mlabels">

  666.   <tr>

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

  668.       <table class="memname">

  669.         <tr>

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

  671.           <td>(</td>

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

  673.           <td></td>

  674.         </tr>

  675.       </table>

  676.   </td>

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

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

  679.   </tr>

  680. </table>

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

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

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

  684. 

  685. </div>

  686. </div>

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

  688. <div class="memitem">

  689. <div class="memproto">

  690. <table class="mlabels">

  691.   <tr>

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

  693.       <table class="memname">

  694.         <tr>

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

  696.           <td>(</td>

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

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

  699.           <td></td>

  700.         </tr>

  701.       </table>

  702.   </td>

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

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

  705.   </tr>

  706. </table>

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

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

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

  710.   <table class="params">

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

  712.   </table>

  713.   </dd>

  714. </dl>

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

  716. 

  717. </div>

  718. </div>

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

  720. <div class="memitem">

  721. <div class="memproto">

  722. <table class="mlabels">

  723.   <tr>

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

  725.       <table class="memname">

  726.         <tr>

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

  728.           <td>(</td>

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

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

  731.           <td></td>

  732.         </tr>

  733.       </table>

  734.   </td>

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

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

  737.   </tr>

  738. </table>

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

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

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

  742.   <table class="params">

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

  744.   </table>

  745.   </dd>

  746. </dl>

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

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

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

  750. 

  751. </div>

  752. </div>

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

  754. <div class="memitem">

  755. <div class="memproto">

  756. <table class="mlabels">

  757.   <tr>

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

  759.       <table class="memname">

  760.         <tr>

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

  762.           <td>(</td>

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

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

  765.         </tr>

  766.         <tr>

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

  768.           <td></td>

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

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

  771.         </tr>

  772.         <tr>

  773.           <td></td>

  774.           <td>)</td>

  775.           <td></td><td></td>

  776.         </tr>

  777.       </table>

  778.   </td>

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

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

  781.   </tr>

  782. </table>

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

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

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

  786.   <table class="params">

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

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

  789.   </table>

  790.   </dd>

  791. </dl>

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

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

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

  795. 

  796. </div>

  797. </div>

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

  799. <div class="memitem">

  800. <div class="memproto">

  801. <table class="mlabels">

  802.   <tr>

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

  804.       <table class="memname">

  805.         <tr>

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

  807.           <td>(</td>

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

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

  810.         </tr>

  811.         <tr>

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

  813.           <td></td>

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

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

  816.         </tr>

  817.         <tr>

  818.           <td></td>

  819.           <td>)</td>

  820.           <td></td><td></td>

  821.         </tr>

  822.       </table>

  823.   </td>

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

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

  826.   </tr>

  827. </table>

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

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

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

  831.   <table class="params">

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

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

  834.   </table>

  835.   </dd>

  836. </dl>

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

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

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

  840. 

  841. </div>

  842. </div>

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

  844. <div class="memitem">

  845. <div class="memproto">

  846. <table class="mlabels">

  847.   <tr>

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

  849.       <table class="memname">

  850.         <tr>

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

  852.           <td>(</td>

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

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

  855.         </tr>

  856.         <tr>

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

  858.           <td></td>

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

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

  861.         </tr>

  862.         <tr>

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

  864.           <td></td>

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

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

  867.         </tr>

  868.         <tr>

  869.           <td></td>

  870.           <td>)</td>

  871.           <td></td><td></td>

  872.         </tr>

  873.       </table>

  874.   </td>

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

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

  877.   </tr>

  878. </table>

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

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

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

  882.   <table class="params">

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

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

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

  886.   </table>

  887.   </dd>

  888. </dl>

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

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

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

  892. 

  893. </div>

  894. </div>

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

  896. <div class="memitem">

  897. <div class="memproto">

  898. <table class="mlabels">

  899.   <tr>

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

  901.       <table class="memname">

  902.         <tr>

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

  904.           <td>(</td>

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

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

  907.         </tr>

  908.         <tr>

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

  910.           <td></td>

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

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

  913.         </tr>

  914.         <tr>

  915.           <td></td>

  916.           <td>)</td>

  917.           <td></td><td></td>

  918.         </tr>

  919.       </table>

  920.   </td>

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

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

  923.   </tr>

  924. </table>

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

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

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

  928.   <table class="params">

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

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

  931.   </table>

  932.   </dd>

  933. </dl>

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

  935. 

  936. </div>

  937. </div>

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

  939. <div class="memitem">

  940. <div class="memproto">

  941. <table class="mlabels">

  942.   <tr>

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

  944.       <table class="memname">

  945.         <tr>

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

  947.           <td>(</td>

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

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

  950.         </tr>

  951.         <tr>

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

  953.           <td></td>

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

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

  956.         </tr>

  957.         <tr>

  958.           <td></td>

  959.           <td>)</td>

  960.           <td></td><td></td>

  961.         </tr>

  962.       </table>

  963.   </td>

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

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

  966.   </tr>

  967. </table>

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

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

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

  971.   <table class="params">

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

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

  974.   </table>

  975.   </dd>

  976. </dl>

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

  978. 

  979. </div>

  980. </div>

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

  982. <div class="memitem">

  983. <div class="memproto">

  984. <table class="mlabels">

  985.   <tr>

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

  987.       <table class="memname">

  988.         <tr>

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

  990.           <td>(</td>

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

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

  993.         </tr>

  994.         <tr>

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

  996.           <td></td>

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

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

  999.         </tr>

  1000.         <tr>

  1001.           <td></td>

  1002.           <td>)</td>

  1003.           <td></td><td></td>

  1004.         </tr>

  1005.       </table>

  1006.   </td>

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

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

  1009.   </tr>

  1010. </table>

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

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

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

  1014.   <table class="params">

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

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

  1017.   </table>

  1018.   </dd>

  1019. </dl>

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

  1021. 

  1022. </div>

  1023. </div>

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

  1025. <div class="memitem">

  1026. <div class="memproto">

  1027. <table class="mlabels">

  1028.   <tr>

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

  1030.       <table class="memname">

  1031.         <tr>

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

  1033.           <td>(</td>

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

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

  1036.           <td></td>

  1037.         </tr>

  1038.       </table>

  1039.   </td>

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

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

  1042.   </tr>

  1043. </table>

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

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

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

  1047.   <table class="params">

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

  1049.   </table>

  1050.   </dd>

  1051. </dl>

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

  1053. 

  1054. </div>

  1055. </div>

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

  1057. <div class="memitem">

  1058. <div class="memproto">

  1059. <table class="mlabels">

  1060.   <tr>

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

  1062.       <table class="memname">

  1063.         <tr>

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

  1065.           <td>(</td>

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

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

  1068.         </tr>

  1069.         <tr>

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

  1071.           <td></td>

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

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

  1074.         </tr>

  1075.         <tr>

  1076.           <td></td>

  1077.           <td>)</td>

  1078.           <td></td><td></td>

  1079.         </tr>

  1080.       </table>

  1081.   </td>

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

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

  1084.   </tr>

  1085. </table>

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

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

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

  1089.   <table class="params">

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

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

  1092.   </table>

  1093.   </dd>

  1094. </dl>

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

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

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

  1098. 

  1099. </div>

  1100. </div>

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

  1102. <div class="memitem">

  1103. <div class="memproto">

  1104. <table class="mlabels">

  1105.   <tr>

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

  1107.       <table class="memname">

  1108.         <tr>

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

  1110.           <td>(</td>

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

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

  1113.           <td></td>

  1114.         </tr>

  1115.       </table>

  1116.   </td>

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

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

  1119.   </tr>

  1120. </table>

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

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

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

  1124.   <table class="params">

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

  1126.   </table>

  1127.   </dd>

  1128. </dl>

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

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

  1131. 

  1132. </div>

  1133. </div>

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

  1135. <div class="memitem">

  1136. <div class="memproto">

  1137. <table class="mlabels">

  1138.   <tr>

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

  1140.       <table class="memname">

  1141.         <tr>

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

  1143.           <td>(</td>

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

  1145.           <td> const</td>

  1146.         </tr>

  1147.       </table>

  1148.   </td>

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

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

  1151.   </tr>

  1152. </table>

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

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

  1155. 

  1156. </div>

  1157. </div>

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

  1159. <div class="memitem">

  1160. <div class="memproto">

  1161. <table class="mlabels">

  1162.   <tr>

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

  1164.       <table class="memname">

  1165.         <tr>

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

  1167.           <td>(</td>

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

  1169.           <td> const</td>

  1170.         </tr>

  1171.       </table>

  1172.   </td>

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

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

  1175.   </tr>

  1176. </table>

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

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

  1179. 

  1180. </div>

  1181. </div>

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

  1183. <div class="memitem">

  1184. <div class="memproto">

  1185. <table class="mlabels">

  1186.   <tr>

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

  1188.       <table class="memname">

  1189.         <tr>

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

  1191.           <td>(</td>

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

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

  1194.         </tr>

  1195.         <tr>

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

  1197.           <td></td>

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

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

  1200.         </tr>

  1201.         <tr>

  1202.           <td></td>

  1203.           <td>)</td>

  1204.           <td></td><td></td>

  1205.         </tr>

  1206.       </table>

  1207.   </td>

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

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

  1210.   </tr>

  1211. </table>

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

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

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

  1215.   <table class="params">

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

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

  1218.   </table>

  1219.   </dd>

  1220. </dl>

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

  1222. 

  1223. </div>

  1224. </div>

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

  1226. <div class="memitem">

  1227. <div class="memproto">

  1228. <table class="mlabels">

  1229.   <tr>

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

  1231.       <table class="memname">

  1232.         <tr>

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

  1234.           <td>(</td>

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

  1236.           <td></td>

  1237.         </tr>

  1238.       </table>

  1239.   </td>

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

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

  1242.   </tr>

  1243. </table>

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

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

  1246. 

  1247. </div>

  1248. </div>

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

  1250. <div class="memitem">

  1251. <div class="memproto">

  1252. <table class="mlabels">

  1253.   <tr>

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

  1255.       <table class="memname">

  1256.         <tr>

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

  1258.           <td>(</td>

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

  1260.           <td> const</td>

  1261.         </tr>

  1262.       </table>

  1263.   </td>

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

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

  1266.   </tr>

  1267. </table>

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

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

  1270. 

  1271. </div>

  1272. </div>

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

  1274. <div class="memitem">

  1275. <div class="memproto">

  1276. <table class="mlabels">

  1277.   <tr>

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

  1279.       <table class="memname">

  1280.         <tr>

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

  1282.           <td>(</td>

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

  1284.           <td></td>

  1285.         </tr>

  1286.       </table>

  1287.   </td>

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

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

  1290.   </tr>

  1291. </table>

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

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

  1294. 

  1295. </div>

  1296. </div>

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

  1298. <div class="memitem">

  1299. <div class="memproto">

  1300. <table class="mlabels">

  1301.   <tr>

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

  1303.       <table class="memname">

  1304.         <tr>

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

  1306.           <td>(</td>

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

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

  1309.           <td></td>

  1310.         </tr>

  1311.       </table>

  1312.   </td>

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

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

  1315.   </tr>

  1316. </table>

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

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

  1319.   <table class="params">

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

  1321.   </table>

  1322.   </dd>

  1323. </dl>

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

  1325. 

  1326. </div>

  1327. </div>

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

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

  1330. </ul>

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

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

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

  1334. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  1336. </a> 1.8.10

  1337. </small></address>

  1338. </body>

  1339. </html>