visus
/
teensy-sdfat
Observar 1
Favorito 0
Fork 0
Código Issues 0 Pull requests 0 Versões 0 Wiki Atividade
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
17 Commits
1 Branch
Tag: 86ead52563
Branches Tags
${ item.name }
Criar branch ${ searchTerm }
de 86ead52563
${ noResults }
teensy-sdfat/html/class_fat_file_system.html

1273 linhas
56KB
Original Anotar Histórico 

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

  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/search.js"></script>

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

  40.       <li><a href="modules.html"><span>Modules</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. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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="node5" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="90,155,176,181"/>
<area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="91,5,176,32"/>
<area shape="rect" id="node7" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="5,237,61,264"/>
<area shape="rect" id="node9" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. " alt="" coords="87,237,180,264"/>
<area shape="rect" id="node11" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="204,230,367,271"/>
</map>

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

  103. <div class="dynheader">

  104. Collaboration diagram for FatFileSystem:</div>

  105. <div class="dyncontent">

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

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

  108. <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"/>
</map>

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

  110. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  181. </table>

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

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

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

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

  186. <div class="memitem">

  187. <div class="memproto">

  188. <table class="mlabels">

  189.   <tr>

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

  191.       <table class="memname">

  192.         <tr>

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

  194.           <td>(</td>

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

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

  197.           <td></td>

  198.         </tr>

  199.       </table>

  200.   </td>

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

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

  203.   </tr>

  204. </table>

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

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

  207.   <table class="params">

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

  209.   </table>

  210.   </dd>

  211. </dl>

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

  213. 

  214. </div>

  215. </div>

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

  217. <div class="memitem">

  218. <div class="memproto">

  219. <table class="mlabels">

  220.   <tr>

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

  222.       <table class="memname">

  223.         <tr>

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

  225.           <td>(</td>

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

  227.           <td> const</td>

  228.         </tr>

  229.       </table>

  230.   </td>

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

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

  233.   </tr>

  234. </table>

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

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

  237. 

  238. </div>

  239. </div>

  240. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></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">uint32_t FatVolume::blocksPerFat </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 number of blocks in one FAT. </dd></dl>

  261. 

  262. </div>

  263. </div>

  264. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></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"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>

  273.           <td>(</td>

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

  275.           <td></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. <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>

  285. 

  286. </div>

  287. </div>

  288. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></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">bool FatFileSystem::chdir </td>

  297.           <td>(</td>

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

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

  300.           <td></td>

  301.         </tr>

  302.       </table>

  303.   </td>

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

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

  306.   </tr>

  307. </table>

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

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

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

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

  312.   <table class="params">

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

  314.   </table>

  315.   </dd>

  316. </dl>

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

  318. 

  319. </div>

  320. </div>

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

  322. <div class="memitem">

  323. <div class="memproto">

  324. <table class="mlabels">

  325.   <tr>

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

  327.       <table class="memname">

  328.         <tr>

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

  330.           <td>(</td>

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

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

  333.         </tr>

  334.         <tr>

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

  336.           <td></td>

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

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

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

  346.   </td>

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

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

  349.   </tr>

  350. </table>

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

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

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

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

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

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

  357.   <table class="params">

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

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

  360.   </table>

  361.   </dd>

  362. </dl>

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

  364. 

  365. </div>

  366. </div>

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

  368. <div class="memitem">

  369. <div class="memproto">

  370. <table class="mlabels">

  371.   <tr>

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

  373.       <table class="memname">

  374.         <tr>

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

  376.           <td>(</td>

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

  378.           <td></td>

  379.         </tr>

  380.       </table>

  381.   </td>

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

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

  384.   </tr>

  385. </table>

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

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

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

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

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

  391. 

  392. </div>

  393. </div>

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

  395. <div class="memitem">

  396. <div class="memproto">

  397. <table class="mlabels">

  398.   <tr>

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

  400.       <table class="memname">

  401.         <tr>

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

  403.           <td>(</td>

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

  405.           <td> const</td>

  406.         </tr>

  407.       </table>

  408.   </td>

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

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

  411.   </tr>

  412. </table>

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

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

  415. 

  416. </div>

  417. </div>

  418. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></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">uint8_t FatVolume::clusterSizeShift </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 shift count required to multiply by blocksPerCluster. </dd></dl>

  439. 

  440. </div>

  441. </div>

  442. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></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">uint32_t FatVolume::dataStartBlock </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 logical block number for the start of file data. </dd></dl>

  463. 

  464. </div>

  465. </div>

  466. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></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">int8_t FatVolume::dbgFat </td>

  475.           <td>(</td>

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

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

  478.         </tr>

  479.         <tr>

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

  481.           <td></td>

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

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

  484.         </tr>

  485.         <tr>

  486.           <td></td>

  487.           <td>)</td>

  488.           <td></td><td></td>

  489.         </tr>

  490.       </table>

  491.   </td>

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

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

  494.   </tr>

  495. </table>

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

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

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

  499.   <table class="params">

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

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

  502.   </table>

  503.   </dd>

  504. </dl>

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

  506. 

  507. </div>

  508. </div>

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

  510. <div class="memitem">

  511. <div class="memproto">

  512. <table class="mlabels">

  513.   <tr>

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

  515.       <table class="memname">

  516.         <tr>

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

  518.           <td>(</td>

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

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

  521.           <td></td>

  522.         </tr>

  523.       </table>

  524.   </td>

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

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

  527.   </tr>

  528. </table>

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

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

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

  532.   <table class="params">

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

  534.   </table>

  535.   </dd>

  536. </dl>

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

  538. 

  539. </div>

  540. </div>

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

  542. <div class="memitem">

  543. <div class="memproto">

  544. <table class="mlabels">

  545.   <tr>

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

  547.       <table class="memname">

  548.         <tr>

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

  550.           <td>(</td>

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

  552.           <td></td>

  553.         </tr>

  554.       </table>

  555.   </td>

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

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

  558.   </tr>

  559. </table>

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

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

  562. 

  563. </div>

  564. </div>

  565. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></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">uint32_t FatVolume::fatStartBlock </td>

  574.           <td>(</td>

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

  576.           <td> const</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 logical block number for the start of the first FAT. </dd></dl>

  586. 

  587. </div>

  588. </div>

  589. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></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">uint8_t FatVolume::fatType </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 FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  610. 

  611. </div>

  612. </div>

  613. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></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">int32_t FatVolume::freeClusterCount </td>

  622.           <td>(</td>

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

  624.           <td></td>

  625.         </tr>

  626.       </table>

  627.   </td>

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

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

  630.   </tr>

  631. </table>

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

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

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

  635. 

  636. </div>

  637. </div>

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

  639. <div class="memitem">

  640. <div class="memproto">

  641. <table class="mlabels">

  642.   <tr>

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

  644.       <table class="memname">

  645.         <tr>

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

  647.           <td>(</td>

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

  649.           <td></td>

  650.         </tr>

  651.       </table>

  652.   </td>

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

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

  655.   </tr>

  656. </table>

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

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

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

  660. 

  661. </div>

  662. </div>

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

  664. <div class="memitem">

  665. <div class="memproto">

  666. <table class="mlabels">

  667.   <tr>

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

  669.       <table class="memname">

  670.         <tr>

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

  672.           <td>(</td>

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

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

  675.           <td></td>

  676.         </tr>

  677.       </table>

  678.   </td>

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

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

  681.   </tr>

  682. </table>

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

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

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

  686.   <table class="params">

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

  688.   </table>

  689.   </dd>

  690. </dl>

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

  692. 

  693. </div>

  694. </div>

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

  696. <div class="memitem">

  697. <div class="memproto">

  698. <table class="mlabels">

  699.   <tr>

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

  701.       <table class="memname">

  702.         <tr>

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

  704.           <td>(</td>

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

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

  707.           <td></td>

  708.         </tr>

  709.       </table>

  710.   </td>

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

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

  713.   </tr>

  714. </table>

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

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

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

  718.   <table class="params">

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

  720.   </table>

  721.   </dd>

  722. </dl>

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

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

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

  726. 

  727. </div>

  728. </div>

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

  730. <div class="memitem">

  731. <div class="memproto">

  732. <table class="mlabels">

  733.   <tr>

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

  735.       <table class="memname">

  736.         <tr>

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

  738.           <td>(</td>

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

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

  741.         </tr>

  742.         <tr>

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

  744.           <td></td>

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

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

  747.         </tr>

  748.         <tr>

  749.           <td></td>

  750.           <td>)</td>

  751.           <td></td><td></td>

  752.         </tr>

  753.       </table>

  754.   </td>

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

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

  757.   </tr>

  758. </table>

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

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

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

  762.   <table class="params">

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

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

  765.   </table>

  766.   </dd>

  767. </dl>

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

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

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

  771. 

  772. </div>

  773. </div>

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

  775. <div class="memitem">

  776. <div class="memproto">

  777. <table class="mlabels">

  778.   <tr>

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

  780.       <table class="memname">

  781.         <tr>

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

  783.           <td>(</td>

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

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

  786.         </tr>

  787.         <tr>

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

  789.           <td></td>

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

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

  792.         </tr>

  793.         <tr>

  794.           <td></td>

  795.           <td>)</td>

  796.           <td></td><td></td>

  797.         </tr>

  798.       </table>

  799.   </td>

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

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

  802.   </tr>

  803. </table>

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

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

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

  807.   <table class="params">

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

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

  810.   </table>

  811.   </dd>

  812. </dl>

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

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

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

  816. 

  817. </div>

  818. </div>

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

  820. <div class="memitem">

  821. <div class="memproto">

  822. <table class="mlabels">

  823.   <tr>

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

  825.       <table class="memname">

  826.         <tr>

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

  828.           <td>(</td>

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

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

  831.         </tr>

  832.         <tr>

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

  834.           <td></td>

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

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

  837.         </tr>

  838.         <tr>

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

  840.           <td></td>

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

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

  843.         </tr>

  844.         <tr>

  845.           <td></td>

  846.           <td>)</td>

  847.           <td></td><td></td>

  848.         </tr>

  849.       </table>

  850.   </td>

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

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

  853.   </tr>

  854. </table>

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

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

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

  858.   <table class="params">

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

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

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

  862.   </table>

  863.   </dd>

  864. </dl>

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

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

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

  868. 

  869. </div>

  870. </div>

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

  872. <div class="memitem">

  873. <div class="memproto">

  874. <table class="mlabels">

  875.   <tr>

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

  877.       <table class="memname">

  878.         <tr>

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

  880.           <td>(</td>

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

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

  883.         </tr>

  884.         <tr>

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

  886.           <td></td>

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

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

  889.         </tr>

  890.         <tr>

  891.           <td></td>

  892.           <td>)</td>

  893.           <td></td><td></td>

  894.         </tr>

  895.       </table>

  896.   </td>

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

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

  899.   </tr>

  900. </table>

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

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

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

  904.   <table class="params">

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

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

  907.   </table>

  908.   </dd>

  909. </dl>

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

  911. 

  912. </div>

  913. </div>

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

  915. <div class="memitem">

  916. <div class="memproto">

  917. <table class="mlabels">

  918.   <tr>

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

  920.       <table class="memname">

  921.         <tr>

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

  923.           <td>(</td>

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

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

  926.         </tr>

  927.         <tr>

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

  929.           <td></td>

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

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

  932.         </tr>

  933.         <tr>

  934.           <td></td>

  935.           <td>)</td>

  936.           <td></td><td></td>

  937.         </tr>

  938.       </table>

  939.   </td>

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

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

  942.   </tr>

  943. </table>

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

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

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

  947.   <table class="params">

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

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

  950.   </table>

  951.   </dd>

  952. </dl>

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

  954. 

  955. </div>

  956. </div>

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

  958. <div class="memitem">

  959. <div class="memproto">

  960. <table class="mlabels">

  961.   <tr>

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

  963.       <table class="memname">

  964.         <tr>

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

  966.           <td>(</td>

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

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

  969.           <td></td>

  970.         </tr>

  971.       </table>

  972.   </td>

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

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

  975.   </tr>

  976. </table>

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

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

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

  980.   <table class="params">

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

  982.   </table>

  983.   </dd>

  984. </dl>

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

  986. 

  987. </div>

  988. </div>

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

  990. <div class="memitem">

  991. <div class="memproto">

  992. <table class="mlabels">

  993.   <tr>

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

  995.       <table class="memname">

  996.         <tr>

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

  998.           <td>(</td>

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

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

  1001.         </tr>

  1002.         <tr>

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

  1004.           <td></td>

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

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

  1007.         </tr>

  1008.         <tr>

  1009.           <td></td>

  1010.           <td>)</td>

  1011.           <td></td><td></td>

  1012.         </tr>

  1013.       </table>

  1014.   </td>

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

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

  1017.   </tr>

  1018. </table>

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

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

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

  1022.   <table class="params">

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

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

  1025.   </table>

  1026.   </dd>

  1027. </dl>

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

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

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

  1031. 

  1032. </div>

  1033. </div>

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

  1035. <div class="memitem">

  1036. <div class="memproto">

  1037. <table class="mlabels">

  1038.   <tr>

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

  1040.       <table class="memname">

  1041.         <tr>

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

  1043.           <td>(</td>

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

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

  1046.           <td></td>

  1047.         </tr>

  1048.       </table>

  1049.   </td>

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

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

  1052.   </tr>

  1053. </table>

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

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

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

  1057.   <table class="params">

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

  1059.   </table>

  1060.   </dd>

  1061. </dl>

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

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

  1064. 

  1065. </div>

  1066. </div>

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

  1068. <div class="memitem">

  1069. <div class="memproto">

  1070. <table class="mlabels">

  1071.   <tr>

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

  1073.       <table class="memname">

  1074.         <tr>

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

  1076.           <td>(</td>

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

  1078.           <td> const</td>

  1079.         </tr>

  1080.       </table>

  1081.   </td>

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

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

  1084.   </tr>

  1085. </table>

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

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

  1088. 

  1089. </div>

  1090. </div>

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

  1092. <div class="memitem">

  1093. <div class="memproto">

  1094. <table class="mlabels">

  1095.   <tr>

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

  1097.       <table class="memname">

  1098.         <tr>

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

  1100.           <td>(</td>

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

  1102.           <td> const</td>

  1103.         </tr>

  1104.       </table>

  1105.   </td>

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

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

  1108.   </tr>

  1109. </table>

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

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

  1112. 

  1113. </div>

  1114. </div>

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

  1116. <div class="memitem">

  1117. <div class="memproto">

  1118. <table class="mlabels">

  1119.   <tr>

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

  1121.       <table class="memname">

  1122.         <tr>

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

  1124.           <td>(</td>

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

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

  1127.         </tr>

  1128.         <tr>

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

  1130.           <td></td>

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

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

  1133.         </tr>

  1134.         <tr>

  1135.           <td></td>

  1136.           <td>)</td>

  1137.           <td></td><td></td>

  1138.         </tr>

  1139.       </table>

  1140.   </td>

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

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

  1143.   </tr>

  1144. </table>

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

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

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

  1148.   <table class="params">

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

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

  1151.   </table>

  1152.   </dd>

  1153. </dl>

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

  1155. 

  1156. </div>

  1157. </div>

  1158. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></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"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>

  1167.           <td>(</td>

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

  1169.           <td></td>

  1170.         </tr>

  1171.       </table>

  1172.   </td>

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

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

  1175.   </tr>

  1176. </table>

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

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

  1179. 

  1180. </div>

  1181. </div>

  1182. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></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">uint32_t FatVolume::volumeBlockCount </td>

  1191.           <td>(</td>

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

  1193.           <td> const</td>

  1194.         </tr>

  1195.       </table>

  1196.   </td>

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

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

  1199.   </tr>

  1200. </table>

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

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

  1203. 

  1204. </div>

  1205. </div>

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

  1207. <div class="memitem">

  1208. <div class="memproto">

  1209. <table class="mlabels">

  1210.   <tr>

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

  1212.       <table class="memname">

  1213.         <tr>

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

  1215.           <td>(</td>

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

  1217.           <td></td>

  1218.         </tr>

  1219.       </table>

  1220.   </td>

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

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

  1223.   </tr>

  1224. </table>

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

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

  1227. 

  1228. </div>

  1229. </div>

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

  1231. <div class="memitem">

  1232. <div class="memproto">

  1233. <table class="mlabels">

  1234.   <tr>

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

  1236.       <table class="memname">

  1237.         <tr>

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

  1239.           <td>(</td>

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

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

  1242.           <td></td>

  1243.         </tr>

  1244.       </table>

  1245.   </td>

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

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

  1248.   </tr>

  1249. </table>

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

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

  1252.   <table class="params">

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

  1254.   </table>

  1255.   </dd>

  1256. </dl>

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

  1258. 

  1259. </div>

  1260. </div>

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

  1262. <li>Arduino/libraries/SdFat/utility/<a class="el" href="_fat_file_system_8h.html">FatFileSystem.h</a></li>

  1263. </ul>

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

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

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

  1267. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  1269. </a> 1.8.8

  1270. </small></address>

  1271. </body>

  1272. </html>