visus
/
teensy-sdfat
關注 1
收藏 0
複製 0
程式碼 問題 0 合併請求 0 版本發佈 0 Wiki 活動
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 提交
1 分支
目錄樹: 8408432732
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 '8408432732'
${ noResults }
teensy-sdfat/html/class_fat_file_system.html

668 line
35KB
原始文件 Blame 歷史記錄 

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

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

  3. <head>

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

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

  6. <meta name="generator" content="Doxygen 1.8.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_file_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_file_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. </table><table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  173. </table>

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

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

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

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

  178. <div class="memitem">

  179. <div class="memproto">

  180. <table class="mlabels">

  181.   <tr>

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

  183.       <table class="memname">

  184.         <tr>

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

  186.           <td>(</td>

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

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

  189.           <td></td>

  190.         </tr>

  191.       </table>

  192.   </td>

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

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

  195.   </tr>

  196. </table>

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

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

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

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

  201.   <table class="params">

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

  203.   </table>

  204.   </dd>

  205. </dl>

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

  207. 

  208. </div>

  209. </div>

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

  211. <div class="memitem">

  212. <div class="memproto">

  213. <table class="mlabels">

  214.   <tr>

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

  216.       <table class="memname">

  217.         <tr>

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

  219.           <td>(</td>

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

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

  222.         </tr>

  223.         <tr>

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

  225.           <td></td>

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

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

  228.         </tr>

  229.         <tr>

  230.           <td></td>

  231.           <td>)</td>

  232.           <td></td><td></td>

  233.         </tr>

  234.       </table>

  235.   </td>

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

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

  238.   </tr>

  239. </table>

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

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

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

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

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

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

  246.   <table class="params">

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

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

  249.   </table>

  250.   </dd>

  251. </dl>

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

  253. 

  254. </div>

  255. </div>

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

  257. <div class="memitem">

  258. <div class="memproto">

  259. <table class="mlabels">

  260.   <tr>

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

  262.       <table class="memname">

  263.         <tr>

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

  265.           <td>(</td>

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

  267.           <td></td>

  268.         </tr>

  269.       </table>

  270.   </td>

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

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

  273.   </tr>

  274. </table>

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

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

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

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

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

  280. 

  281. </div>

  282. </div>

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

  284. <div class="memitem">

  285. <div class="memproto">

  286. <table class="mlabels">

  287.   <tr>

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

  289.       <table class="memname">

  290.         <tr>

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

  292.           <td>(</td>

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

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

  295.           <td></td>

  296.         </tr>

  297.       </table>

  298.   </td>

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

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

  301.   </tr>

  302. </table>

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

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

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

  306.   <table class="params">

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

  308.   </table>

  309.   </dd>

  310. </dl>

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

  312. 

  313. </div>

  314. </div>

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

  316. <div class="memitem">

  317. <div class="memproto">

  318. <table class="mlabels">

  319.   <tr>

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

  321.       <table class="memname">

  322.         <tr>

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

  324.           <td>(</td>

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

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

  327.         </tr>

  328.         <tr>

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

  330.           <td></td>

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

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

  333.         </tr>

  334.         <tr>

  335.           <td></td>

  336.           <td>)</td>

  337.           <td></td><td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

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

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

  343.   </tr>

  344. </table>

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

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

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

  348.   <table class="params">

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

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

  351.   </table>

  352.   </dd>

  353. </dl>

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

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

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

  357. 

  358. </div>

  359. </div>

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

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

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

  369.           <td>(</td>

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

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

  372.         </tr>

  373.         <tr>

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

  375.           <td></td>

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

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

  378.         </tr>

  379.         <tr>

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

  381.           <td></td>

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

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

  384.         </tr>

  385.         <tr>

  386.           <td></td>

  387.           <td>)</td>

  388.           <td></td><td></td>

  389.         </tr>

  390.       </table>

  391.   </td>

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

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

  394.   </tr>

  395. </table>

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

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

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

  399.   <table class="params">

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

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

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

  403.   </table>

  404.   </dd>

  405. </dl>

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

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

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

  409. 

  410. </div>

  411. </div>

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

  413. <div class="memitem">

  414. <div class="memproto">

  415. <table class="mlabels">

  416.   <tr>

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

  418.       <table class="memname">

  419.         <tr>

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

  421.           <td>(</td>

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

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

  424.         </tr>

  425.         <tr>

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

  427.           <td></td>

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

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

  430.         </tr>

  431.         <tr>

  432.           <td></td>

  433.           <td>)</td>

  434.           <td></td><td></td>

  435.         </tr>

  436.       </table>

  437.   </td>

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

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

  440.   </tr>

  441. </table>

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

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

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

  445.   <table class="params">

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

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

  448.   </table>

  449.   </dd>

  450. </dl>

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

  452. 

  453. </div>

  454. </div>

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

  456. <div class="memitem">

  457. <div class="memproto">

  458. <table class="mlabels">

  459.   <tr>

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

  461.       <table class="memname">

  462.         <tr>

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

  464.           <td>(</td>

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

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

  467.           <td></td>

  468.         </tr>

  469.       </table>

  470.   </td>

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

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

  473.   </tr>

  474. </table>

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

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

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

  478.   <table class="params">

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

  480.   </table>

  481.   </dd>

  482. </dl>

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

  484. 

  485. </div>

  486. </div>

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

  488. <div class="memitem">

  489. <div class="memproto">

  490. <table class="mlabels">

  491.   <tr>

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

  493.       <table class="memname">

  494.         <tr>

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

  496.           <td>(</td>

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

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

  499.         </tr>

  500.         <tr>

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

  502.           <td></td>

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

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

  505.         </tr>

  506.         <tr>

  507.           <td></td>

  508.           <td>)</td>

  509.           <td></td><td></td>

  510.         </tr>

  511.       </table>

  512.   </td>

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

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

  515.   </tr>

  516. </table>

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

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

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

  520.   <table class="params">

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

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

  523.   </table>

  524.   </dd>

  525. </dl>

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

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

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

  529. 

  530. </div>

  531. </div>

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

  533. <div class="memitem">

  534. <div class="memproto">

  535. <table class="mlabels">

  536.   <tr>

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

  538.       <table class="memname">

  539.         <tr>

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

  541.           <td>(</td>

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

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

  544.           <td></td>

  545.         </tr>

  546.       </table>

  547.   </td>

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

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

  550.   </tr>

  551. </table>

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

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

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

  555.   <table class="params">

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

  557.   </table>

  558.   </dd>

  559. </dl>

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

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

  562. 

  563. </div>

  564. </div>

  565. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></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">bool FatFileSystem::truncate </td>

  574.           <td>(</td>

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

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

  577.         </tr>

  578.         <tr>

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

  580.           <td></td>

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

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

  583.         </tr>

  584.         <tr>

  585.           <td></td>

  586.           <td>)</td>

  587.           <td></td><td></td>

  588.         </tr>

  589.       </table>

  590.   </td>

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

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

  593.   </tr>

  594. </table>

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

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

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

  598.   <table class="params">

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

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

  601.   </table>

  602.   </dd>

  603. </dl>

  604. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include file is read only, file is a directory, <em>length</em> is greater than the current file size or an I/O error occurs. </dd></dl>

  605. 

  606. </div>

  607. </div>

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

  609. <div class="memitem">

  610. <div class="memproto">

  611. <table class="mlabels">

  612.   <tr>

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

  614.       <table class="memname">

  615.         <tr>

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

  617.           <td>(</td>

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

  619.           <td></td>

  620.         </tr>

  621.       </table>

  622.   </td>

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

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

  625.   </tr>

  626. </table>

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

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

  629. 

  630. </div>

  631. </div>

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

  633. <div class="memitem">

  634. <div class="memproto">

  635. <table class="mlabels">

  636.   <tr>

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

  638.       <table class="memname">

  639.         <tr>

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

  641.           <td>(</td>

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

  643.           <td></td>

  644.         </tr>

  645.       </table>

  646.   </td>

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

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

  649.   </tr>

  650. </table>

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

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

  653. 

  654. </div>

  655. </div>

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

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

  658. </ul>

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

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

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

  662. Generated on Sat Nov 15 2014 10:05:36 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  664. </a> 1.8.8

  665. </small></address>

  666. </body>

  667. </html>