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.
16 提交
1 分支
目錄樹: cb56364787
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'cb56364787'
${ noResults }
teensy-sdfat/html/class_sd_fat_base.html

2130 line
92KB
原始文件 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: SdFatBase 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_sd_fat_base-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdFatBase Class Reference</div>  </div>

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

  90. <div class="contents">

  91. 

  92. <p>Virtual base class for SdFat library.  

  93.  <a href="class_sd_fat_base.html#details">More...</a></p>

  94. 

  95. <p><code>#include &lt;SdFat.h&gt;</code></p>

  96. <div class="dynheader">

  97. Inheritance diagram for SdFatBase:</div>

  98. <div class="dyncontent">

  99. <div class="center"><img src="class_sd_fat_base__inherit__graph.png" border="0" usemap="#_sd_fat_base_inherit__map" alt="Inheritance graph"/></div>

  100. <map name="_sd_fat_base_inherit__map" id="_sd_fat_base_inherit__map">

  101. <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"/>
<area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="80,80,187,107"/>
<area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="91,5,176,32"/>
</map>

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

  103. <div class="dynheader">

  104. Collaboration diagram for SdFatBase:</div>

  105. <div class="dyncontent">

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

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

  108. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="5,80,112,107"/>
<area shape="rect" id="node4" 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:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a3d3f2cc4df1b6f2a129c3a614c1e5e1f">begin</a> (<a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *spi, uint8_t csPin=SS, uint8_t divisor=2)</td></tr>

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

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

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

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

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

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

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

  123. <tr class="memitem:a899294ced4e4585feae7668099338534"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a899294ced4e4585feae7668099338534">card</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  139. <tr class="memitem:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a905d883dcbaa60aa35a6eb0cad63cc9e">errorHalt</a> ()</td></tr>

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

  141. <tr class="memitem:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ae8cf95abf0ffb1c7a55eb1a192c28982">errorHalt</a> (Print *pr)</td></tr>

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

  143. <tr class="memitem:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a07e04b976ffcaf7e9492e50c6e4900a8">errorHalt</a> (char const *msg)</td></tr>

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

  145. <tr class="memitem:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7c52e1a1909c9aa532b8525cf721fd89">errorHalt</a> (Print *pr, char const *msg)</td></tr>

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

  147. <tr class="memitem:a111cecbcc7ea5c068c44051491a77a52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a111cecbcc7ea5c068c44051491a77a52">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>

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

  149. <tr class="memitem:a4c34e68605243269f96122a9cb909004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a4c34e68605243269f96122a9cb909004">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

  151. <tr class="memitem:a2deadc5b8bcdf5710fefba39b895e008"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a2deadc5b8bcdf5710fefba39b895e008">errorPrint</a> ()</td></tr>

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

  153. <tr class="memitem:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aaa950f290e41c0ff2d62b94cb425ba12">errorPrint</a> (Print *pr)</td></tr>

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

  155. <tr class="memitem:a84fe32d89460471cf9f66495f545e2ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a84fe32d89460471cf9f66495f545e2ae">errorPrint</a> (const char *msg)</td></tr>

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

  157. <tr class="memitem:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a5ecc4177c65f8e2837a9ef4d17368a98">errorPrint</a> (Print *pr, char const *msg)</td></tr>

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

  159. <tr class="memitem:a7eed2449f96d62e87bea96c6da4f618a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7eed2449f96d62e87bea96c6da4f618a">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>

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

  161. <tr class="memitem:aace11e097b69144a80a4abbca54d35b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aace11e097b69144a80a4abbca54d35b0">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  173. <tr class="memitem:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a389f0ef6fb556c67b48ade5c0c1b3a9a">fsBegin</a> ()</td></tr>

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

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

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

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

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

  179. <tr class="memitem:adbfd9264f972f054e561128bad0b267e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adbfd9264f972f054e561128bad0b267e">initErrorHalt</a> ()</td></tr>

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

  181. <tr class="memitem:a86770dd889bffc5788172c8d34a3582c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a86770dd889bffc5788172c8d34a3582c">initErrorHalt</a> (Print *pr)</td></tr>

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

  183. <tr class="memitem:a0d4c851a3243c9f8c21d3894821292e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a0d4c851a3243c9f8c21d3894821292e9">initErrorHalt</a> (char const *msg)</td></tr>

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

  185. <tr class="memitem:a02f18794078b7a1c9662c3ded438cff4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a02f18794078b7a1c9662c3ded438cff4">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>

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

  187. <tr class="memitem:abe312251854aebf5b8d6b4f9896660ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#abe312251854aebf5b8d6b4f9896660ed">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>

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

  189. <tr class="memitem:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aa93c7fec40b37e7f5dd1e362ebf5ff69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

  191. <tr class="memitem:a62a979138be1b62942f7b3f04964356e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a62a979138be1b62942f7b3f04964356e">initErrorPrint</a> ()</td></tr>

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

  193. <tr class="memitem:adffd5a3e802842b371b170c6df6b2530"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adffd5a3e802842b371b170c6df6b2530">initErrorPrint</a> (Print *pr)</td></tr>

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

  195. <tr class="memitem:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a296855ca8cc7590b9cbe7b3aeabc8467">initErrorPrint</a> (char const *msg)</td></tr>

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

  197. <tr class="memitem:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aca07f92b3a06ede0e7a56b68b76dc3b7">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>

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

  199. <tr class="memitem:a9c334faf236651db265d5acf65271666"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a9c334faf236651db265d5acf65271666">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>

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

  201. <tr class="memitem:ac0b7161c1385841264323ac244f5c89c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ac0b7161c1385841264323ac244f5c89c">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  235. </table>

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

  237. <div class="textblock"><p>Virtual base class for SdFat library. </p>

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

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

  240. <div class="memitem">

  241. <div class="memproto">

  242. <table class="mlabels">

  243.   <tr>

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

  245.       <table class="memname">

  246.         <tr>

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

  248.           <td>(</td>

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

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

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

  261.   <table class="params">

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

  263.   </table>

  264.   </dd>

  265. </dl>

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

  267. 

  268. </div>

  269. </div>

  270. <a class="anchor" id="a3d3f2cc4df1b6f2a129c3a614c1e5e1f"></a>

  271. <div class="memitem">

  272. <div class="memproto">

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

  278.           <td class="memname">bool SdFatBase::begin </td>

  279.           <td>(</td>

  280.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *&#160;</td>

  281.           <td class="paramname"><em>spi</em>, </td>

  282.         </tr>

  283.         <tr>

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

  285.           <td></td>

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

  287.           <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>

  288.         </tr>

  289.         <tr>

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

  291.           <td></td>

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

  293.           <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>

  294.         </tr>

  295.         <tr>

  296.           <td></td>

  297.           <td>)</td>

  298.           <td></td><td></td>

  299.         </tr>

  300.       </table>

  301.   </td>

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

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

  304.   </tr>

  305. </table>

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

  307. <p>Initialize SD card and file system. </p><dl class="params"><dt>Parameters</dt><dd>

  308.   <table class="params">

  309.     <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI object for the card. </td></tr>

  310.     <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>

  311.     <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>

  312.   </table>

  313.   </dd>

  314. </dl>

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

  316. 

  317. </div>

  318. </div>

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

  320. <div class="memitem">

  321. <div class="memproto">

  322. <table class="mlabels">

  323.   <tr>

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

  325.       <table class="memname">

  326.         <tr>

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

  328.           <td>(</td>

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

  330.           <td> const</td>

  331.         </tr>

  332.       </table>

  333.   </td>

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

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

  336.   </tr>

  337. </table>

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

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

  340. 

  341. </div>

  342. </div>

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

  344. <div class="memitem">

  345. <div class="memproto">

  346. <table class="mlabels">

  347.   <tr>

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

  349.       <table class="memname">

  350.         <tr>

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

  352.           <td>(</td>

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

  354.           <td> const</td>

  355.         </tr>

  356.       </table>

  357.   </td>

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

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

  360.   </tr>

  361. </table>

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

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

  364. 

  365. </div>

  366. </div>

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

  384.   </tr>

  385. </table>

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

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

  388. 

  389. </div>

  390. </div>

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

  392. <div class="memitem">

  393. <div class="memproto">

  394. <table class="mlabels">

  395.   <tr>

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

  397.       <table class="memname">

  398.         <tr>

  399.           <td class="memname"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a>* SdFatBase::card </td>

  400.           <td>(</td>

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

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405.   </td>

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

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

  408.   </tr>

  409. </table>

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

  411. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>

  412. 

  413. </div>

  414. </div>

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

  416. <div class="memitem">

  417. <div class="memproto">

  418. <table class="mlabels">

  419.   <tr>

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

  421.       <table class="memname">

  422.         <tr>

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

  424.           <td>(</td>

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

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

  427.           <td></td>

  428.         </tr>

  429.       </table>

  430.   </td>

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

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

  433.   </tr>

  434. </table>

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

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

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

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

  439.   <table class="params">

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

  441.   </table>

  442.   </dd>

  443. </dl>

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

  445. 

  446. </div>

  447. </div>

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

  449. <div class="memitem">

  450. <div class="memproto">

  451. <table class="mlabels">

  452.   <tr>

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

  454.       <table class="memname">

  455.         <tr>

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

  457.           <td>(</td>

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

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

  460.         </tr>

  461.         <tr>

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

  463.           <td></td>

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

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

  466.         </tr>

  467.         <tr>

  468.           <td></td>

  469.           <td>)</td>

  470.           <td></td><td></td>

  471.         </tr>

  472.       </table>

  473.   </td>

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

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

  476.   </tr>

  477. </table>

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

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

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

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

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

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

  484.   <table class="params">

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

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

  487.   </table>

  488.   </dd>

  489. </dl>

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

  491. 

  492. </div>

  493. </div>

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

  495. <div class="memitem">

  496. <div class="memproto">

  497. <table class="mlabels">

  498.   <tr>

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

  500.       <table class="memname">

  501.         <tr>

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

  503.           <td>(</td>

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

  505.           <td></td>

  506.         </tr>

  507.       </table>

  508.   </td>

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

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

  511.   </tr>

  512. </table>

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

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

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

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

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

  518. 

  519. </div>

  520. </div>

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

  522. <div class="memitem">

  523. <div class="memproto">

  524. <table class="mlabels">

  525.   <tr>

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

  527.       <table class="memname">

  528.         <tr>

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

  530.           <td>(</td>

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

  532.           <td> const</td>

  533.         </tr>

  534.       </table>

  535.   </td>

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

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

  538.   </tr>

  539. </table>

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

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

  542. 

  543. </div>

  544. </div>

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

  546. <div class="memitem">

  547. <div class="memproto">

  548. <table class="mlabels">

  549.   <tr>

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

  551.       <table class="memname">

  552.         <tr>

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

  554.           <td>(</td>

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

  556.           <td> const</td>

  557.         </tr>

  558.       </table>

  559.   </td>

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

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

  562.   </tr>

  563. </table>

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

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

  566. 

  567. </div>

  568. </div>

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

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

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

  578.           <td>(</td>

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

  580.           <td> const</td>

  581.         </tr>

  582.       </table>

  583.   </td>

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

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

  586.   </tr>

  587. </table>

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

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

  590. 

  591. </div>

  592. </div>

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

  594. <div class="memitem">

  595. <div class="memproto">

  596. <table class="mlabels">

  597.   <tr>

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

  599.       <table class="memname">

  600.         <tr>

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

  602.           <td>(</td>

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

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

  605.         </tr>

  606.         <tr>

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

  608.           <td></td>

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

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

  611.         </tr>

  612.         <tr>

  613.           <td></td>

  614.           <td>)</td>

  615.           <td></td><td></td>

  616.         </tr>

  617.       </table>

  618.   </td>

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

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

  621.   </tr>

  622. </table>

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

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

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

  626.   <table class="params">

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

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

  629.   </table>

  630.   </dd>

  631. </dl>

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

  633. 

  634. </div>

  635. </div>

  636. <a class="anchor" id="a905d883dcbaa60aa35a6eb0cad63cc9e"></a>

  637. <div class="memitem">

  638. <div class="memproto">

  639. <table class="mlabels">

  640.   <tr>

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

  642.       <table class="memname">

  643.         <tr>

  644.           <td class="memname">void SdFatBase::errorHalt </td>

  645.           <td>(</td>

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

  647.           <td></td>

  648.         </tr>

  649.       </table>

  650.   </td>

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

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

  653.   </tr>

  654. </table>

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

  656. <p>Print any SD error code to Serial and halt. </p>

  657. 

  658. </div>

  659. </div>

  660. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></a>

  661. <div class="memitem">

  662. <div class="memproto">

  663.       <table class="memname">

  664.         <tr>

  665.           <td class="memname">void SdFatBase::errorHalt </td>

  666.           <td>(</td>

  667.           <td class="paramtype">Print *&#160;</td>

  668.           <td class="paramname"><em>pr</em></td><td>)</td>

  669.           <td></td>

  670.         </tr>

  671.       </table>

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

  673. <p>Print any SD error code and halt.</p>

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

  675.   <table class="params">

  676.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  677.   </table>

  678.   </dd>

  679. </dl>

  680. 

  681. </div>

  682. </div>

  683. <a class="anchor" id="a07e04b976ffcaf7e9492e50c6e4900a8"></a>

  684. <div class="memitem">

  685. <div class="memproto">

  686. <table class="mlabels">

  687.   <tr>

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

  689.       <table class="memname">

  690.         <tr>

  691.           <td class="memname">void SdFatBase::errorHalt </td>

  692.           <td>(</td>

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

  694.           <td class="paramname"><em>msg</em></td><td>)</td>

  695.           <td></td>

  696.         </tr>

  697.       </table>

  698.   </td>

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

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

  701.   </tr>

  702. </table>

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

  704. <p>Print msg, any SD error code and halt.</p>

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

  706.   <table class="params">

  707.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  708.   </table>

  709.   </dd>

  710. </dl>

  711. 

  712. </div>

  713. </div>

  714. <a class="anchor" id="a7c52e1a1909c9aa532b8525cf721fd89"></a>

  715. <div class="memitem">

  716. <div class="memproto">

  717.       <table class="memname">

  718.         <tr>

  719.           <td class="memname">void SdFatBase::errorHalt </td>

  720.           <td>(</td>

  721.           <td class="paramtype">Print *&#160;</td>

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

  723.         </tr>

  724.         <tr>

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

  726.           <td></td>

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

  728.           <td class="paramname"><em>msg</em>&#160;</td>

  729.         </tr>

  730.         <tr>

  731.           <td></td>

  732.           <td>)</td>

  733.           <td></td><td></td>

  734.         </tr>

  735.       </table>

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

  737. <p>Print msg, any SD error code, and halt.</p>

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

  739.   <table class="params">

  740.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  741.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  742.   </table>

  743.   </dd>

  744. </dl>

  745. 

  746. </div>

  747. </div>

  748. <a class="anchor" id="a111cecbcc7ea5c068c44051491a77a52"></a>

  749. <div class="memitem">

  750. <div class="memproto">

  751. <table class="mlabels">

  752.   <tr>

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

  754.       <table class="memname">

  755.         <tr>

  756.           <td class="memname">void SdFatBase::errorHalt </td>

  757.           <td>(</td>

  758.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  759.           <td class="paramname"><em>msg</em></td><td>)</td>

  760.           <td></td>

  761.         </tr>

  762.       </table>

  763.   </td>

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

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

  766.   </tr>

  767. </table>

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

  769. <p>Print msg, any SD error code, and halt.</p>

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

  771.   <table class="params">

  772.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  773.   </table>

  774.   </dd>

  775. </dl>

  776. 

  777. </div>

  778. </div>

  779. <a class="anchor" id="a4c34e68605243269f96122a9cb909004"></a>

  780. <div class="memitem">

  781. <div class="memproto">

  782.       <table class="memname">

  783.         <tr>

  784.           <td class="memname">void SdFatBase::errorHalt </td>

  785.           <td>(</td>

  786.           <td class="paramtype">Print *&#160;</td>

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

  788.         </tr>

  789.         <tr>

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

  791.           <td></td>

  792.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  793.           <td class="paramname"><em>msg</em>&#160;</td>

  794.         </tr>

  795.         <tr>

  796.           <td></td>

  797.           <td>)</td>

  798.           <td></td><td></td>

  799.         </tr>

  800.       </table>

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

  802. <p>Print msg, any SD error code, and halt.</p>

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

  804.   <table class="params">

  805.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  806.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  807.   </table>

  808.   </dd>

  809. </dl>

  810. 

  811. </div>

  812. </div>

  813. <a class="anchor" id="a2deadc5b8bcdf5710fefba39b895e008"></a>

  814. <div class="memitem">

  815. <div class="memproto">

  816. <table class="mlabels">

  817.   <tr>

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

  819.       <table class="memname">

  820.         <tr>

  821.           <td class="memname">void SdFatBase::errorPrint </td>

  822.           <td>(</td>

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

  824.           <td></td>

  825.         </tr>

  826.       </table>

  827.   </td>

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

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

  830.   </tr>

  831. </table>

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

  833. <p>Print any SD error code to Serial </p>

  834. 

  835. </div>

  836. </div>

  837. <a class="anchor" id="aaa950f290e41c0ff2d62b94cb425ba12"></a>

  838. <div class="memitem">

  839. <div class="memproto">

  840.       <table class="memname">

  841.         <tr>

  842.           <td class="memname">void SdFatBase::errorPrint </td>

  843.           <td>(</td>

  844.           <td class="paramtype">Print *&#160;</td>

  845.           <td class="paramname"><em>pr</em></td><td>)</td>

  846.           <td></td>

  847.         </tr>

  848.       </table>

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

  850. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>

  851.   <table class="params">

  852.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>

  853.   </table>

  854.   </dd>

  855. </dl>

  856. 

  857. </div>

  858. </div>

  859. <a class="anchor" id="a84fe32d89460471cf9f66495f545e2ae"></a>

  860. <div class="memitem">

  861. <div class="memproto">

  862. <table class="mlabels">

  863.   <tr>

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

  865.       <table class="memname">

  866.         <tr>

  867.           <td class="memname">void SdFatBase::errorPrint </td>

  868.           <td>(</td>

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

  870.           <td class="paramname"><em>msg</em></td><td>)</td>

  871.           <td></td>

  872.         </tr>

  873.       </table>

  874.   </td>

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

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

  877.   </tr>

  878. </table>

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

  880. <p>Print msg, any SD error code.</p>

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

  882.   <table class="params">

  883.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  884.   </table>

  885.   </dd>

  886. </dl>

  887. 

  888. </div>

  889. </div>

  890. <a class="anchor" id="a5ecc4177c65f8e2837a9ef4d17368a98"></a>

  891. <div class="memitem">

  892. <div class="memproto">

  893.       <table class="memname">

  894.         <tr>

  895.           <td class="memname">void SdFatBase::errorPrint </td>

  896.           <td>(</td>

  897.           <td class="paramtype">Print *&#160;</td>

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

  899.         </tr>

  900.         <tr>

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

  902.           <td></td>

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

  904.           <td class="paramname"><em>msg</em>&#160;</td>

  905.         </tr>

  906.         <tr>

  907.           <td></td>

  908.           <td>)</td>

  909.           <td></td><td></td>

  910.         </tr>

  911.       </table>

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

  913. <p>Print msg, any SD error code.</p>

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

  915.   <table class="params">

  916.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  917.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  918.   </table>

  919.   </dd>

  920. </dl>

  921. 

  922. </div>

  923. </div>

  924. <a class="anchor" id="a7eed2449f96d62e87bea96c6da4f618a"></a>

  925. <div class="memitem">

  926. <div class="memproto">

  927. <table class="mlabels">

  928.   <tr>

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

  930.       <table class="memname">

  931.         <tr>

  932.           <td class="memname">void SdFatBase::errorPrint </td>

  933.           <td>(</td>

  934.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  935.           <td class="paramname"><em>msg</em></td><td>)</td>

  936.           <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>Print msg, any SD error code.</p>

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

  947.   <table class="params">

  948.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  949.   </table>

  950.   </dd>

  951. </dl>

  952. 

  953. </div>

  954. </div>

  955. <a class="anchor" id="aace11e097b69144a80a4abbca54d35b0"></a>

  956. <div class="memitem">

  957. <div class="memproto">

  958.       <table class="memname">

  959.         <tr>

  960.           <td class="memname">void SdFatBase::errorPrint </td>

  961.           <td>(</td>

  962.           <td class="paramtype">Print *&#160;</td>

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

  964.         </tr>

  965.         <tr>

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

  967.           <td></td>

  968.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  969.           <td class="paramname"><em>msg</em>&#160;</td>

  970.         </tr>

  971.         <tr>

  972.           <td></td>

  973.           <td>)</td>

  974.           <td></td><td></td>

  975.         </tr>

  976.       </table>

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

  978. <p>Print msg, any SD error code.</p>

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

  980.   <table class="params">

  981.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  982.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  983.   </table>

  984.   </dd>

  985. </dl>

  986. 

  987. </div>

  988. </div>

  989. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></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::exists </td>

  998.           <td>(</td>

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

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

  1001.           <td></td>

  1002.         </tr>

  1003.       </table>

  1004.   </td>

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

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

  1007.   </tr>

  1008. </table>

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

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

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

  1012.   <table class="params">

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

  1014.   </table>

  1015.   </dd>

  1016. </dl>

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

  1018. 

  1019. </div>

  1020. </div>

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

  1022. <div class="memitem">

  1023. <div class="memproto">

  1024. <table class="mlabels">

  1025.   <tr>

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

  1027.       <table class="memname">

  1028.         <tr>

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

  1030.           <td>(</td>

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

  1032.           <td></td>

  1033.         </tr>

  1034.       </table>

  1035.   </td>

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

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

  1038.   </tr>

  1039. </table>

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

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

  1042. 

  1043. </div>

  1044. </div>

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

  1046. <div class="memitem">

  1047. <div class="memproto">

  1048. <table class="mlabels">

  1049.   <tr>

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

  1051.       <table class="memname">

  1052.         <tr>

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

  1054.           <td>(</td>

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

  1056.           <td> const</td>

  1057.         </tr>

  1058.       </table>

  1059.   </td>

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

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

  1062.   </tr>

  1063. </table>

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

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

  1066. 

  1067. </div>

  1068. </div>

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

  1070. <div class="memitem">

  1071. <div class="memproto">

  1072. <table class="mlabels">

  1073.   <tr>

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

  1075.       <table class="memname">

  1076.         <tr>

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

  1078.           <td>(</td>

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

  1080.           <td> const</td>

  1081.         </tr>

  1082.       </table>

  1083.   </td>

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

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

  1086.   </tr>

  1087. </table>

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

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

  1090. 

  1091. </div>

  1092. </div>

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

  1094. <div class="memitem">

  1095. <div class="memproto">

  1096. <table class="mlabels">

  1097.   <tr>

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

  1099.       <table class="memname">

  1100.         <tr>

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

  1102.           <td>(</td>

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

  1104.           <td></td>

  1105.         </tr>

  1106.       </table>

  1107.   </td>

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

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

  1110.   </tr>

  1111. </table>

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

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

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

  1115. 

  1116. </div>

  1117. </div>

  1118. <a class="anchor" id="a389f0ef6fb556c67b48ade5c0c1b3a9a"></a>

  1119. <div class="memitem">

  1120. <div class="memproto">

  1121. <table class="mlabels">

  1122.   <tr>

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

  1124.       <table class="memname">

  1125.         <tr>

  1126.           <td class="memname">bool SdFatBase::fsBegin </td>

  1127.           <td>(</td>

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

  1129.           <td></td>

  1130.         </tr>

  1131.       </table>

  1132.   </td>

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

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

  1135.   </tr>

  1136. </table>

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

  1138. <p>Diagnostic call to initialize <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> - use for diagnostic purposes only. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  1139. 

  1140. </div>

  1141. </div>

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

  1143. <div class="memitem">

  1144. <div class="memproto">

  1145. <table class="mlabels">

  1146.   <tr>

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

  1148.       <table class="memname">

  1149.         <tr>

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

  1151.           <td>(</td>

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

  1153.           <td></td>

  1154.         </tr>

  1155.       </table>

  1156.   </td>

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

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

  1159.   </tr>

  1160. </table>

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

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

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

  1164. 

  1165. </div>

  1166. </div>

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

  1168. <div class="memitem">

  1169. <div class="memproto">

  1170. <table class="mlabels">

  1171.   <tr>

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

  1173.       <table class="memname">

  1174.         <tr>

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

  1176.           <td>(</td>

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

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

  1179.           <td></td>

  1180.         </tr>

  1181.       </table>

  1182.   </td>

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

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

  1185.   </tr>

  1186. </table>

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

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

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

  1190.   <table class="params">

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

  1192.   </table>

  1193.   </dd>

  1194. </dl>

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

  1196. 

  1197. </div>

  1198. </div>

  1199. <a class="anchor" id="adbfd9264f972f054e561128bad0b267e"></a>

  1200. <div class="memitem">

  1201. <div class="memproto">

  1202. <table class="mlabels">

  1203.   <tr>

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

  1205.       <table class="memname">

  1206.         <tr>

  1207.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1208.           <td>(</td>

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

  1210.           <td></td>

  1211.         </tr>

  1212.       </table>

  1213.   </td>

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

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

  1216.   </tr>

  1217. </table>

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

  1219. <p>Print any SD error code and halt. </p>

  1220. 

  1221. </div>

  1222. </div>

  1223. <a class="anchor" id="a86770dd889bffc5788172c8d34a3582c"></a>

  1224. <div class="memitem">

  1225. <div class="memproto">

  1226.       <table class="memname">

  1227.         <tr>

  1228.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1229.           <td>(</td>

  1230.           <td class="paramtype">Print *&#160;</td>

  1231.           <td class="paramname"><em>pr</em></td><td>)</td>

  1232.           <td></td>

  1233.         </tr>

  1234.       </table>

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

  1236. <p>Print error details and halt after begin fails.</p>

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

  1238.   <table class="params">

  1239.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1240.   </table>

  1241.   </dd>

  1242. </dl>

  1243. 

  1244. </div>

  1245. </div>

  1246. <a class="anchor" id="a0d4c851a3243c9f8c21d3894821292e9"></a>

  1247. <div class="memitem">

  1248. <div class="memproto">

  1249. <table class="mlabels">

  1250.   <tr>

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

  1252.       <table class="memname">

  1253.         <tr>

  1254.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1255.           <td>(</td>

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

  1257.           <td class="paramname"><em>msg</em></td><td>)</td>

  1258.           <td></td>

  1259.         </tr>

  1260.       </table>

  1261.   </td>

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

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

  1264.   </tr>

  1265. </table>

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

  1267. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

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

  1269.   <table class="params">

  1270.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1271.   </table>

  1272.   </dd>

  1273. </dl>

  1274. 

  1275. </div>

  1276. </div>

  1277. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></a>

  1278. <div class="memitem">

  1279. <div class="memproto">

  1280.       <table class="memname">

  1281.         <tr>

  1282.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1283.           <td>(</td>

  1284.           <td class="paramtype">Print *&#160;</td>

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

  1286.         </tr>

  1287.         <tr>

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

  1289.           <td></td>

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

  1291.           <td class="paramname"><em>msg</em>&#160;</td>

  1292.         </tr>

  1293.         <tr>

  1294.           <td></td>

  1295.           <td>)</td>

  1296.           <td></td><td></td>

  1297.         </tr>

  1298.       </table>

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

  1300. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1301.   <table class="params">

  1302.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>

  1303.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1304.   </table>

  1305.   </dd>

  1306. </dl>

  1307. 

  1308. </div>

  1309. </div>

  1310. <a class="anchor" id="abe312251854aebf5b8d6b4f9896660ed"></a>

  1311. <div class="memitem">

  1312. <div class="memproto">

  1313. <table class="mlabels">

  1314.   <tr>

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

  1316.       <table class="memname">

  1317.         <tr>

  1318.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1319.           <td>(</td>

  1320.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1321.           <td class="paramname"><em>msg</em></td><td>)</td>

  1322.           <td></td>

  1323.         </tr>

  1324.       </table>

  1325.   </td>

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

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

  1328.   </tr>

  1329. </table>

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

  1331. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

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

  1333.   <table class="params">

  1334.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1335.   </table>

  1336.   </dd>

  1337. </dl>

  1338. 

  1339. </div>

  1340. </div>

  1341. <a class="anchor" id="aa93c7fec40b37e7f5dd1e362ebf5ff69"></a>

  1342. <div class="memitem">

  1343. <div class="memproto">

  1344.       <table class="memname">

  1345.         <tr>

  1346.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1347.           <td>(</td>

  1348.           <td class="paramtype">Print *&#160;</td>

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

  1350.         </tr>

  1351.         <tr>

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

  1353.           <td></td>

  1354.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1355.           <td class="paramname"><em>msg</em>&#160;</td>

  1356.         </tr>

  1357.         <tr>

  1358.           <td></td>

  1359.           <td>)</td>

  1360.           <td></td><td></td>

  1361.         </tr>

  1362.       </table>

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

  1364. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1365.   <table class="params">

  1366.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>

  1367.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1368.   </table>

  1369.   </dd>

  1370. </dl>

  1371. 

  1372. </div>

  1373. </div>

  1374. <a class="anchor" id="a62a979138be1b62942f7b3f04964356e"></a>

  1375. <div class="memitem">

  1376. <div class="memproto">

  1377. <table class="mlabels">

  1378.   <tr>

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

  1380.       <table class="memname">

  1381.         <tr>

  1382.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1383.           <td>(</td>

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

  1385.           <td></td>

  1386.         </tr>

  1387.       </table>

  1388.   </td>

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

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

  1391.   </tr>

  1392. </table>

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

  1394. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails. </p>

  1395. 

  1396. </div>

  1397. </div>

  1398. <a class="anchor" id="adffd5a3e802842b371b170c6df6b2530"></a>

  1399. <div class="memitem">

  1400. <div class="memproto">

  1401.       <table class="memname">

  1402.         <tr>

  1403.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1404.           <td>(</td>

  1405.           <td class="paramtype">Print *&#160;</td>

  1406.           <td class="paramname"><em>pr</em></td><td>)</td>

  1407.           <td></td>

  1408.         </tr>

  1409.       </table>

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

  1411. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

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

  1413.   <table class="params">

  1414.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1415.   </table>

  1416.   </dd>

  1417. </dl>

  1418. 

  1419. </div>

  1420. </div>

  1421. <a class="anchor" id="a296855ca8cc7590b9cbe7b3aeabc8467"></a>

  1422. <div class="memitem">

  1423. <div class="memproto">

  1424. <table class="mlabels">

  1425.   <tr>

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

  1427.       <table class="memname">

  1428.         <tr>

  1429.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1430.           <td>(</td>

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

  1432.           <td class="paramname"><em>msg</em></td><td>)</td>

  1433.           <td></td>

  1434.         </tr>

  1435.       </table>

  1436.   </td>

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

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

  1439.   </tr>

  1440. </table>

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

  1442. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

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

  1444.   <table class="params">

  1445.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1446.   </table>

  1447.   </dd>

  1448. </dl>

  1449. 

  1450. </div>

  1451. </div>

  1452. <a class="anchor" id="aca07f92b3a06ede0e7a56b68b76dc3b7"></a>

  1453. <div class="memitem">

  1454. <div class="memproto">

  1455.       <table class="memname">

  1456.         <tr>

  1457.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1458.           <td>(</td>

  1459.           <td class="paramtype">Print *&#160;</td>

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

  1461.         </tr>

  1462.         <tr>

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

  1464.           <td></td>

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

  1466.           <td class="paramname"><em>msg</em>&#160;</td>

  1467.         </tr>

  1468.         <tr>

  1469.           <td></td>

  1470.           <td>)</td>

  1471.           <td></td><td></td>

  1472.         </tr>

  1473.       </table>

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

  1475. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

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

  1477.   <table class="params">

  1478.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1479.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1480.   </table>

  1481.   </dd>

  1482. </dl>

  1483. 

  1484. </div>

  1485. </div>

  1486. <a class="anchor" id="a9c334faf236651db265d5acf65271666"></a>

  1487. <div class="memitem">

  1488. <div class="memproto">

  1489. <table class="mlabels">

  1490.   <tr>

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

  1492.       <table class="memname">

  1493.         <tr>

  1494.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1495.           <td>(</td>

  1496.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1497.           <td class="paramname"><em>msg</em></td><td>)</td>

  1498.           <td></td>

  1499.         </tr>

  1500.       </table>

  1501.   </td>

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

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

  1504.   </tr>

  1505. </table>

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

  1507. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

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

  1509.   <table class="params">

  1510.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1511.   </table>

  1512.   </dd>

  1513. </dl>

  1514. 

  1515. </div>

  1516. </div>

  1517. <a class="anchor" id="ac0b7161c1385841264323ac244f5c89c"></a>

  1518. <div class="memitem">

  1519. <div class="memproto">

  1520.       <table class="memname">

  1521.         <tr>

  1522.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1523.           <td>(</td>

  1524.           <td class="paramtype">Print *&#160;</td>

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

  1526.         </tr>

  1527.         <tr>

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

  1529.           <td></td>

  1530.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1531.           <td class="paramname"><em>msg</em>&#160;</td>

  1532.         </tr>

  1533.         <tr>

  1534.           <td></td>

  1535.           <td>)</td>

  1536.           <td></td><td></td>

  1537.         </tr>

  1538.       </table>

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

  1540. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

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

  1542.   <table class="params">

  1543.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1544.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1545.   </table>

  1546.   </dd>

  1547. </dl>

  1548. 

  1549. </div>

  1550. </div>

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

  1552. <div class="memitem">

  1553. <div class="memproto">

  1554. <table class="mlabels">

  1555.   <tr>

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

  1557.       <table class="memname">

  1558.         <tr>

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

  1560.           <td>(</td>

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

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

  1563.           <td></td>

  1564.         </tr>

  1565.       </table>

  1566.   </td>

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

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

  1569.   </tr>

  1570. </table>

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

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

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

  1574.   <table class="params">

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

  1576.   </table>

  1577.   </dd>

  1578. </dl>

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

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

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

  1582. 

  1583. </div>

  1584. </div>

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

  1586. <div class="memitem">

  1587. <div class="memproto">

  1588. <table class="mlabels">

  1589.   <tr>

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

  1591.       <table class="memname">

  1592.         <tr>

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

  1594.           <td>(</td>

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

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

  1597.         </tr>

  1598.         <tr>

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

  1600.           <td></td>

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

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

  1603.         </tr>

  1604.         <tr>

  1605.           <td></td>

  1606.           <td>)</td>

  1607.           <td></td><td></td>

  1608.         </tr>

  1609.       </table>

  1610.   </td>

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

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

  1613.   </tr>

  1614. </table>

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

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

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

  1618.   <table class="params">

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

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

  1621.   </table>

  1622.   </dd>

  1623. </dl>

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

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

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

  1627. 

  1628. </div>

  1629. </div>

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

  1631. <div class="memitem">

  1632. <div class="memproto">

  1633. <table class="mlabels">

  1634.   <tr>

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

  1636.       <table class="memname">

  1637.         <tr>

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

  1639.           <td>(</td>

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

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

  1642.         </tr>

  1643.         <tr>

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

  1645.           <td></td>

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

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

  1648.         </tr>

  1649.         <tr>

  1650.           <td></td>

  1651.           <td>)</td>

  1652.           <td></td><td></td>

  1653.         </tr>

  1654.       </table>

  1655.   </td>

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

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

  1658.   </tr>

  1659. </table>

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

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

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

  1663.   <table class="params">

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

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

  1666.   </table>

  1667.   </dd>

  1668. </dl>

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

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

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

  1672. 

  1673. </div>

  1674. </div>

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

  1676. <div class="memitem">

  1677. <div class="memproto">

  1678. <table class="mlabels">

  1679.   <tr>

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

  1681.       <table class="memname">

  1682.         <tr>

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

  1684.           <td>(</td>

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

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

  1687.         </tr>

  1688.         <tr>

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

  1690.           <td></td>

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

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

  1693.         </tr>

  1694.         <tr>

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

  1696.           <td></td>

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

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

  1699.         </tr>

  1700.         <tr>

  1701.           <td></td>

  1702.           <td>)</td>

  1703.           <td></td><td></td>

  1704.         </tr>

  1705.       </table>

  1706.   </td>

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

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

  1709.   </tr>

  1710. </table>

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

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

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

  1714.   <table class="params">

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

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

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

  1718.   </table>

  1719.   </dd>

  1720. </dl>

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

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

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

  1724. 

  1725. </div>

  1726. </div>

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

  1728. <div class="memitem">

  1729. <div class="memproto">

  1730. <table class="mlabels">

  1731.   <tr>

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

  1733.       <table class="memname">

  1734.         <tr>

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

  1736.           <td>(</td>

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

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

  1739.         </tr>

  1740.         <tr>

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

  1742.           <td></td>

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

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

  1745.         </tr>

  1746.         <tr>

  1747.           <td></td>

  1748.           <td>)</td>

  1749.           <td></td><td></td>

  1750.         </tr>

  1751.       </table>

  1752.   </td>

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

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

  1755.   </tr>

  1756. </table>

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

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

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

  1760.   <table class="params">

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

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

  1763.   </table>

  1764.   </dd>

  1765. </dl>

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

  1767. 

  1768. </div>

  1769. </div>

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

  1771. <div class="memitem">

  1772. <div class="memproto">

  1773. <table class="mlabels">

  1774.   <tr>

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

  1776.       <table class="memname">

  1777.         <tr>

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

  1779.           <td>(</td>

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

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

  1782.         </tr>

  1783.         <tr>

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

  1785.           <td></td>

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

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

  1788.         </tr>

  1789.         <tr>

  1790.           <td></td>

  1791.           <td>)</td>

  1792.           <td></td><td></td>

  1793.         </tr>

  1794.       </table>

  1795.   </td>

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

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

  1798.   </tr>

  1799. </table>

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

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

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

  1803.   <table class="params">

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

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

  1806.   </table>

  1807.   </dd>

  1808. </dl>

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

  1810. 

  1811. </div>

  1812. </div>

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

  1814. <div class="memitem">

  1815. <div class="memproto">

  1816. <table class="mlabels">

  1817.   <tr>

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

  1819.       <table class="memname">

  1820.         <tr>

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

  1822.           <td>(</td>

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

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

  1825.           <td></td>

  1826.         </tr>

  1827.       </table>

  1828.   </td>

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

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

  1831.   </tr>

  1832. </table>

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

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

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

  1836.   <table class="params">

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

  1838.   </table>

  1839.   </dd>

  1840. </dl>

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

  1842. 

  1843. </div>

  1844. </div>

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

  1846. <div class="memitem">

  1847. <div class="memproto">

  1848. <table class="mlabels">

  1849.   <tr>

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

  1851.       <table class="memname">

  1852.         <tr>

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

  1854.           <td>(</td>

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

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

  1857.         </tr>

  1858.         <tr>

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

  1860.           <td></td>

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

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

  1863.         </tr>

  1864.         <tr>

  1865.           <td></td>

  1866.           <td>)</td>

  1867.           <td></td><td></td>

  1868.         </tr>

  1869.       </table>

  1870.   </td>

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

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

  1873.   </tr>

  1874. </table>

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

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

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

  1878.   <table class="params">

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

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

  1881.   </table>

  1882.   </dd>

  1883. </dl>

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

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

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

  1887. 

  1888. </div>

  1889. </div>

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

  1891. <div class="memitem">

  1892. <div class="memproto">

  1893. <table class="mlabels">

  1894.   <tr>

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

  1896.       <table class="memname">

  1897.         <tr>

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

  1899.           <td>(</td>

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

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

  1902.           <td></td>

  1903.         </tr>

  1904.       </table>

  1905.   </td>

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

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

  1908.   </tr>

  1909. </table>

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

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

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

  1913.   <table class="params">

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

  1915.   </table>

  1916.   </dd>

  1917. </dl>

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

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

  1920. 

  1921. </div>

  1922. </div>

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

  1924. <div class="memitem">

  1925. <div class="memproto">

  1926. <table class="mlabels">

  1927.   <tr>

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

  1929.       <table class="memname">

  1930.         <tr>

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

  1932.           <td>(</td>

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

  1934.           <td> const</td>

  1935.         </tr>

  1936.       </table>

  1937.   </td>

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

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

  1940.   </tr>

  1941. </table>

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

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

  1944. 

  1945. </div>

  1946. </div>

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

  1948. <div class="memitem">

  1949. <div class="memproto">

  1950. <table class="mlabels">

  1951.   <tr>

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

  1953.       <table class="memname">

  1954.         <tr>

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

  1956.           <td>(</td>

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

  1958.           <td> const</td>

  1959.         </tr>

  1960.       </table>

  1961.   </td>

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

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

  1964.   </tr>

  1965. </table>

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

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

  1968. 

  1969. </div>

  1970. </div>

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

  1972. <div class="memitem">

  1973. <div class="memproto">

  1974. <table class="mlabels">

  1975.   <tr>

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

  1977.       <table class="memname">

  1978.         <tr>

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

  1980.           <td>(</td>

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

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

  1983.         </tr>

  1984.         <tr>

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

  1986.           <td></td>

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

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

  1989.         </tr>

  1990.         <tr>

  1991.           <td></td>

  1992.           <td>)</td>

  1993.           <td></td><td></td>

  1994.         </tr>

  1995.       </table>

  1996.   </td>

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

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

  1999.   </tr>

  2000. </table>

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

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

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

  2004.   <table class="params">

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

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

  2007.   </table>

  2008.   </dd>

  2009. </dl>

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

  2011. 

  2012. </div>

  2013. </div>

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

  2015. <div class="memitem">

  2016. <div class="memproto">

  2017. <table class="mlabels">

  2018.   <tr>

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

  2020.       <table class="memname">

  2021.         <tr>

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

  2023.           <td>(</td>

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

  2025.           <td></td>

  2026.         </tr>

  2027.       </table>

  2028.   </td>

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

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

  2031.   </tr>

  2032. </table>

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

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

  2035. 

  2036. </div>

  2037. </div>

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

  2039. <div class="memitem">

  2040. <div class="memproto">

  2041. <table class="mlabels">

  2042.   <tr>

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

  2044.       <table class="memname">

  2045.         <tr>

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

  2047.           <td>(</td>

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

  2049.           <td> const</td>

  2050.         </tr>

  2051.       </table>

  2052.   </td>

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

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

  2055.   </tr>

  2056. </table>

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

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

  2059. 

  2060. </div>

  2061. </div>

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

  2063. <div class="memitem">

  2064. <div class="memproto">

  2065. <table class="mlabels">

  2066.   <tr>

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

  2068.       <table class="memname">

  2069.         <tr>

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

  2071.           <td>(</td>

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

  2073.           <td></td>

  2074.         </tr>

  2075.       </table>

  2076.   </td>

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

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

  2079.   </tr>

  2080. </table>

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

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

  2083. 

  2084. </div>

  2085. </div>

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

  2087. <div class="memitem">

  2088. <div class="memproto">

  2089. <table class="mlabels">

  2090.   <tr>

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

  2092.       <table class="memname">

  2093.         <tr>

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

  2095.           <td>(</td>

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

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

  2098.           <td></td>

  2099.         </tr>

  2100.       </table>

  2101.   </td>

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

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

  2104.   </tr>

  2105. </table>

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

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

  2108.   <table class="params">

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

  2110.   </table>

  2111.   </dd>

  2112. </dl>

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

  2114. 

  2115. </div>

  2116. </div>

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

  2118. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  2119. <li>Arduino/libraries/SdFat/SdFatBase.cpp</li>

  2120. </ul>

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

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

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

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

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

  2126. </a> 1.8.8

  2127. </small></address>

  2128. </body>

  2129. </html>