visus
/
teensy-sdfat
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Tickets 0 Demandes d'ajout 0 Versions 0 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
31 Révisions
1 Branche
Aborescence: 080e24c4d1
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '080e24c4d1'
${ noResults }
teensy-sdfat/html/class_fat_file_system.html

1280 lines
55KB
Brut Annotations Historique 

  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><a href="modules.html"><span>Modules</span></a></li>

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for FatFileSystem:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node3" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="91,155,177,181"/>

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

  104. <area shape="rect" id="node4" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="5,237,63,263"/>

  105. <area shape="rect" id="node5" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. " alt="" coords="87,237,181,263"/>

  106. <area shape="rect" id="node6" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="205,229,367,271"/>

  107. </map>

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

  109. <div class="dynheader">

  110. Collaboration diagram for FatFileSystem:</div>

  111. <div class="dyncontent">

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

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

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

  115. </map>

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

  117. <table class="memberdecls">

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

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

  120. <tr class="memitem:a05bd3d358a708efe2f9002d05c3a4139"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a05bd3d358a708efe2f9002d05c3a4139">begin</a> (uint8_t part=0)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  188. </table>

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

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

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

  192. <a class="anchor" id="a05bd3d358a708efe2f9002d05c3a4139"></a>

  193. <div class="memitem">

  194. <div class="memproto">

  195. <table class="mlabels">

  196.   <tr>

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

  198.       <table class="memname">

  199.         <tr>

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

  201.           <td>(</td>

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

  203.           <td class="paramname"><em>part</em> = <code>0</code></td><td>)</td>

  204.           <td></td>

  205.         </tr>

  206.       </table>

  207.   </td>

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

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

  210.   </tr>

  211. </table>

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

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

  214.   <table class="params">

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

  216.   </table>

  217.   </dd>

  218. </dl>

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

  220. 

  221. </div>

  222. </div>

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

  224. <div class="memitem">

  225. <div class="memproto">

  226. <table class="mlabels">

  227.   <tr>

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

  229.       <table class="memname">

  230.         <tr>

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

  232.           <td>(</td>

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

  234.           <td> const</td>

  235.         </tr>

  236.       </table>

  237.   </td>

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

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

  240.   </tr>

  241. </table>

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

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

  244. 

  245. </div>

  246. </div>

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

  248. <div class="memitem">

  249. <div class="memproto">

  250. <table class="mlabels">

  251.   <tr>

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

  253.       <table class="memname">

  254.         <tr>

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

  256.           <td>(</td>

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

  258.           <td> const</td>

  259.         </tr>

  260.       </table>

  261.   </td>

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

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

  264.   </tr>

  265. </table>

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

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

  268. 

  269. </div>

  270. </div>

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

  272. <div class="memitem">

  273. <div class="memproto">

  274. <table class="mlabels">

  275.   <tr>

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

  277.       <table class="memname">

  278.         <tr>

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

  280.           <td>(</td>

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

  282.           <td></td>

  283.         </tr>

  284.       </table>

  285.   </td>

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

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

  288.   </tr>

  289. </table>

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

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

  292. 

  293. </div>

  294. </div>

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

  296. <div class="memitem">

  297. <div class="memproto">

  298. <table class="mlabels">

  299.   <tr>

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

  301.       <table class="memname">

  302.         <tr>

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

  304.           <td>(</td>

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

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

  307.           <td></td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

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

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

  319.   <table class="params">

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

  321.   </table>

  322.   </dd>

  323. </dl>

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

  325. 

  326. </div>

  327. </div>

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

  329. <div class="memitem">

  330. <div class="memproto">

  331. <table class="mlabels">

  332.   <tr>

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

  334.       <table class="memname">

  335.         <tr>

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

  337.           <td>(</td>

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

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

  340.         </tr>

  341.         <tr>

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

  343.           <td></td>

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

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

  346.         </tr>

  347.         <tr>

  348.           <td></td>

  349.           <td>)</td>

  350.           <td></td><td></td>

  351.         </tr>

  352.       </table>

  353.   </td>

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

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

  356.   </tr>

  357. </table>

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

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

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

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

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

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

  364.   <table class="params">

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

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

  367.   </table>

  368.   </dd>

  369. </dl>

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

  371. 

  372. </div>

  373. </div>

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

  375. <div class="memitem">

  376. <div class="memproto">

  377. <table class="mlabels">

  378.   <tr>

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

  380.       <table class="memname">

  381.         <tr>

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

  383.           <td>(</td>

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

  385.           <td></td>

  386.         </tr>

  387.       </table>

  388.   </td>

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

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

  391.   </tr>

  392. </table>

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

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

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

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

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

  398. 

  399. </div>

  400. </div>

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

  402. <div class="memitem">

  403. <div class="memproto">

  404. <table class="mlabels">

  405.   <tr>

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

  407.       <table class="memname">

  408.         <tr>

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

  410.           <td>(</td>

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

  412.           <td> const</td>

  413.         </tr>

  414.       </table>

  415.   </td>

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

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

  418.   </tr>

  419. </table>

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

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

  422. 

  423. </div>

  424. </div>

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

  426. <div class="memitem">

  427. <div class="memproto">

  428. <table class="mlabels">

  429.   <tr>

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

  431.       <table class="memname">

  432.         <tr>

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

  434.           <td>(</td>

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

  436.           <td> const</td>

  437.         </tr>

  438.       </table>

  439.   </td>

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

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

  442.   </tr>

  443. </table>

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

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

  446. 

  447. </div>

  448. </div>

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

  450. <div class="memitem">

  451. <div class="memproto">

  452. <table class="mlabels">

  453.   <tr>

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

  455.       <table class="memname">

  456.         <tr>

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

  458.           <td>(</td>

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

  460.           <td> const</td>

  461.         </tr>

  462.       </table>

  463.   </td>

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

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

  466.   </tr>

  467. </table>

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

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

  470. 

  471. </div>

  472. </div>

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

  474. <div class="memitem">

  475. <div class="memproto">

  476. <table class="mlabels">

  477.   <tr>

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

  479.       <table class="memname">

  480.         <tr>

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

  482.           <td>(</td>

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

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

  485.         </tr>

  486.         <tr>

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

  488.           <td></td>

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

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

  491.         </tr>

  492.         <tr>

  493.           <td></td>

  494.           <td>)</td>

  495.           <td></td><td></td>

  496.         </tr>

  497.       </table>

  498.   </td>

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

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

  501.   </tr>

  502. </table>

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

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

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

  506.   <table class="params">

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

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

  509.   </table>

  510.   </dd>

  511. </dl>

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

  513. 

  514. </div>

  515. </div>

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

  517. <div class="memitem">

  518. <div class="memproto">

  519. <table class="mlabels">

  520.   <tr>

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

  522.       <table class="memname">

  523.         <tr>

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

  525.           <td>(</td>

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

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

  528.           <td></td>

  529.         </tr>

  530.       </table>

  531.   </td>

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

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

  534.   </tr>

  535. </table>

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

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

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

  539.   <table class="params">

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

  541.   </table>

  542.   </dd>

  543. </dl>

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

  545. 

  546. </div>

  547. </div>

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

  549. <div class="memitem">

  550. <div class="memproto">

  551. <table class="mlabels">

  552.   <tr>

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

  554.       <table class="memname">

  555.         <tr>

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

  557.           <td>(</td>

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

  559.           <td></td>

  560.         </tr>

  561.       </table>

  562.   </td>

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

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

  565.   </tr>

  566. </table>

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

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

  569. 

  570. </div>

  571. </div>

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

  573. <div class="memitem">

  574. <div class="memproto">

  575. <table class="mlabels">

  576.   <tr>

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

  578.       <table class="memname">

  579.         <tr>

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

  581.           <td>(</td>

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

  583.           <td> const</td>

  584.         </tr>

  585.       </table>

  586.   </td>

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

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

  589.   </tr>

  590. </table>

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

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

  593. 

  594. </div>

  595. </div>

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

  597. <div class="memitem">

  598. <div class="memproto">

  599. <table class="mlabels">

  600.   <tr>

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

  602.       <table class="memname">

  603.         <tr>

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

  605.           <td>(</td>

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

  607.           <td> const</td>

  608.         </tr>

  609.       </table>

  610.   </td>

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

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

  613.   </tr>

  614. </table>

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

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

  617. 

  618. </div>

  619. </div>

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

  621. <div class="memitem">

  622. <div class="memproto">

  623. <table class="mlabels">

  624.   <tr>

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

  626.       <table class="memname">

  627.         <tr>

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

  629.           <td>(</td>

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

  631.           <td></td>

  632.         </tr>

  633.       </table>

  634.   </td>

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

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

  637.   </tr>

  638. </table>

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

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

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

  642. 

  643. </div>

  644. </div>

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

  646. <div class="memitem">

  647. <div class="memproto">

  648. <table class="mlabels">

  649.   <tr>

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

  651.       <table class="memname">

  652.         <tr>

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

  654.           <td>(</td>

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

  656.           <td></td>

  657.         </tr>

  658.       </table>

  659.   </td>

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

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

  662.   </tr>

  663. </table>

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

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

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

  667. 

  668. </div>

  669. </div>

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

  671. <div class="memitem">

  672. <div class="memproto">

  673. <table class="mlabels">

  674.   <tr>

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

  676.       <table class="memname">

  677.         <tr>

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

  679.           <td>(</td>

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

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

  682.           <td></td>

  683.         </tr>

  684.       </table>

  685.   </td>

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

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

  688.   </tr>

  689. </table>

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

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

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

  693.   <table class="params">

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

  695.   </table>

  696.   </dd>

  697. </dl>

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

  699. 

  700. </div>

  701. </div>

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

  703. <div class="memitem">

  704. <div class="memproto">

  705. <table class="mlabels">

  706.   <tr>

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

  708.       <table class="memname">

  709.         <tr>

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

  711.           <td>(</td>

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

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

  714.           <td></td>

  715.         </tr>

  716.       </table>

  717.   </td>

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

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

  720.   </tr>

  721. </table>

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

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

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

  725.   <table class="params">

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

  727.   </table>

  728.   </dd>

  729. </dl>

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

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

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

  733. 

  734. </div>

  735. </div>

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

  737. <div class="memitem">

  738. <div class="memproto">

  739. <table class="mlabels">

  740.   <tr>

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

  742.       <table class="memname">

  743.         <tr>

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

  745.           <td>(</td>

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

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

  748.         </tr>

  749.         <tr>

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

  751.           <td></td>

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

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

  754.         </tr>

  755.         <tr>

  756.           <td></td>

  757.           <td>)</td>

  758.           <td></td><td></td>

  759.         </tr>

  760.       </table>

  761.   </td>

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

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

  764.   </tr>

  765. </table>

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

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

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

  769.   <table class="params">

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

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

  772.   </table>

  773.   </dd>

  774. </dl>

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

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

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

  778. 

  779. </div>

  780. </div>

  781. <a class="anchor" id="ad17f2a0925b34cb3807e4c1677a2872f"></a>

  782. <div class="memitem">

  783. <div class="memproto">

  784. <table class="mlabels">

  785.   <tr>

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

  787.       <table class="memname">

  788.         <tr>

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

  790.           <td>(</td>

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

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

  793.         </tr>

  794.         <tr>

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

  796.           <td></td>

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

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

  799.         </tr>

  800.         <tr>

  801.           <td></td>

  802.           <td>)</td>

  803.           <td></td><td></td>

  804.         </tr>

  805.       </table>

  806.   </td>

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

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

  809.   </tr>

  810. </table>

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

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

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

  814.   <table class="params">

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

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

  817.   </table>

  818.   </dd>

  819. </dl>

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

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

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

  823. 

  824. </div>

  825. </div>

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

  827. <div class="memitem">

  828. <div class="memproto">

  829. <table class="mlabels">

  830.   <tr>

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

  832.       <table class="memname">

  833.         <tr>

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

  835.           <td>(</td>

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

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

  838.         </tr>

  839.         <tr>

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

  841.           <td></td>

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

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

  844.         </tr>

  845.         <tr>

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

  847.           <td></td>

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

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

  850.         </tr>

  851.         <tr>

  852.           <td></td>

  853.           <td>)</td>

  854.           <td></td><td></td>

  855.         </tr>

  856.       </table>

  857.   </td>

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

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

  860.   </tr>

  861. </table>

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

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

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

  865.   <table class="params">

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

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

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

  869.   </table>

  870.   </dd>

  871. </dl>

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

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

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

  875. 

  876. </div>

  877. </div>

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

  879. <div class="memitem">

  880. <div class="memproto">

  881. <table class="mlabels">

  882.   <tr>

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

  884.       <table class="memname">

  885.         <tr>

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

  887.           <td>(</td>

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

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

  890.         </tr>

  891.         <tr>

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

  893.           <td></td>

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

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

  896.         </tr>

  897.         <tr>

  898.           <td></td>

  899.           <td>)</td>

  900.           <td></td><td></td>

  901.         </tr>

  902.       </table>

  903.   </td>

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

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

  906.   </tr>

  907. </table>

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

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

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

  911.   <table class="params">

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

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

  914.   </table>

  915.   </dd>

  916. </dl>

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

  918. 

  919. </div>

  920. </div>

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

  922. <div class="memitem">

  923. <div class="memproto">

  924. <table class="mlabels">

  925.   <tr>

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

  927.       <table class="memname">

  928.         <tr>

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

  930.           <td>(</td>

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

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

  933.         </tr>

  934.         <tr>

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

  936.           <td></td>

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

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

  939.         </tr>

  940.         <tr>

  941.           <td></td>

  942.           <td>)</td>

  943.           <td></td><td></td>

  944.         </tr>

  945.       </table>

  946.   </td>

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

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

  949.   </tr>

  950. </table>

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

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

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

  954.   <table class="params">

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

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

  957.   </table>

  958.   </dd>

  959. </dl>

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

  961. 

  962. </div>

  963. </div>

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

  965. <div class="memitem">

  966. <div class="memproto">

  967. <table class="mlabels">

  968.   <tr>

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

  970.       <table class="memname">

  971.         <tr>

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

  973.           <td>(</td>

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

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

  976.           <td></td>

  977.         </tr>

  978.       </table>

  979.   </td>

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

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

  982.   </tr>

  983. </table>

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

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

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

  987.   <table class="params">

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

  989.   </table>

  990.   </dd>

  991. </dl>

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

  993. 

  994. </div>

  995. </div>

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

  997. <div class="memitem">

  998. <div class="memproto">

  999. <table class="mlabels">

  1000.   <tr>

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

  1002.       <table class="memname">

  1003.         <tr>

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

  1005.           <td>(</td>

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

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

  1008.         </tr>

  1009.         <tr>

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

  1011.           <td></td>

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

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

  1014.         </tr>

  1015.         <tr>

  1016.           <td></td>

  1017.           <td>)</td>

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

  1019.         </tr>

  1020.       </table>

  1021.   </td>

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

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

  1024.   </tr>

  1025. </table>

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

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

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

  1029.   <table class="params">

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

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

  1032.   </table>

  1033.   </dd>

  1034. </dl>

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

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

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

  1038. 

  1039. </div>

  1040. </div>

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

  1042. <div class="memitem">

  1043. <div class="memproto">

  1044. <table class="mlabels">

  1045.   <tr>

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

  1047.       <table class="memname">

  1048.         <tr>

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

  1050.           <td>(</td>

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

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

  1053.           <td></td>

  1054.         </tr>

  1055.       </table>

  1056.   </td>

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

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

  1059.   </tr>

  1060. </table>

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

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

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

  1064.   <table class="params">

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

  1066.   </table>

  1067.   </dd>

  1068. </dl>

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

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

  1071. 

  1072. </div>

  1073. </div>

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

  1075. <div class="memitem">

  1076. <div class="memproto">

  1077. <table class="mlabels">

  1078.   <tr>

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

  1080.       <table class="memname">

  1081.         <tr>

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

  1083.           <td>(</td>

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

  1085.           <td> const</td>

  1086.         </tr>

  1087.       </table>

  1088.   </td>

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

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

  1091.   </tr>

  1092. </table>

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

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

  1095. 

  1096. </div>

  1097. </div>

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

  1099. <div class="memitem">

  1100. <div class="memproto">

  1101. <table class="mlabels">

  1102.   <tr>

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

  1104.       <table class="memname">

  1105.         <tr>

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

  1107.           <td>(</td>

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

  1109.           <td> const</td>

  1110.         </tr>

  1111.       </table>

  1112.   </td>

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

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

  1115.   </tr>

  1116. </table>

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

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

  1119. 

  1120. </div>

  1121. </div>

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

  1123. <div class="memitem">

  1124. <div class="memproto">

  1125. <table class="mlabels">

  1126.   <tr>

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

  1128.       <table class="memname">

  1129.         <tr>

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

  1131.           <td>(</td>

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

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

  1134.         </tr>

  1135.         <tr>

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

  1137.           <td></td>

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

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

  1140.         </tr>

  1141.         <tr>

  1142.           <td></td>

  1143.           <td>)</td>

  1144.           <td></td><td></td>

  1145.         </tr>

  1146.       </table>

  1147.   </td>

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

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

  1150.   </tr>

  1151. </table>

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

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

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

  1155.   <table class="params">

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

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

  1158.   </table>

  1159.   </dd>

  1160. </dl>

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

  1162. 

  1163. </div>

  1164. </div>

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

  1166. <div class="memitem">

  1167. <div class="memproto">

  1168. <table class="mlabels">

  1169.   <tr>

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

  1171.       <table class="memname">

  1172.         <tr>

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

  1174.           <td>(</td>

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

  1176.           <td></td>

  1177.         </tr>

  1178.       </table>

  1179.   </td>

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

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

  1182.   </tr>

  1183. </table>

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

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

  1186. 

  1187. </div>

  1188. </div>

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

  1190. <div class="memitem">

  1191. <div class="memproto">

  1192. <table class="mlabels">

  1193.   <tr>

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

  1195.       <table class="memname">

  1196.         <tr>

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

  1198.           <td>(</td>

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

  1200.           <td> const</td>

  1201.         </tr>

  1202.       </table>

  1203.   </td>

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

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

  1206.   </tr>

  1207. </table>

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

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

  1210. 

  1211. </div>

  1212. </div>

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

  1214. <div class="memitem">

  1215. <div class="memproto">

  1216. <table class="mlabels">

  1217.   <tr>

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

  1219.       <table class="memname">

  1220.         <tr>

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

  1222.           <td>(</td>

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

  1224.           <td></td>

  1225.         </tr>

  1226.       </table>

  1227.   </td>

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

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

  1230.   </tr>

  1231. </table>

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

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

  1234. 

  1235. </div>

  1236. </div>

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

  1238. <div class="memitem">

  1239. <div class="memproto">

  1240. <table class="mlabels">

  1241.   <tr>

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

  1243.       <table class="memname">

  1244.         <tr>

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

  1246.           <td>(</td>

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

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

  1249.           <td></td>

  1250.         </tr>

  1251.       </table>

  1252.   </td>

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

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

  1255.   </tr>

  1256. </table>

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

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

  1259.   <table class="params">

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

  1261.   </table>

  1262.   </dd>

  1263. </dl>

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

  1265. 

  1266. </div>

  1267. </div>

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

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

  1270. </ul>

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

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

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

  1274. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  1276. </a> 1.8.10

  1277. </small></address>

  1278. </body>

  1279. </html>