visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
33 Commits
1 Branch
Tree: 1c74e428dd
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1c74e428dd'
${ noResults }
teensy-sdfat/html/class_sd_file_system.html

2423 lines
102KB
Raw Blame History 

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

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

  3. <head>

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

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

  6. <meta name="generator" content="Doxygen 1.8.10"/>

  7. <title>SdFat: SdFileSystem&lt; SdDriverClass &gt; Class Template Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/searchdata.js"></script>

  13. <script type="text/javascript" src="search/search.js"></script>

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

  15.   $(document).ready(function() { init_search(); });

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

  25.   <td id="projectalign" style="padding-left: 0.5em;">

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.10 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

  41.       <li 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. </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_file_system-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdFileSystem&lt; SdDriverClass &gt; Class Template Reference</div>  </div>

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

  90. <div class="contents">

  91. 

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

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

  94. 

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

  96. <div class="dynheader">

  97. Inheritance diagram for SdFileSystem&lt; SdDriverClass &gt;:</div>

  98. <div class="dyncontent">

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

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

  101. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="57,80,163,107"/>

  102. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="67,5,153,32"/>

  103. </map>

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

  105. <div class="dynheader">

  106. Collaboration diagram for SdFileSystem&lt; SdDriverClass &gt;:</div>

  107. <div class="dyncontent">

  108. <div class="center"><img src="class_sd_file_system__coll__graph.png" border="0" usemap="#_sd_file_system_3_01_sd_driver_class_01_4_coll__map" alt="Collaboration graph"/></div>

  109. <map name="_sd_file_system_3_01_sd_driver_class_01_4_coll__map" id="_sd_file_system_3_01_sd_driver_class_01_4_coll__map">

  110. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="57,80,163,107"/>

  111. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="67,5,153,32"/>

  112. </map>

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

  114. <table class="memberdecls">

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

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

  117. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>

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

  119. <tr class="memitem:a8af43bd882cc5189217ee4d75b55274e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin</a> (<a class="el" href="_sd_spi_driver_8h.html#abf391604c1ecfed19cdcb6c8bd626972">SdSpiDriver</a> *spi, uint8_t csPin, SPISettings spiSettings)</td></tr>

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

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

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

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

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

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

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

  127. <tr class="memitem:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memItemLeft" align="right" valign="top">SdDriverClass *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab5dcfbeeb7caa38a38db86003341eb07">card</a> ()</td></tr>

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

  129. <tr class="memitem:a85a595f89f612818de51a5a5c23fe0d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a85a595f89f612818de51a5a5c23fe0d4">cardBegin</a> (<a class="el" href="_sd_spi_driver_8h.html#abf391604c1ecfed19cdcb6c8bd626972">SdSpiDriver</a> *spi, uint8_t csPin, SPISettings spiSettings)</td></tr>

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

  131. <tr class="memitem:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#aedfd5a0830c955bc5514e52f2f2dd066">cardErrorCode</a> ()</td></tr>

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

  133. <tr class="memitem:a7bb044ff05e84cf9848ee78b20bd9251"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a7bb044ff05e84cf9848ee78b20bd9251">cardErrorData</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  223. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><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#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  245. </table>

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

  247. <div class="textblock"><h3>template&lt;class SdDriverClass&gt;<br />

  248. class SdFileSystem&lt; SdDriverClass &gt;</h3>

  249. 

  250. <p>Virtual base class for SdFat library. </p>

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

  252. <a class="anchor" id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>

  253. <div class="memitem">

  254. <div class="memproto">

  255. <table class="mlabels">

  256.   <tr>

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

  258.       <table class="memname">

  259.         <tr>

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

  261.           <td>(</td>

  262.           <td class="paramtype"><a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *&#160;</td>

  263.           <td class="paramname"><em>blockDev</em>, </td>

  264.         </tr>

  265.         <tr>

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

  267.           <td></td>

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

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

  270.         </tr>

  271.         <tr>

  272.           <td></td>

  273.           <td>)</td>

  274.           <td></td><td></td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

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

  284.   <table class="params">

  285.     <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>

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

  287.   </table>

  288.   </dd>

  289. </dl>

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

  291. 

  292. </div>

  293. </div>

  294. <a class="anchor" id="a8af43bd882cc5189217ee4d75b55274e"></a>

  295. <div class="memitem">

  296. <div class="memproto">

  297. <div class="memtemplate">

  298. template&lt;class SdDriverClass&gt; </div>

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

  304.           <td class="memname">bool <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::begin </td>

  305.           <td>(</td>

  306.           <td class="paramtype"><a class="el" href="_sd_spi_driver_8h.html#abf391604c1ecfed19cdcb6c8bd626972">SdSpiDriver</a> *&#160;</td>

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

  308.         </tr>

  309.         <tr>

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

  311.           <td></td>

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

  313.           <td class="paramname"><em>csPin</em>, </td>

  314.         </tr>

  315.         <tr>

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

  317.           <td></td>

  318.           <td class="paramtype">SPISettings&#160;</td>

  319.           <td class="paramname"><em>spiSettings</em>&#160;</td>

  320.         </tr>

  321.         <tr>

  322.           <td></td>

  323.           <td>)</td>

  324.           <td></td><td></td>

  325.         </tr>

  326.       </table>

  327.   </td>

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

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

  330.   </tr>

  331. </table>

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

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

  334.   <table class="params">

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

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

  337.     <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>

  338.   </table>

  339.   </dd>

  340. </dl>

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

  342. 

  343. </div>

  344. </div>

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

  346. <div class="memitem">

  347. <div class="memproto">

  348. <table class="mlabels">

  349.   <tr>

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

  351.       <table class="memname">

  352.         <tr>

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

  354.           <td>(</td>

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

  356.           <td> const</td>

  357.         </tr>

  358.       </table>

  359.   </td>

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

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

  362.   </tr>

  363. </table>

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

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

  366. 

  367. </div>

  368. </div>

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

  370. <div class="memitem">

  371. <div class="memproto">

  372. <table class="mlabels">

  373.   <tr>

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

  375.       <table class="memname">

  376.         <tr>

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

  378.           <td>(</td>

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

  380.           <td> const</td>

  381.         </tr>

  382.       </table>

  383.   </td>

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

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

  386.   </tr>

  387. </table>

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

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

  390. 

  391. </div>

  392. </div>

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

  394. <div class="memitem">

  395. <div class="memproto">

  396. <table class="mlabels">

  397.   <tr>

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

  399.       <table class="memname">

  400.         <tr>

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

  402.           <td>(</td>

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

  404.           <td></td>

  405.         </tr>

  406.       </table>

  407.   </td>

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

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

  410.   </tr>

  411. </table>

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

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

  414. 

  415. </div>

  416. </div>

  417. <a class="anchor" id="ab5dcfbeeb7caa38a38db86003341eb07"></a>

  418. <div class="memitem">

  419. <div class="memproto">

  420. <div class="memtemplate">

  421. template&lt;class SdDriverClass&gt; </div>

  422. <table class="mlabels">

  423.   <tr>

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

  425.       <table class="memname">

  426.         <tr>

  427.           <td class="memname">SdDriverClass* <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::card </td>

  428.           <td>(</td>

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

  430.           <td></td>

  431.         </tr>

  432.       </table>

  433.   </td>

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

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

  436.   </tr>

  437. </table>

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

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

  440. 

  441. </div>

  442. </div>

  443. <a class="anchor" id="a85a595f89f612818de51a5a5c23fe0d4"></a>

  444. <div class="memitem">

  445. <div class="memproto">

  446. <div class="memtemplate">

  447. template&lt;class SdDriverClass&gt; </div>

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

  453.           <td class="memname">bool <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::cardBegin </td>

  454.           <td>(</td>

  455.           <td class="paramtype"><a class="el" href="_sd_spi_driver_8h.html#abf391604c1ecfed19cdcb6c8bd626972">SdSpiDriver</a> *&#160;</td>

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

  457.         </tr>

  458.         <tr>

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

  460.           <td></td>

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

  462.           <td class="paramname"><em>csPin</em>, </td>

  463.         </tr>

  464.         <tr>

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

  466.           <td></td>

  467.           <td class="paramtype">SPISettings&#160;</td>

  468.           <td class="paramname"><em>spiSettings</em>&#160;</td>

  469.         </tr>

  470.         <tr>

  471.           <td></td>

  472.           <td>)</td>

  473.           <td></td><td></td>

  474.         </tr>

  475.       </table>

  476.   </td>

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

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

  479.   </tr>

  480. </table>

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

  482. <p>Initialize SD card for diagnostic use. </p><dl class="params"><dt>Parameters</dt><dd>

  483.   <table class="params">

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

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

  486.     <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>

  487.   </table>

  488.   </dd>

  489. </dl>

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

  491. 

  492. </div>

  493. </div>

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

  495. <div class="memitem">

  496. <div class="memproto">

  497. <div class="memtemplate">

  498. template&lt;class SdDriverClass&gt; </div>

  499. <table class="mlabels">

  500.   <tr>

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

  502.       <table class="memname">

  503.         <tr>

  504.           <td class="memname">uint8_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::cardErrorCode </td>

  505.           <td>(</td>

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

  507.           <td></td>

  508.         </tr>

  509.       </table>

  510.   </td>

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

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

  513.   </tr>

  514. </table>

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

  516. <dl class="section return"><dt>Returns</dt><dd>The card error code </dd></dl>

  517. 

  518. </div>

  519. </div>

  520. <a class="anchor" id="a7bb044ff05e84cf9848ee78b20bd9251"></a>

  521. <div class="memitem">

  522. <div class="memproto">

  523. <div class="memtemplate">

  524. template&lt;class SdDriverClass&gt; </div>

  525. <table class="mlabels">

  526.   <tr>

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

  528.       <table class="memname">

  529.         <tr>

  530.           <td class="memname">uint8_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::cardErrorData </td>

  531.           <td>(</td>

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

  533.           <td></td>

  534.         </tr>

  535.       </table>

  536.   </td>

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

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

  539.   </tr>

  540. </table>

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

  542. <dl class="section return"><dt>Returns</dt><dd>the card error data </dd></dl>

  543. 

  544. </div>

  545. </div>

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

  547. <div class="memitem">

  548. <div class="memproto">

  549. <table class="mlabels">

  550.   <tr>

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

  552.       <table class="memname">

  553.         <tr>

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

  555.           <td>(</td>

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

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

  558.           <td></td>

  559.         </tr>

  560.       </table>

  561.   </td>

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

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

  564.   </tr>

  565. </table>

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

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

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

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

  570.   <table class="params">

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

  572.   </table>

  573.   </dd>

  574. </dl>

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

  576. 

  577. </div>

  578. </div>

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

  580. <div class="memitem">

  581. <div class="memproto">

  582. <table class="mlabels">

  583.   <tr>

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

  585.       <table class="memname">

  586.         <tr>

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

  588.           <td>(</td>

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

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

  591.         </tr>

  592.         <tr>

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

  594.           <td></td>

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

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

  597.         </tr>

  598.         <tr>

  599.           <td></td>

  600.           <td>)</td>

  601.           <td></td><td></td>

  602.         </tr>

  603.       </table>

  604.   </td>

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

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

  607.   </tr>

  608. </table>

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

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

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

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

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

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

  615.   <table class="params">

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

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

  618.   </table>

  619.   </dd>

  620. </dl>

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

  622. 

  623. </div>

  624. </div>

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

  626. <div class="memitem">

  627. <div class="memproto">

  628. <table class="mlabels">

  629.   <tr>

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

  631.       <table class="memname">

  632.         <tr>

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

  634.           <td>(</td>

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

  636.           <td></td>

  637.         </tr>

  638.       </table>

  639.   </td>

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

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

  642.   </tr>

  643. </table>

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

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

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

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

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

  649. 

  650. </div>

  651. </div>

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

  653. <div class="memitem">

  654. <div class="memproto">

  655. <table class="mlabels">

  656.   <tr>

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

  658.       <table class="memname">

  659.         <tr>

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

  661.           <td>(</td>

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

  663.           <td> const</td>

  664.         </tr>

  665.       </table>

  666.   </td>

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

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

  669.   </tr>

  670. </table>

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

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

  673. 

  674. </div>

  675. </div>

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

  677. <div class="memitem">

  678. <div class="memproto">

  679. <table class="mlabels">

  680.   <tr>

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

  682.       <table class="memname">

  683.         <tr>

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

  685.           <td>(</td>

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

  687.           <td> const</td>

  688.         </tr>

  689.       </table>

  690.   </td>

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

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

  693.   </tr>

  694. </table>

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

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

  697. 

  698. </div>

  699. </div>

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

  701. <div class="memitem">

  702. <div class="memproto">

  703. <table class="mlabels">

  704.   <tr>

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

  706.       <table class="memname">

  707.         <tr>

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

  709.           <td>(</td>

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

  711.           <td> const</td>

  712.         </tr>

  713.       </table>

  714.   </td>

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

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

  717.   </tr>

  718. </table>

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

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

  721. 

  722. </div>

  723. </div>

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

  725. <div class="memitem">

  726. <div class="memproto">

  727. <table class="mlabels">

  728.   <tr>

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

  730.       <table class="memname">

  731.         <tr>

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

  733.           <td>(</td>

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

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

  736.         </tr>

  737.         <tr>

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

  739.           <td></td>

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

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

  742.         </tr>

  743.         <tr>

  744.           <td></td>

  745.           <td>)</td>

  746.           <td></td><td></td>

  747.         </tr>

  748.       </table>

  749.   </td>

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

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

  752.   </tr>

  753. </table>

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

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

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

  757.   <table class="params">

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

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

  760.   </table>

  761.   </dd>

  762. </dl>

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

  764. 

  765. </div>

  766. </div>

  767. <a class="anchor" id="a855267374306bfee2df67642c99d4d18"></a>

  768. <div class="memitem">

  769. <div class="memproto">

  770. <div class="memtemplate">

  771. template&lt;class SdDriverClass&gt; </div>

  772. <table class="mlabels">

  773.   <tr>

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

  775.       <table class="memname">

  776.         <tr>

  777.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  778.           <td>(</td>

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

  780.           <td></td>

  781.         </tr>

  782.       </table>

  783.   </td>

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

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

  786.   </tr>

  787. </table>

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

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

  790. 

  791. </div>

  792. </div>

  793. <a class="anchor" id="ae1f79a2974ebe134e70f898c32d97e98"></a>

  794. <div class="memitem">

  795. <div class="memproto">

  796. <div class="memtemplate">

  797. template&lt;class SdDriverClass&gt; </div>

  798. <table class="mlabels">

  799.   <tr>

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

  801.       <table class="memname">

  802.         <tr>

  803.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  804.           <td>(</td>

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

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

  807.           <td></td>

  808.         </tr>

  809.       </table>

  810.   </td>

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

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

  813.   </tr>

  814. </table>

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

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

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

  818.   <table class="params">

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

  820.   </table>

  821.   </dd>

  822. </dl>

  823. 

  824. </div>

  825. </div>

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

  827. <div class="memitem">

  828. <div class="memproto">

  829. <div class="memtemplate">

  830. template&lt;class SdDriverClass&gt; </div>

  831. <table class="mlabels">

  832.   <tr>

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

  834.       <table class="memname">

  835.         <tr>

  836.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  837.           <td>(</td>

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

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

  840.           <td></td>

  841.         </tr>

  842.       </table>

  843.   </td>

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

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

  846.   </tr>

  847. </table>

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

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

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

  851.   <table class="params">

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

  853.   </table>

  854.   </dd>

  855. </dl>

  856. 

  857. </div>

  858. </div>

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

  860. <div class="memitem">

  861. <div class="memproto">

  862. <div class="memtemplate">

  863. template&lt;class SdDriverClass&gt; </div>

  864. <table class="mlabels">

  865.   <tr>

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

  867.       <table class="memname">

  868.         <tr>

  869.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  870.           <td>(</td>

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

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

  873.         </tr>

  874.         <tr>

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

  876.           <td></td>

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

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

  879.         </tr>

  880.         <tr>

  881.           <td></td>

  882.           <td>)</td>

  883.           <td></td><td></td>

  884.         </tr>

  885.       </table>

  886.   </td>

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

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

  889.   </tr>

  890. </table>

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

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

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

  894.   <table class="params">

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

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

  897.   </table>

  898.   </dd>

  899. </dl>

  900. 

  901. </div>

  902. </div>

  903. <a class="anchor" id="af856494745a9842d9728dfeabf19c51e"></a>

  904. <div class="memitem">

  905. <div class="memproto">

  906. <div class="memtemplate">

  907. template&lt;class SdDriverClass&gt; </div>

  908. <table class="mlabels">

  909.   <tr>

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

  911.       <table class="memname">

  912.         <tr>

  913.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  914.           <td>(</td>

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

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

  917.           <td></td>

  918.         </tr>

  919.       </table>

  920.   </td>

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

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

  923.   </tr>

  924. </table>

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

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

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

  928.   <table class="params">

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

  930.   </table>

  931.   </dd>

  932. </dl>

  933. 

  934. </div>

  935. </div>

  936. <a class="anchor" id="a746c80d048c30baf0b281e16932670a2"></a>

  937. <div class="memitem">

  938. <div class="memproto">

  939. <div class="memtemplate">

  940. template&lt;class SdDriverClass&gt; </div>

  941. <table class="mlabels">

  942.   <tr>

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

  944.       <table class="memname">

  945.         <tr>

  946.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>

  947.           <td>(</td>

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

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

  950.         </tr>

  951.         <tr>

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

  953.           <td></td>

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

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

  956.         </tr>

  957.         <tr>

  958.           <td></td>

  959.           <td>)</td>

  960.           <td></td><td></td>

  961.         </tr>

  962.       </table>

  963.   </td>

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

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

  966.   </tr>

  967. </table>

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

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

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

  971.   <table class="params">

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

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

  974.   </table>

  975.   </dd>

  976. </dl>

  977. 

  978. </div>

  979. </div>

  980. <a class="anchor" id="ab0b78154d6874c29279ba81f36ccb09c"></a>

  981. <div class="memitem">

  982. <div class="memproto">

  983. <div class="memtemplate">

  984. template&lt;class SdDriverClass&gt; </div>

  985. <table class="mlabels">

  986.   <tr>

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

  988.       <table class="memname">

  989.         <tr>

  990.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  991.           <td>(</td>

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

  993.           <td></td>

  994.         </tr>

  995.       </table>

  996.   </td>

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

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

  999.   </tr>

  1000. </table>

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

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

  1003. 

  1004. </div>

  1005. </div>

  1006. <a class="anchor" id="a03736274debea71fef5e2ff34d7ec3dc"></a>

  1007. <div class="memitem">

  1008. <div class="memproto">

  1009. <div class="memtemplate">

  1010. template&lt;class SdDriverClass&gt; </div>

  1011. <table class="mlabels">

  1012.   <tr>

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

  1014.       <table class="memname">

  1015.         <tr>

  1016.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  1017.           <td>(</td>

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

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

  1020.           <td></td>

  1021.         </tr>

  1022.       </table>

  1023.   </td>

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

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

  1026.   </tr>

  1027. </table>

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

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

  1030.   <table class="params">

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

  1032.   </table>

  1033.   </dd>

  1034. </dl>

  1035. 

  1036. </div>

  1037. </div>

  1038. <a class="anchor" id="a2e2436b7b2666737cbaf4b22218bc69f"></a>

  1039. <div class="memitem">

  1040. <div class="memproto">

  1041. <div class="memtemplate">

  1042. template&lt;class SdDriverClass&gt; </div>

  1043. <table class="mlabels">

  1044.   <tr>

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

  1046.       <table class="memname">

  1047.         <tr>

  1048.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  1049.           <td>(</td>

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

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

  1052.           <td></td>

  1053.         </tr>

  1054.       </table>

  1055.   </td>

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

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

  1058.   </tr>

  1059. </table>

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

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

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

  1063.   <table class="params">

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

  1065.   </table>

  1066.   </dd>

  1067. </dl>

  1068. 

  1069. </div>

  1070. </div>

  1071. <a class="anchor" id="a0eb6b92a0700ba932f6127962981d153"></a>

  1072. <div class="memitem">

  1073. <div class="memproto">

  1074. <div class="memtemplate">

  1075. template&lt;class SdDriverClass&gt; </div>

  1076. <table class="mlabels">

  1077.   <tr>

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

  1079.       <table class="memname">

  1080.         <tr>

  1081.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  1082.           <td>(</td>

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

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

  1085.         </tr>

  1086.         <tr>

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

  1088.           <td></td>

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

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

  1091.         </tr>

  1092.         <tr>

  1093.           <td></td>

  1094.           <td>)</td>

  1095.           <td></td><td></td>

  1096.         </tr>

  1097.       </table>

  1098.   </td>

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

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

  1101.   </tr>

  1102. </table>

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

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

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

  1106.   <table class="params">

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

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

  1109.   </table>

  1110.   </dd>

  1111. </dl>

  1112. 

  1113. </div>

  1114. </div>

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

  1116. <div class="memitem">

  1117. <div class="memproto">

  1118. <div class="memtemplate">

  1119. template&lt;class SdDriverClass&gt; </div>

  1120. <table class="mlabels">

  1121.   <tr>

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

  1123.       <table class="memname">

  1124.         <tr>

  1125.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  1126.           <td>(</td>

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

  1128.           <td class="paramname"><em>msg</em></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>Print msg, any SD error code.</p>

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

  1140.   <table class="params">

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

  1142.   </table>

  1143.   </dd>

  1144. </dl>

  1145. 

  1146. </div>

  1147. </div>

  1148. <a class="anchor" id="a43344a079d9af92ea4b550914d0512f6"></a>

  1149. <div class="memitem">

  1150. <div class="memproto">

  1151. <div class="memtemplate">

  1152. template&lt;class SdDriverClass&gt; </div>

  1153. <table class="mlabels">

  1154.   <tr>

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

  1156.       <table class="memname">

  1157.         <tr>

  1158.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>

  1159.           <td>(</td>

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

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

  1162.         </tr>

  1163.         <tr>

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

  1165.           <td></td>

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

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

  1168.         </tr>

  1169.         <tr>

  1170.           <td></td>

  1171.           <td>)</td>

  1172.           <td></td><td></td>

  1173.         </tr>

  1174.       </table>

  1175.   </td>

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

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

  1178.   </tr>

  1179. </table>

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

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

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

  1183.   <table class="params">

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

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

  1186.   </table>

  1187.   </dd>

  1188. </dl>

  1189. 

  1190. </div>

  1191. </div>

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

  1193. <div class="memitem">

  1194. <div class="memproto">

  1195. <table class="mlabels">

  1196.   <tr>

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

  1198.       <table class="memname">

  1199.         <tr>

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

  1201.           <td>(</td>

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

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

  1204.           <td></td>

  1205.         </tr>

  1206.       </table>

  1207.   </td>

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

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

  1210.   </tr>

  1211. </table>

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

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

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

  1215.   <table class="params">

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

  1217.   </table>

  1218.   </dd>

  1219. </dl>

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

  1221. 

  1222. </div>

  1223. </div>

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

  1225. <div class="memitem">

  1226. <div class="memproto">

  1227. <table class="mlabels">

  1228.   <tr>

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

  1230.       <table class="memname">

  1231.         <tr>

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

  1233.           <td>(</td>

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

  1235.           <td></td>

  1236.         </tr>

  1237.       </table>

  1238.   </td>

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

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

  1241.   </tr>

  1242. </table>

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

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

  1245. 

  1246. </div>

  1247. </div>

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

  1249. <div class="memitem">

  1250. <div class="memproto">

  1251. <table class="mlabels">

  1252.   <tr>

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

  1254.       <table class="memname">

  1255.         <tr>

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

  1257.           <td>(</td>

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

  1259.           <td> const</td>

  1260.         </tr>

  1261.       </table>

  1262.   </td>

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

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

  1265.   </tr>

  1266. </table>

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

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

  1269. 

  1270. </div>

  1271. </div>

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

  1273. <div class="memitem">

  1274. <div class="memproto">

  1275. <table class="mlabels">

  1276.   <tr>

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

  1278.       <table class="memname">

  1279.         <tr>

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

  1281.           <td>(</td>

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

  1283.           <td> const</td>

  1284.         </tr>

  1285.       </table>

  1286.   </td>

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

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

  1289.   </tr>

  1290. </table>

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

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

  1293. 

  1294. </div>

  1295. </div>

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

  1297. <div class="memitem">

  1298. <div class="memproto">

  1299. <table class="mlabels">

  1300.   <tr>

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

  1302.       <table class="memname">

  1303.         <tr>

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

  1305.           <td>(</td>

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

  1307.           <td></td>

  1308.         </tr>

  1309.       </table>

  1310.   </td>

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

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

  1313.   </tr>

  1314. </table>

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

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

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

  1318. 

  1319. </div>

  1320. </div>

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

  1322. <div class="memitem">

  1323. <div class="memproto">

  1324. <table class="mlabels">

  1325.   <tr>

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

  1327.       <table class="memname">

  1328.         <tr>

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

  1330.           <td>(</td>

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

  1332.           <td></td>

  1333.         </tr>

  1334.       </table>

  1335.   </td>

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

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

  1338.   </tr>

  1339. </table>

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

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

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

  1343. 

  1344. </div>

  1345. </div>

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

  1347. <div class="memitem">

  1348. <div class="memproto">

  1349. <table class="mlabels">

  1350.   <tr>

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

  1352.       <table class="memname">

  1353.         <tr>

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

  1355.           <td>(</td>

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

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

  1358.           <td></td>

  1359.         </tr>

  1360.       </table>

  1361.   </td>

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

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

  1364.   </tr>

  1365. </table>

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

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

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

  1369.   <table class="params">

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

  1371.   </table>

  1372.   </dd>

  1373. </dl>

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

  1375. 

  1376. </div>

  1377. </div>

  1378. <a class="anchor" id="a8e1f26486bb878a24fa9868e59dbbbc2"></a>

  1379. <div class="memitem">

  1380. <div class="memproto">

  1381. <div class="memtemplate">

  1382. template&lt;class SdDriverClass&gt; </div>

  1383. <table class="mlabels">

  1384.   <tr>

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

  1386.       <table class="memname">

  1387.         <tr>

  1388.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1389.           <td>(</td>

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

  1391.           <td></td>

  1392.         </tr>

  1393.       </table>

  1394.   </td>

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

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

  1397.   </tr>

  1398. </table>

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

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

  1401. 

  1402. </div>

  1403. </div>

  1404. <a class="anchor" id="a24bd0f699cf0fe11fd2148b15c49251a"></a>

  1405. <div class="memitem">

  1406. <div class="memproto">

  1407. <div class="memtemplate">

  1408. template&lt;class SdDriverClass&gt; </div>

  1409. <table class="mlabels">

  1410.   <tr>

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

  1412.       <table class="memname">

  1413.         <tr>

  1414.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1415.           <td>(</td>

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

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

  1418.           <td></td>

  1419.         </tr>

  1420.       </table>

  1421.   </td>

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

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

  1424.   </tr>

  1425. </table>

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

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

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

  1429.   <table class="params">

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

  1431.   </table>

  1432.   </dd>

  1433. </dl>

  1434. 

  1435. </div>

  1436. </div>

  1437. <a class="anchor" id="a893833a880e2a83757480ba4c1351041"></a>

  1438. <div class="memitem">

  1439. <div class="memproto">

  1440. <div class="memtemplate">

  1441. template&lt;class SdDriverClass&gt; </div>

  1442. <table class="mlabels">

  1443.   <tr>

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

  1445.       <table class="memname">

  1446.         <tr>

  1447.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1448.           <td>(</td>

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

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

  1451.           <td></td>

  1452.         </tr>

  1453.       </table>

  1454.   </td>

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

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

  1457.   </tr>

  1458. </table>

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

  1460. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1462.   <table class="params">

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

  1464.   </table>

  1465.   </dd>

  1466. </dl>

  1467. 

  1468. </div>

  1469. </div>

  1470. <a class="anchor" id="a3077b1a53d789d0401b707963cb28f46"></a>

  1471. <div class="memitem">

  1472. <div class="memproto">

  1473. <div class="memtemplate">

  1474. template&lt;class SdDriverClass&gt; </div>

  1475. <table class="mlabels">

  1476.   <tr>

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

  1478.       <table class="memname">

  1479.         <tr>

  1480.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1481.           <td>(</td>

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

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

  1484.         </tr>

  1485.         <tr>

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

  1487.           <td></td>

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

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

  1490.         </tr>

  1491.         <tr>

  1492.           <td></td>

  1493.           <td>)</td>

  1494.           <td></td><td></td>

  1495.         </tr>

  1496.       </table>

  1497.   </td>

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

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

  1500.   </tr>

  1501. </table>

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

  1503. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1504.   <table class="params">

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

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

  1507.   </table>

  1508.   </dd>

  1509. </dl>

  1510. 

  1511. </div>

  1512. </div>

  1513. <a class="anchor" id="a2a1e4cc8056ba23b55dfa2c6486b8798"></a>

  1514. <div class="memitem">

  1515. <div class="memproto">

  1516. <div class="memtemplate">

  1517. template&lt;class SdDriverClass&gt; </div>

  1518. <table class="mlabels">

  1519.   <tr>

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

  1521.       <table class="memname">

  1522.         <tr>

  1523.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1524.           <td>(</td>

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

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

  1527.           <td></td>

  1528.         </tr>

  1529.       </table>

  1530.   </td>

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

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

  1533.   </tr>

  1534. </table>

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

  1536. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1538.   <table class="params">

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

  1540.   </table>

  1541.   </dd>

  1542. </dl>

  1543. 

  1544. </div>

  1545. </div>

  1546. <a class="anchor" id="ab03d98012dea18733c3252f27832de69"></a>

  1547. <div class="memitem">

  1548. <div class="memproto">

  1549. <div class="memtemplate">

  1550. template&lt;class SdDriverClass&gt; </div>

  1551. <table class="mlabels">

  1552.   <tr>

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

  1554.       <table class="memname">

  1555.         <tr>

  1556.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>

  1557.           <td>(</td>

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

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

  1560.         </tr>

  1561.         <tr>

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

  1563.           <td></td>

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

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

  1566.         </tr>

  1567.         <tr>

  1568.           <td></td>

  1569.           <td>)</td>

  1570.           <td></td><td></td>

  1571.         </tr>

  1572.       </table>

  1573.   </td>

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

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

  1576.   </tr>

  1577. </table>

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

  1579. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1580.   <table class="params">

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

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

  1583.   </table>

  1584.   </dd>

  1585. </dl>

  1586. 

  1587. </div>

  1588. </div>

  1589. <a class="anchor" id="ae31c9cbd7e1c03129d6c99b25f73cd50"></a>

  1590. <div class="memitem">

  1591. <div class="memproto">

  1592. <div class="memtemplate">

  1593. template&lt;class SdDriverClass&gt; </div>

  1594. <table class="mlabels">

  1595.   <tr>

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

  1597.       <table class="memname">

  1598.         <tr>

  1599.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1600.           <td>(</td>

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

  1602.           <td></td>

  1603.         </tr>

  1604.       </table>

  1605.   </td>

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

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

  1608.   </tr>

  1609. </table>

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

  1611. <p>Print error details after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails. </p>

  1612. 

  1613. </div>

  1614. </div>

  1615. <a class="anchor" id="a066707dce0667213b5f083d59f67448d"></a>

  1616. <div class="memitem">

  1617. <div class="memproto">

  1618. <div class="memtemplate">

  1619. template&lt;class SdDriverClass&gt; </div>

  1620. <table class="mlabels">

  1621.   <tr>

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

  1623.       <table class="memname">

  1624.         <tr>

  1625.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1626.           <td>(</td>

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

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

  1629.           <td></td>

  1630.         </tr>

  1631.       </table>

  1632.   </td>

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

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

  1635.   </tr>

  1636. </table>

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

  1638. <p>Print error details after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1640.   <table class="params">

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

  1642.   </table>

  1643.   </dd>

  1644. </dl>

  1645. 

  1646. </div>

  1647. </div>

  1648. <a class="anchor" id="a538796f79fd9db9c5bbeefd9defe639a"></a>

  1649. <div class="memitem">

  1650. <div class="memproto">

  1651. <div class="memtemplate">

  1652. template&lt;class SdDriverClass&gt; </div>

  1653. <table class="mlabels">

  1654.   <tr>

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

  1656.       <table class="memname">

  1657.         <tr>

  1658.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1659.           <td>(</td>

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

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

  1662.           <td></td>

  1663.         </tr>

  1664.       </table>

  1665.   </td>

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

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

  1668.   </tr>

  1669. </table>

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

  1671. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1673.   <table class="params">

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

  1675.   </table>

  1676.   </dd>

  1677. </dl>

  1678. 

  1679. </div>

  1680. </div>

  1681. <a class="anchor" id="ad9855d33ebd465715b706d0926291b13"></a>

  1682. <div class="memitem">

  1683. <div class="memproto">

  1684. <div class="memtemplate">

  1685. template&lt;class SdDriverClass&gt; </div>

  1686. <table class="mlabels">

  1687.   <tr>

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

  1689.       <table class="memname">

  1690.         <tr>

  1691.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1692.           <td>(</td>

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

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

  1695.         </tr>

  1696.         <tr>

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

  1698.           <td></td>

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

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

  1701.         </tr>

  1702.         <tr>

  1703.           <td></td>

  1704.           <td>)</td>

  1705.           <td></td><td></td>

  1706.         </tr>

  1707.       </table>

  1708.   </td>

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

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

  1711.   </tr>

  1712. </table>

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

  1714. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1716.   <table class="params">

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

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

  1719.   </table>

  1720.   </dd>

  1721. </dl>

  1722. 

  1723. </div>

  1724. </div>

  1725. <a class="anchor" id="ad6ffec5a7d82be46d46b8a4f82d0803b"></a>

  1726. <div class="memitem">

  1727. <div class="memproto">

  1728. <div class="memtemplate">

  1729. template&lt;class SdDriverClass&gt; </div>

  1730. <table class="mlabels">

  1731.   <tr>

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

  1733.       <table class="memname">

  1734.         <tr>

  1735.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1736.           <td>(</td>

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

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

  1739.           <td></td>

  1740.         </tr>

  1741.       </table>

  1742.   </td>

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

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

  1745.   </tr>

  1746. </table>

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

  1748. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1750.   <table class="params">

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

  1752.   </table>

  1753.   </dd>

  1754. </dl>

  1755. 

  1756. </div>

  1757. </div>

  1758. <a class="anchor" id="a8a2018b6366145a9843d3d29a47d6560"></a>

  1759. <div class="memitem">

  1760. <div class="memproto">

  1761. <div class="memtemplate">

  1762. template&lt;class SdDriverClass&gt; </div>

  1763. <table class="mlabels">

  1764.   <tr>

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

  1766.       <table class="memname">

  1767.         <tr>

  1768.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>

  1769.           <td>(</td>

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

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

  1772.         </tr>

  1773.         <tr>

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

  1775.           <td></td>

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

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

  1778.         </tr>

  1779.         <tr>

  1780.           <td></td>

  1781.           <td>)</td>

  1782.           <td></td><td></td>

  1783.         </tr>

  1784.       </table>

  1785.   </td>

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

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

  1788.   </tr>

  1789. </table>

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

  1791. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#a8af43bd882cc5189217ee4d75b55274e">begin()</a> fails.</p>

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

  1793.   <table class="params">

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

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

  1796.   </table>

  1797.   </dd>

  1798. </dl>

  1799. 

  1800. </div>

  1801. </div>

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

  1803. <div class="memitem">

  1804. <div class="memproto">

  1805. <table class="mlabels">

  1806.   <tr>

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

  1808.       <table class="memname">

  1809.         <tr>

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

  1811.           <td>(</td>

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

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

  1814.           <td></td>

  1815.         </tr>

  1816.       </table>

  1817.   </td>

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

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

  1820.   </tr>

  1821. </table>

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

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

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

  1825.   <table class="params">

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

  1827.   </table>

  1828.   </dd>

  1829. </dl>

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

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

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

  1833. 

  1834. </div>

  1835. </div>

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

  1837. <div class="memitem">

  1838. <div class="memproto">

  1839. <table class="mlabels">

  1840.   <tr>

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

  1842.       <table class="memname">

  1843.         <tr>

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

  1845.           <td>(</td>

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

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

  1848.         </tr>

  1849.         <tr>

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

  1851.           <td></td>

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

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

  1854.         </tr>

  1855.         <tr>

  1856.           <td></td>

  1857.           <td>)</td>

  1858.           <td></td><td></td>

  1859.         </tr>

  1860.       </table>

  1861.   </td>

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

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

  1864.   </tr>

  1865. </table>

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

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

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

  1869.   <table class="params">

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

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

  1872.   </table>

  1873.   </dd>

  1874. </dl>

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

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

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

  1878. 

  1879. </div>

  1880. </div>

  1881. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>

  1882. <div class="memitem">

  1883. <div class="memproto">

  1884. <table class="mlabels">

  1885.   <tr>

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

  1887.       <table class="memname">

  1888.         <tr>

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

  1890.           <td>(</td>

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

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

  1893.         </tr>

  1894.         <tr>

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

  1896.           <td></td>

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

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

  1899.         </tr>

  1900.         <tr>

  1901.           <td></td>

  1902.           <td>)</td>

  1903.           <td></td><td></td>

  1904.         </tr>

  1905.       </table>

  1906.   </td>

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

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

  1909.   </tr>

  1910. </table>

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

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

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

  1914.   <table class="params">

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

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

  1917.   </table>

  1918.   </dd>

  1919. </dl>

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

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

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

  1923. 

  1924. </div>

  1925. </div>

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

  1927. <div class="memitem">

  1928. <div class="memproto">

  1929. <table class="mlabels">

  1930.   <tr>

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

  1932.       <table class="memname">

  1933.         <tr>

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

  1935.           <td>(</td>

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

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

  1938.         </tr>

  1939.         <tr>

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

  1941.           <td></td>

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

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

  1944.         </tr>

  1945.         <tr>

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

  1947.           <td></td>

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

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

  1950.         </tr>

  1951.         <tr>

  1952.           <td></td>

  1953.           <td>)</td>

  1954.           <td></td><td></td>

  1955.         </tr>

  1956.       </table>

  1957.   </td>

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

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

  1960.   </tr>

  1961. </table>

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

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

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

  1965.   <table class="params">

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

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

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

  1969.   </table>

  1970.   </dd>

  1971. </dl>

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

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

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

  1975. 

  1976. </div>

  1977. </div>

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

  1979. <div class="memitem">

  1980. <div class="memproto">

  1981. <table class="mlabels">

  1982.   <tr>

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

  1984.       <table class="memname">

  1985.         <tr>

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

  1987.           <td>(</td>

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

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

  1990.         </tr>

  1991.         <tr>

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

  1993.           <td></td>

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

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

  1996.         </tr>

  1997.         <tr>

  1998.           <td></td>

  1999.           <td>)</td>

  2000.           <td></td><td></td>

  2001.         </tr>

  2002.       </table>

  2003.   </td>

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

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

  2006.   </tr>

  2007. </table>

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

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

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

  2011.   <table class="params">

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

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

  2014.   </table>

  2015.   </dd>

  2016. </dl>

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

  2018. 

  2019. </div>

  2020. </div>

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

  2022. <div class="memitem">

  2023. <div class="memproto">

  2024. <table class="mlabels">

  2025.   <tr>

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

  2027.       <table class="memname">

  2028.         <tr>

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

  2030.           <td>(</td>

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

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

  2033.         </tr>

  2034.         <tr>

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

  2036.           <td></td>

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

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

  2039.         </tr>

  2040.         <tr>

  2041.           <td></td>

  2042.           <td>)</td>

  2043.           <td></td><td></td>

  2044.         </tr>

  2045.       </table>

  2046.   </td>

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

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

  2049.   </tr>

  2050. </table>

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

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

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

  2054.   <table class="params">

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

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

  2057.   </table>

  2058.   </dd>

  2059. </dl>

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

  2061. 

  2062. </div>

  2063. </div>

  2064. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>

  2065. <div class="memitem">

  2066. <div class="memproto">

  2067. <table class="mlabels">

  2068.   <tr>

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

  2070.       <table class="memname">

  2071.         <tr>

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

  2073.           <td>(</td>

  2074.           <td class="paramtype">const String &amp;&#160;</td>

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

  2076.         </tr>

  2077.         <tr>

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

  2079.           <td></td>

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

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

  2082.         </tr>

  2083.         <tr>

  2084.           <td></td>

  2085.           <td>)</td>

  2086.           <td></td><td></td>

  2087.         </tr>

  2088.       </table>

  2089.   </td>

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

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

  2092.   </tr>

  2093. </table>

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

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

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

  2097.   <table class="params">

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

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

  2100.   </table>

  2101.   </dd>

  2102. </dl>

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

  2104. 

  2105. </div>

  2106. </div>

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

  2108. <div class="memitem">

  2109. <div class="memproto">

  2110. <table class="mlabels">

  2111.   <tr>

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

  2113.       <table class="memname">

  2114.         <tr>

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

  2116.           <td>(</td>

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

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

  2119.           <td></td>

  2120.         </tr>

  2121.       </table>

  2122.   </td>

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

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

  2125.   </tr>

  2126. </table>

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

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

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

  2130.   <table class="params">

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

  2132.   </table>

  2133.   </dd>

  2134. </dl>

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

  2136. 

  2137. </div>

  2138. </div>

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

  2140. <div class="memitem">

  2141. <div class="memproto">

  2142. <table class="mlabels">

  2143.   <tr>

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

  2145.       <table class="memname">

  2146.         <tr>

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

  2148.           <td>(</td>

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

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

  2151.         </tr>

  2152.         <tr>

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

  2154.           <td></td>

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

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

  2157.         </tr>

  2158.         <tr>

  2159.           <td></td>

  2160.           <td>)</td>

  2161.           <td></td><td></td>

  2162.         </tr>

  2163.       </table>

  2164.   </td>

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

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

  2167.   </tr>

  2168. </table>

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

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

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

  2172.   <table class="params">

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

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

  2175.   </table>

  2176.   </dd>

  2177. </dl>

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

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

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

  2181. 

  2182. </div>

  2183. </div>

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

  2185. <div class="memitem">

  2186. <div class="memproto">

  2187. <table class="mlabels">

  2188.   <tr>

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

  2190.       <table class="memname">

  2191.         <tr>

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

  2193.           <td>(</td>

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

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

  2196.           <td></td>

  2197.         </tr>

  2198.       </table>

  2199.   </td>

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

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

  2202.   </tr>

  2203. </table>

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

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

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

  2207.   <table class="params">

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

  2209.   </table>

  2210.   </dd>

  2211. </dl>

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

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

  2214. 

  2215. </div>

  2216. </div>

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

  2218. <div class="memitem">

  2219. <div class="memproto">

  2220. <table class="mlabels">

  2221.   <tr>

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

  2223.       <table class="memname">

  2224.         <tr>

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

  2226.           <td>(</td>

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

  2228.           <td> const</td>

  2229.         </tr>

  2230.       </table>

  2231.   </td>

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

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

  2234.   </tr>

  2235. </table>

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

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

  2238. 

  2239. </div>

  2240. </div>

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

  2242. <div class="memitem">

  2243. <div class="memproto">

  2244. <table class="mlabels">

  2245.   <tr>

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

  2247.       <table class="memname">

  2248.         <tr>

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

  2250.           <td>(</td>

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

  2252.           <td> const</td>

  2253.         </tr>

  2254.       </table>

  2255.   </td>

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

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

  2258.   </tr>

  2259. </table>

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

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

  2262. 

  2263. </div>

  2264. </div>

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

  2266. <div class="memitem">

  2267. <div class="memproto">

  2268. <table class="mlabels">

  2269.   <tr>

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

  2271.       <table class="memname">

  2272.         <tr>

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

  2274.           <td>(</td>

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

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

  2277.         </tr>

  2278.         <tr>

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

  2280.           <td></td>

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

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

  2283.         </tr>

  2284.         <tr>

  2285.           <td></td>

  2286.           <td>)</td>

  2287.           <td></td><td></td>

  2288.         </tr>

  2289.       </table>

  2290.   </td>

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

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

  2293.   </tr>

  2294. </table>

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

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

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

  2298.   <table class="params">

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

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

  2301.   </table>

  2302.   </dd>

  2303. </dl>

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

  2305. 

  2306. </div>

  2307. </div>

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

  2309. <div class="memitem">

  2310. <div class="memproto">

  2311. <table class="mlabels">

  2312.   <tr>

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

  2314.       <table class="memname">

  2315.         <tr>

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

  2317.           <td>(</td>

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

  2319.           <td></td>

  2320.         </tr>

  2321.       </table>

  2322.   </td>

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

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

  2325.   </tr>

  2326. </table>

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

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

  2329. 

  2330. </div>

  2331. </div>

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

  2333. <div class="memitem">

  2334. <div class="memproto">

  2335. <table class="mlabels">

  2336.   <tr>

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

  2338.       <table class="memname">

  2339.         <tr>

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

  2341.           <td>(</td>

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

  2343.           <td> const</td>

  2344.         </tr>

  2345.       </table>

  2346.   </td>

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

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

  2349.   </tr>

  2350. </table>

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

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

  2353. 

  2354. </div>

  2355. </div>

  2356. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>

  2357. <div class="memitem">

  2358. <div class="memproto">

  2359. <table class="mlabels">

  2360.   <tr>

  2361.   <td class="mlabels-left">

  2362.       <table class="memname">

  2363.         <tr>

  2364.           <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>

  2365.           <td>(</td>

  2366.           <td class="paramname"></td><td>)</td>

  2367.           <td></td>

  2368.         </tr>

  2369.       </table>

  2370.   </td>

  2371.   <td class="mlabels-right">

  2372. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2373.   </tr>

  2374. </table>

  2375. </div><div class="memdoc">

  2376. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  2377. 

  2378. </div>

  2379. </div>

  2380. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>

  2381. <div class="memitem">

  2382. <div class="memproto">

  2383. <table class="mlabels">

  2384.   <tr>

  2385.   <td class="mlabels-left">

  2386.       <table class="memname">

  2387.         <tr>

  2388.           <td class="memname">bool FatFileSystem::wipe </td>

  2389.           <td>(</td>

  2390.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2391.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  2392.           <td></td>

  2393.         </tr>

  2394.       </table>

  2395.   </td>

  2396.   <td class="mlabels-right">

  2397. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2398.   </tr>

  2399. </table>

  2400. </div><div class="memdoc">

  2401. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>

  2402.   <table class="params">

  2403.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  2404.   </table>

  2405.   </dd>

  2406. </dl>

  2407. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2408. 

  2409. </div>

  2410. </div>

  2411. <hr/>The documentation for this class was generated from the following file:<ul>

  2412. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  2413. </ul>

  2414. </div><!-- contents -->

  2415. <!-- start footer part -->

  2416. <hr class="footer"/><address class="footer"><small>

  2417. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2418. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2419. </a> 1.8.10

  2420. </small></address>

  2421. </body>

  2422. </html>