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

701 lines
37KB
Czysty Wina Historia 

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

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

  3. <head>

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

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

  6. <meta name="generator" content="Doxygen 1.8.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="#pri-methods">Private 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="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>

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

  104. <div class="dynheader">

  105. Collaboration diagram for FatFileSystem:</div>

  106. <div class="dyncontent">

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

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

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

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

  111. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  144. Private Member Functions</h2></td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  175. </table>

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

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

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

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

  180. <div class="memitem">

  181. <div class="memproto">

  182. <table class="mlabels">

  183.   <tr>

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

  185.       <table class="memname">

  186.         <tr>

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

  188.           <td>(</td>

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

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

  191.           <td></td>

  192.         </tr>

  193.       </table>

  194.   </td>

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

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

  197.   </tr>

  198. </table>

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

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

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

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

  203.   <table class="params">

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

  205.   </table>

  206.   </dd>

  207. </dl>

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

  209. 

  210. </div>

  211. </div>

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

  213. <div class="memitem">

  214. <div class="memproto">

  215. <table class="mlabels">

  216.   <tr>

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

  218.       <table class="memname">

  219.         <tr>

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

  221.           <td>(</td>

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

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

  224.         </tr>

  225.         <tr>

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

  227.           <td></td>

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

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

  230.         </tr>

  231.         <tr>

  232.           <td></td>

  233.           <td>)</td>

  234.           <td></td><td></td>

  235.         </tr>

  236.       </table>

  237.   </td>

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

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

  240.   </tr>

  241. </table>

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

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

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

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

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

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

  248.   <table class="params">

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

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

  251.   </table>

  252.   </dd>

  253. </dl>

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

  255. 

  256. </div>

  257. </div>

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

  259. <div class="memitem">

  260. <div class="memproto">

  261. <table class="mlabels">

  262.   <tr>

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

  264.       <table class="memname">

  265.         <tr>

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

  267.           <td>(</td>

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

  269.           <td></td>

  270.         </tr>

  271.       </table>

  272.   </td>

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

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

  275.   </tr>

  276. </table>

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

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

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

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

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

  282. 

  283. </div>

  284. </div>

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

  286. <div class="memitem">

  287. <div class="memproto">

  288. <table class="mlabels">

  289.   <tr>

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

  291.       <table class="memname">

  292.         <tr>

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

  294.           <td>(</td>

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

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

  297.           <td></td>

  298.         </tr>

  299.       </table>

  300.   </td>

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

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

  303.   </tr>

  304. </table>

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

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

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

  308.   <table class="params">

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

  310.   </table>

  311.   </dd>

  312. </dl>

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

  314. 

  315. </div>

  316. </div>

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

  318. <div class="memitem">

  319. <div class="memproto">

  320. <table class="mlabels">

  321.   <tr>

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

  323.       <table class="memname">

  324.         <tr>

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

  326.           <td>(</td>

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

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

  329.         </tr>

  330.         <tr>

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

  332.           <td></td>

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

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

  335.         </tr>

  336.         <tr>

  337.           <td></td>

  338.           <td>)</td>

  339.           <td></td><td></td>

  340.         </tr>

  341.       </table>

  342.   </td>

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

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

  345.   </tr>

  346. </table>

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

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

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

  350.   <table class="params">

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

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

  353.   </table>

  354.   </dd>

  355. </dl>

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

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

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

  359. 

  360. </div>

  361. </div>

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

  363. <div class="memitem">

  364. <div class="memproto">

  365. <table class="mlabels">

  366.   <tr>

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

  368.       <table class="memname">

  369.         <tr>

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

  371.           <td>(</td>

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

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

  374.         </tr>

  375.         <tr>

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

  377.           <td></td>

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

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

  380.         </tr>

  381.         <tr>

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

  383.           <td></td>

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

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

  386.         </tr>

  387.         <tr>

  388.           <td></td>

  389.           <td>)</td>

  390.           <td></td><td></td>

  391.         </tr>

  392.       </table>

  393.   </td>

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

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

  396.   </tr>

  397. </table>

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

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

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

  401.   <table class="params">

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

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

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

  405.   </table>

  406.   </dd>

  407. </dl>

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

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

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

  411. 

  412. </div>

  413. </div>

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

  415. <div class="memitem">

  416. <div class="memproto">

  417. <table class="mlabels">

  418.   <tr>

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

  420.       <table class="memname">

  421.         <tr>

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

  423.           <td>(</td>

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

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

  426.         </tr>

  427.         <tr>

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

  429.           <td></td>

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

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

  432.         </tr>

  433.         <tr>

  434.           <td></td>

  435.           <td>)</td>

  436.           <td></td><td></td>

  437.         </tr>

  438.       </table>

  439.   </td>

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

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

  442.   </tr>

  443. </table>

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

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

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

  447.   <table class="params">

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

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

  450.   </table>

  451.   </dd>

  452. </dl>

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

  454. 

  455. </div>

  456. </div>

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

  458. <div class="memitem">

  459. <div class="memproto">

  460. <table class="mlabels">

  461.   <tr>

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

  463.       <table class="memname">

  464.         <tr>

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

  466.           <td>(</td>

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

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

  469.           <td></td>

  470.         </tr>

  471.       </table>

  472.   </td>

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

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

  475.   </tr>

  476. </table>

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

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

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

  480.   <table class="params">

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

  482.   </table>

  483.   </dd>

  484. </dl>

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

  486. 

  487. </div>

  488. </div>

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

  490. <div class="memitem">

  491. <div class="memproto">

  492. <table class="mlabels">

  493.   <tr>

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

  495.       <table class="memname">

  496.         <tr>

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

  498.           <td>(</td>

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

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

  501.         </tr>

  502.         <tr>

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

  504.           <td></td>

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

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

  507.         </tr>

  508.         <tr>

  509.           <td></td>

  510.           <td>)</td>

  511.           <td></td><td></td>

  512.         </tr>

  513.       </table>

  514.   </td>

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

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

  517.   </tr>

  518. </table>

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

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

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

  522.   <table class="params">

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

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

  525.   </table>

  526.   </dd>

  527. </dl>

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

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

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

  531. 

  532. </div>

  533. </div>

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

  535. <div class="memitem">

  536. <div class="memproto">

  537. <table class="mlabels">

  538.   <tr>

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

  540.       <table class="memname">

  541.         <tr>

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

  543.           <td>(</td>

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

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

  546.           <td></td>

  547.         </tr>

  548.       </table>

  549.   </td>

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

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

  552.   </tr>

  553. </table>

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

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

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

  557.   <table class="params">

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

  559.   </table>

  560.   </dd>

  561. </dl>

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

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

  564. 

  565. </div>

  566. </div>

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

  568. <div class="memitem">

  569. <div class="memproto">

  570. <table class="mlabels">

  571.   <tr>

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

  573.       <table class="memname">

  574.         <tr>

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

  576.           <td>(</td>

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

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

  579.         </tr>

  580.         <tr>

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

  582.           <td></td>

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

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

  585.         </tr>

  586.         <tr>

  587.           <td></td>

  588.           <td>)</td>

  589.           <td></td><td></td>

  590.         </tr>

  591.       </table>

  592.   </td>

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

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

  595.   </tr>

  596. </table>

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

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

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

  600.   <table class="params">

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

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

  603.   </table>

  604.   </dd>

  605. </dl>

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

  607. 

  608. </div>

  609. </div>

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

  611. <div class="memitem">

  612. <div class="memproto">

  613. <table class="mlabels">

  614.   <tr>

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

  616.       <table class="memname">

  617.         <tr>

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

  619.           <td>(</td>

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

  621.           <td></td>

  622.         </tr>

  623.       </table>

  624.   </td>

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

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

  627.   </tr>

  628. </table>

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

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

  631. 

  632. </div>

  633. </div>

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

  635. <div class="memitem">

  636. <div class="memproto">

  637. <table class="mlabels">

  638.   <tr>

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

  640.       <table class="memname">

  641.         <tr>

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

  643.           <td>(</td>

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

  645.           <td></td>

  646.         </tr>

  647.       </table>

  648.   </td>

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

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

  651.   </tr>

  652. </table>

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

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

  655. 

  656. </div>

  657. </div>

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

  659. <div class="memitem">

  660. <div class="memproto">

  661. <table class="mlabels">

  662.   <tr>

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

  664.       <table class="memname">

  665.         <tr>

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

  667.           <td>(</td>

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

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

  670.           <td></td>

  671.         </tr>

  672.       </table>

  673.   </td>

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

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

  676.   </tr>

  677. </table>

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

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

  680.   <table class="params">

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

  682.   </table>

  683.   </dd>

  684. </dl>

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

  686. 

  687. </div>

  688. </div>

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

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

  691. </ul>

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

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

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

  695. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  697. </a> 1.8.8

  698. </small></address>

  699. </body>

  700. </html>