1611 lines
70KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>SdFat: SdFatBase Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">SdFat
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.8 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="modules.html"><span>Modules</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  65. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_sd_fat_base-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">SdFatBase Class Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Virtual base class for SdFat library.
  90. <a href="class_sd_fat_base.html#details">More...</a></p>
  91. <p><code>#include &lt;SdFat.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for SdFatBase:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_sd_fat_base__inherit__graph.png" border="0" usemap="#_sd_fat_base_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_sd_fat_base_inherit__map" id="_sd_fat_base_inherit__map">
  97. <area shape="rect" id="node7" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="5,237,61,264"/> <area shape="rect" id="node9" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. " alt="" coords="87,237,180,264"/> <area shape="rect" id="node11" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="204,230,367,271"/> <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="80,80,187,107"/> <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="91,5,176,32"/> </map>
  98. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  99. <div class="dynheader">
  100. Collaboration diagram for SdFatBase:</div>
  101. <div class="dyncontent">
  102. <div class="center"><img src="class_sd_fat_base__coll__graph.png" border="0" usemap="#_sd_fat_base_coll__map" alt="Collaboration graph"/></div>
  103. <map name="_sd_fat_base_coll__map" id="_sd_fat_base_coll__map">
  104. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="5,80,112,107"/> <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="16,5,101,32"/> </map>
  105. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  106. <table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  108. Public Member Functions</h2></td></tr>
  109. <tr class="memitem:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a3d3f2cc4df1b6f2a129c3a614c1e5e1f">begin</a> (<a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *spi, uint8_t csPin=SS, uint8_t divisor=2)</td></tr>
  110. <tr class="separator:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a899294ced4e4585feae7668099338534"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a899294ced4e4585feae7668099338534">card</a> ()</td></tr>
  112. <tr class="separator:a899294ced4e4585feae7668099338534"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a905d883dcbaa60aa35a6eb0cad63cc9e">errorHalt</a> ()</td></tr>
  120. <tr class="separator:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ae8cf95abf0ffb1c7a55eb1a192c28982">errorHalt</a> (Print *pr)</td></tr>
  122. <tr class="separator:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a07e04b976ffcaf7e9492e50c6e4900a8">errorHalt</a> (char const *msg)</td></tr>
  124. <tr class="separator:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7c52e1a1909c9aa532b8525cf721fd89">errorHalt</a> (Print *pr, char const *msg)</td></tr>
  126. <tr class="separator:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a111cecbcc7ea5c068c44051491a77a52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a111cecbcc7ea5c068c44051491a77a52">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  128. <tr class="separator:a111cecbcc7ea5c068c44051491a77a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a4c34e68605243269f96122a9cb909004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a4c34e68605243269f96122a9cb909004">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  130. <tr class="separator:a4c34e68605243269f96122a9cb909004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a2deadc5b8bcdf5710fefba39b895e008"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a2deadc5b8bcdf5710fefba39b895e008">errorPrint</a> ()</td></tr>
  132. <tr class="separator:a2deadc5b8bcdf5710fefba39b895e008"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aaa950f290e41c0ff2d62b94cb425ba12">errorPrint</a> (Print *pr)</td></tr>
  134. <tr class="separator:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a84fe32d89460471cf9f66495f545e2ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a84fe32d89460471cf9f66495f545e2ae">errorPrint</a> (const char *msg)</td></tr>
  136. <tr class="separator:a84fe32d89460471cf9f66495f545e2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a5ecc4177c65f8e2837a9ef4d17368a98">errorPrint</a> (Print *pr, char const *msg)</td></tr>
  138. <tr class="separator:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a7eed2449f96d62e87bea96c6da4f618a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a7eed2449f96d62e87bea96c6da4f618a">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  140. <tr class="separator:a7eed2449f96d62e87bea96c6da4f618a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aace11e097b69144a80a4abbca54d35b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aace11e097b69144a80a4abbca54d35b0">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  142. <tr class="separator:aace11e097b69144a80a4abbca54d35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a389f0ef6fb556c67b48ade5c0c1b3a9a">fsBegin</a> ()</td></tr>
  146. <tr class="separator:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:adbfd9264f972f054e561128bad0b267e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adbfd9264f972f054e561128bad0b267e">initErrorHalt</a> ()</td></tr>
  148. <tr class="separator:adbfd9264f972f054e561128bad0b267e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a86770dd889bffc5788172c8d34a3582c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a86770dd889bffc5788172c8d34a3582c">initErrorHalt</a> (Print *pr)</td></tr>
  150. <tr class="separator:a86770dd889bffc5788172c8d34a3582c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a0d4c851a3243c9f8c21d3894821292e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a0d4c851a3243c9f8c21d3894821292e9">initErrorHalt</a> (char const *msg)</td></tr>
  152. <tr class="separator:a0d4c851a3243c9f8c21d3894821292e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a02f18794078b7a1c9662c3ded438cff4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a02f18794078b7a1c9662c3ded438cff4">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>
  154. <tr class="separator:a02f18794078b7a1c9662c3ded438cff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:abe312251854aebf5b8d6b4f9896660ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#abe312251854aebf5b8d6b4f9896660ed">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  156. <tr class="separator:abe312251854aebf5b8d6b4f9896660ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aa93c7fec40b37e7f5dd1e362ebf5ff69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  158. <tr class="separator:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a62a979138be1b62942f7b3f04964356e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a62a979138be1b62942f7b3f04964356e">initErrorPrint</a> ()</td></tr>
  160. <tr class="separator:a62a979138be1b62942f7b3f04964356e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:adffd5a3e802842b371b170c6df6b2530"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#adffd5a3e802842b371b170c6df6b2530">initErrorPrint</a> (Print *pr)</td></tr>
  162. <tr class="separator:adffd5a3e802842b371b170c6df6b2530"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a296855ca8cc7590b9cbe7b3aeabc8467">initErrorPrint</a> (char const *msg)</td></tr>
  164. <tr class="separator:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#aca07f92b3a06ede0e7a56b68b76dc3b7">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>
  166. <tr class="separator:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a9c334faf236651db265d5acf65271666"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a9c334faf236651db265d5acf65271666">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  168. <tr class="separator:a9c334faf236651db265d5acf65271666"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:ac0b7161c1385841264323ac244f5c89c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#ac0b7161c1385841264323ac244f5c89c">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  170. <tr class="separator:ac0b7161c1385841264323ac244f5c89c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:ad17f2a0925b34cb3807e4c1677a2872f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ad17f2a0925b34cb3807e4c1677a2872f">ls</a> (<a class="el" href="_fat_file_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags)</td></tr>
  172. <tr class="separator:ad17f2a0925b34cb3807e4c1677a2872f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_file_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  174. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a6e2ba60320f47912a96ad83820073ce8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a6e2ba60320f47912a96ad83820073ce8">ls</a> (uint8_t flags=0)</td></tr>
  176. <tr class="separator:a6e2ba60320f47912a96ad83820073ce8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a85bd146c6fb0120ac69c3d93267321e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a85bd146c6fb0120ac69c3d93267321e6">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  178. <tr class="separator:a85bd146c6fb0120ac69c3d93267321e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <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>
  180. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:af2b23a0be384abb31989eb86aabdb5d8"><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_sd_fat_base.html#af2b23a0be384abb31989eb86aabdb5d8">open</a> (const char *path, uint8_t mode=<a class="el" href="_sd_file_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  182. <tr class="separator:af2b23a0be384abb31989eb86aabdb5d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <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>
  184. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <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>
  186. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <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>
  188. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <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>
  190. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <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>
  192. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a24dfcd1a1c716e8e56f8128d69dc1463"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_base_file.html">SdBaseFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_base.html#a24dfcd1a1c716e8e56f8128d69dc1463">vwd</a> ()</td></tr>
  194. <tr class="separator:a24dfcd1a1c716e8e56f8128d69dc1463"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. </table>
  196. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  197. <div class="textblock"><p>Virtual base class for SdFat library. </p>
  198. </div><h2 class="groupheader">Member Function Documentation</h2>
  199. <a class="anchor" id="a3d3f2cc4df1b6f2a129c3a614c1e5e1f"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="mlabels">
  203. <tr>
  204. <td class="mlabels-left">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">bool SdFatBase::begin </td>
  208. <td>(</td>
  209. <td class="paramtype"><a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *&#160;</td>
  210. <td class="paramname"><em>spi</em>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype">uint8_t&#160;</td>
  216. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">uint8_t&#160;</td>
  222. <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>
  223. </tr>
  224. <tr>
  225. <td></td>
  226. <td>)</td>
  227. <td></td><td></td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Initialize SD card and file system. </p><dl class="params"><dt>Parameters</dt><dd>
  237. <table class="params">
  238. <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI object for the card. </td></tr>
  239. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  240. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>
  241. </table>
  242. </dd>
  243. </dl>
  244. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  245. </div>
  246. </div>
  247. <a class="anchor" id="a899294ced4e4585feae7668099338534"></a>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="mlabels">
  251. <tr>
  252. <td class="mlabels-left">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a>* SdFatBase::card </td>
  256. <td>(</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </td>
  262. <td class="mlabels-right">
  263. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>
  268. </div>
  269. </div>
  270. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="mlabels">
  274. <tr>
  275. <td class="mlabels-left">
  276. <table class="memname">
  277. <tr>
  278. <td class="memname">bool FatFileSystem::chdir </td>
  279. <td>(</td>
  280. <td class="paramtype">bool&#160;</td>
  281. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </td>
  286. <td class="mlabels-right">
  287. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Change a volume's working directory to root</p>
  292. <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>
  293. <dl class="params"><dt>Parameters</dt><dd>
  294. <table class="params">
  295. <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>
  296. </table>
  297. </dd>
  298. </dl>
  299. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  300. </div>
  301. </div>
  302. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">bool FatFileSystem::chdir </td>
  311. <td>(</td>
  312. <td class="paramtype">const char *&#160;</td>
  313. <td class="paramname"><em>path</em>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype">bool&#160;</td>
  319. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#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 class="mlabel">inherited</span></span> </td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Change a volume's working directory</p>
  334. <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>
  335. <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>
  336. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  337. <dl class="params"><dt>Parameters</dt><dd>
  338. <table class="params">
  339. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  340. <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>
  341. </table>
  342. </dd>
  343. </dl>
  344. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  345. </div>
  346. </div>
  347. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="mlabels">
  351. <tr>
  352. <td class="mlabels-left">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">void FatFileSystem::chvol </td>
  356. <td>(</td>
  357. <td class="paramname"></td><td>)</td>
  358. <td></td>
  359. </tr>
  360. </table>
  361. </td>
  362. <td class="mlabels-right">
  363. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. <p>Set the current working directory to a volume's working directory.</p>
  368. <p>This is useful with multiple SD cards.</p>
  369. <p>The current working directory is changed to this volume's working directory.</p>
  370. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a905d883dcbaa60aa35a6eb0cad63cc9e"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="mlabels">
  377. <tr>
  378. <td class="mlabels-left">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">void SdFatBase::errorHalt </td>
  382. <td>(</td>
  383. <td class="paramname"></td><td>)</td>
  384. <td></td>
  385. </tr>
  386. </table>
  387. </td>
  388. <td class="mlabels-right">
  389. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <p>Print any SD error code to Serial and halt. </p>
  394. </div>
  395. </div>
  396. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></a>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">void SdFatBase::errorHalt </td>
  402. <td>(</td>
  403. <td class="paramtype">Print *&#160;</td>
  404. <td class="paramname"><em>pr</em></td><td>)</td>
  405. <td></td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Print any SD error code and halt.</p>
  410. <dl class="params"><dt>Parameters</dt><dd>
  411. <table class="params">
  412. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  413. </table>
  414. </dd>
  415. </dl>
  416. </div>
  417. </div>
  418. <a class="anchor" id="a07e04b976ffcaf7e9492e50c6e4900a8"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">void SdFatBase::errorHalt </td>
  427. <td>(</td>
  428. <td class="paramtype">char const *&#160;</td>
  429. <td class="paramname"><em>msg</em></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. <p>Print msg, any SD error code and halt.</p>
  440. <dl class="params"><dt>Parameters</dt><dd>
  441. <table class="params">
  442. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  443. </table>
  444. </dd>
  445. </dl>
  446. </div>
  447. </div>
  448. <a class="anchor" id="a7c52e1a1909c9aa532b8525cf721fd89"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">void SdFatBase::errorHalt </td>
  454. <td>(</td>
  455. <td class="paramtype">Print *&#160;</td>
  456. <td class="paramname"><em>pr</em>, </td>
  457. </tr>
  458. <tr>
  459. <td class="paramkey"></td>
  460. <td></td>
  461. <td class="paramtype">char const *&#160;</td>
  462. <td class="paramname"><em>msg</em>&#160;</td>
  463. </tr>
  464. <tr>
  465. <td></td>
  466. <td>)</td>
  467. <td></td><td></td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <p>Print msg, any SD error code, and halt.</p>
  472. <dl class="params"><dt>Parameters</dt><dd>
  473. <table class="params">
  474. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  475. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. </div>
  480. </div>
  481. <a class="anchor" id="a111cecbcc7ea5c068c44051491a77a52"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">void SdFatBase::errorHalt </td>
  490. <td>(</td>
  491. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  492. <td class="paramname"><em>msg</em></td><td>)</td>
  493. <td></td>
  494. </tr>
  495. </table>
  496. </td>
  497. <td class="mlabels-right">
  498. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <p>Print msg, any SD error code, and halt.</p>
  503. <dl class="params"><dt>Parameters</dt><dd>
  504. <table class="params">
  505. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  506. </table>
  507. </dd>
  508. </dl>
  509. </div>
  510. </div>
  511. <a class="anchor" id="a4c34e68605243269f96122a9cb909004"></a>
  512. <div class="memitem">
  513. <div class="memproto">
  514. <table class="memname">
  515. <tr>
  516. <td class="memname">void SdFatBase::errorHalt </td>
  517. <td>(</td>
  518. <td class="paramtype">Print *&#160;</td>
  519. <td class="paramname"><em>pr</em>, </td>
  520. </tr>
  521. <tr>
  522. <td class="paramkey"></td>
  523. <td></td>
  524. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  525. <td class="paramname"><em>msg</em>&#160;</td>
  526. </tr>
  527. <tr>
  528. <td></td>
  529. <td>)</td>
  530. <td></td><td></td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>Print msg, any SD error code, and halt.</p>
  535. <dl class="params"><dt>Parameters</dt><dd>
  536. <table class="params">
  537. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  538. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  539. </table>
  540. </dd>
  541. </dl>
  542. </div>
  543. </div>
  544. <a class="anchor" id="a2deadc5b8bcdf5710fefba39b895e008"></a>
  545. <div class="memitem">
  546. <div class="memproto">
  547. <table class="mlabels">
  548. <tr>
  549. <td class="mlabels-left">
  550. <table class="memname">
  551. <tr>
  552. <td class="memname">void SdFatBase::errorPrint </td>
  553. <td>(</td>
  554. <td class="paramname"></td><td>)</td>
  555. <td></td>
  556. </tr>
  557. </table>
  558. </td>
  559. <td class="mlabels-right">
  560. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <p>Print any SD error code to Serial </p>
  565. </div>
  566. </div>
  567. <a class="anchor" id="aaa950f290e41c0ff2d62b94cb425ba12"></a>
  568. <div class="memitem">
  569. <div class="memproto">
  570. <table class="memname">
  571. <tr>
  572. <td class="memname">void SdFatBase::errorPrint </td>
  573. <td>(</td>
  574. <td class="paramtype">Print *&#160;</td>
  575. <td class="paramname"><em>pr</em></td><td>)</td>
  576. <td></td>
  577. </tr>
  578. </table>
  579. </div><div class="memdoc">
  580. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  581. <table class="params">
  582. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  583. </table>
  584. </dd>
  585. </dl>
  586. </div>
  587. </div>
  588. <a class="anchor" id="a84fe32d89460471cf9f66495f545e2ae"></a>
  589. <div class="memitem">
  590. <div class="memproto">
  591. <table class="mlabels">
  592. <tr>
  593. <td class="mlabels-left">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">void SdFatBase::errorPrint </td>
  597. <td>(</td>
  598. <td class="paramtype">const char *&#160;</td>
  599. <td class="paramname"><em>msg</em></td><td>)</td>
  600. <td></td>
  601. </tr>
  602. </table>
  603. </td>
  604. <td class="mlabels-right">
  605. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  606. </tr>
  607. </table>
  608. </div><div class="memdoc">
  609. <p>Print msg, any SD error code.</p>
  610. <dl class="params"><dt>Parameters</dt><dd>
  611. <table class="params">
  612. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  613. </table>
  614. </dd>
  615. </dl>
  616. </div>
  617. </div>
  618. <a class="anchor" id="a5ecc4177c65f8e2837a9ef4d17368a98"></a>
  619. <div class="memitem">
  620. <div class="memproto">
  621. <table class="memname">
  622. <tr>
  623. <td class="memname">void SdFatBase::errorPrint </td>
  624. <td>(</td>
  625. <td class="paramtype">Print *&#160;</td>
  626. <td class="paramname"><em>pr</em>, </td>
  627. </tr>
  628. <tr>
  629. <td class="paramkey"></td>
  630. <td></td>
  631. <td class="paramtype">char const *&#160;</td>
  632. <td class="paramname"><em>msg</em>&#160;</td>
  633. </tr>
  634. <tr>
  635. <td></td>
  636. <td>)</td>
  637. <td></td><td></td>
  638. </tr>
  639. </table>
  640. </div><div class="memdoc">
  641. <p>Print msg, any SD error code.</p>
  642. <dl class="params"><dt>Parameters</dt><dd>
  643. <table class="params">
  644. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  645. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  646. </table>
  647. </dd>
  648. </dl>
  649. </div>
  650. </div>
  651. <a class="anchor" id="a7eed2449f96d62e87bea96c6da4f618a"></a>
  652. <div class="memitem">
  653. <div class="memproto">
  654. <table class="mlabels">
  655. <tr>
  656. <td class="mlabels-left">
  657. <table class="memname">
  658. <tr>
  659. <td class="memname">void SdFatBase::errorPrint </td>
  660. <td>(</td>
  661. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  662. <td class="paramname"><em>msg</em></td><td>)</td>
  663. <td></td>
  664. </tr>
  665. </table>
  666. </td>
  667. <td class="mlabels-right">
  668. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  669. </tr>
  670. </table>
  671. </div><div class="memdoc">
  672. <p>Print msg, any SD error code.</p>
  673. <dl class="params"><dt>Parameters</dt><dd>
  674. <table class="params">
  675. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  676. </table>
  677. </dd>
  678. </dl>
  679. </div>
  680. </div>
  681. <a class="anchor" id="aace11e097b69144a80a4abbca54d35b0"></a>
  682. <div class="memitem">
  683. <div class="memproto">
  684. <table class="memname">
  685. <tr>
  686. <td class="memname">void SdFatBase::errorPrint </td>
  687. <td>(</td>
  688. <td class="paramtype">Print *&#160;</td>
  689. <td class="paramname"><em>pr</em>, </td>
  690. </tr>
  691. <tr>
  692. <td class="paramkey"></td>
  693. <td></td>
  694. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  695. <td class="paramname"><em>msg</em>&#160;</td>
  696. </tr>
  697. <tr>
  698. <td></td>
  699. <td>)</td>
  700. <td></td><td></td>
  701. </tr>
  702. </table>
  703. </div><div class="memdoc">
  704. <p>Print msg, any SD error code.</p>
  705. <dl class="params"><dt>Parameters</dt><dd>
  706. <table class="params">
  707. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  708. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  709. </table>
  710. </dd>
  711. </dl>
  712. </div>
  713. </div>
  714. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>
  715. <div class="memitem">
  716. <div class="memproto">
  717. <table class="mlabels">
  718. <tr>
  719. <td class="mlabels-left">
  720. <table class="memname">
  721. <tr>
  722. <td class="memname">bool FatFileSystem::exists </td>
  723. <td>(</td>
  724. <td class="paramtype">const char *&#160;</td>
  725. <td class="paramname"><em>path</em></td><td>)</td>
  726. <td></td>
  727. </tr>
  728. </table>
  729. </td>
  730. <td class="mlabels-right">
  731. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  732. </tr>
  733. </table>
  734. </div><div class="memdoc">
  735. <p>Test for the existence of a file.</p>
  736. <dl class="params"><dt>Parameters</dt><dd>
  737. <table class="params">
  738. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  739. </table>
  740. </dd>
  741. </dl>
  742. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  743. </div>
  744. </div>
  745. <a class="anchor" id="a389f0ef6fb556c67b48ade5c0c1b3a9a"></a>
  746. <div class="memitem">
  747. <div class="memproto">
  748. <table class="mlabels">
  749. <tr>
  750. <td class="mlabels-left">
  751. <table class="memname">
  752. <tr>
  753. <td class="memname">bool SdFatBase::fsBegin </td>
  754. <td>(</td>
  755. <td class="paramname"></td><td>)</td>
  756. <td></td>
  757. </tr>
  758. </table>
  759. </td>
  760. <td class="mlabels-right">
  761. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  762. </tr>
  763. </table>
  764. </div><div class="memdoc">
  765. <p>Diagnostic call to initialize <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a>. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  766. </div>
  767. </div>
  768. <a class="anchor" id="adbfd9264f972f054e561128bad0b267e"></a>
  769. <div class="memitem">
  770. <div class="memproto">
  771. <table class="mlabels">
  772. <tr>
  773. <td class="mlabels-left">
  774. <table class="memname">
  775. <tr>
  776. <td class="memname">void SdFatBase::initErrorHalt </td>
  777. <td>(</td>
  778. <td class="paramname"></td><td>)</td>
  779. <td></td>
  780. </tr>
  781. </table>
  782. </td>
  783. <td class="mlabels-right">
  784. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  785. </tr>
  786. </table>
  787. </div><div class="memdoc">
  788. <p>Print any SD error code and halt. </p>
  789. </div>
  790. </div>
  791. <a class="anchor" id="a86770dd889bffc5788172c8d34a3582c"></a>
  792. <div class="memitem">
  793. <div class="memproto">
  794. <table class="memname">
  795. <tr>
  796. <td class="memname">void SdFatBase::initErrorHalt </td>
  797. <td>(</td>
  798. <td class="paramtype">Print *&#160;</td>
  799. <td class="paramname"><em>pr</em></td><td>)</td>
  800. <td></td>
  801. </tr>
  802. </table>
  803. </div><div class="memdoc">
  804. <p>Print error details and halt after begin fails.</p>
  805. <dl class="params"><dt>Parameters</dt><dd>
  806. <table class="params">
  807. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  808. </table>
  809. </dd>
  810. </dl>
  811. </div>
  812. </div>
  813. <a class="anchor" id="a0d4c851a3243c9f8c21d3894821292e9"></a>
  814. <div class="memitem">
  815. <div class="memproto">
  816. <table class="mlabels">
  817. <tr>
  818. <td class="mlabels-left">
  819. <table class="memname">
  820. <tr>
  821. <td class="memname">void SdFatBase::initErrorHalt </td>
  822. <td>(</td>
  823. <td class="paramtype">char const *&#160;</td>
  824. <td class="paramname"><em>msg</em></td><td>)</td>
  825. <td></td>
  826. </tr>
  827. </table>
  828. </td>
  829. <td class="mlabels-right">
  830. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  831. </tr>
  832. </table>
  833. </div><div class="memdoc">
  834. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  835. <dl class="params"><dt>Parameters</dt><dd>
  836. <table class="params">
  837. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  838. </table>
  839. </dd>
  840. </dl>
  841. </div>
  842. </div>
  843. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></a>
  844. <div class="memitem">
  845. <div class="memproto">
  846. <table class="memname">
  847. <tr>
  848. <td class="memname">void SdFatBase::initErrorHalt </td>
  849. <td>(</td>
  850. <td class="paramtype">Print *&#160;</td>
  851. <td class="paramname"><em>pr</em>, </td>
  852. </tr>
  853. <tr>
  854. <td class="paramkey"></td>
  855. <td></td>
  856. <td class="paramtype">char const *&#160;</td>
  857. <td class="paramname"><em>msg</em>&#160;</td>
  858. </tr>
  859. <tr>
  860. <td></td>
  861. <td>)</td>
  862. <td></td><td></td>
  863. </tr>
  864. </table>
  865. </div><div class="memdoc">
  866. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  867. <table class="params">
  868. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  869. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  870. </table>
  871. </dd>
  872. </dl>
  873. </div>
  874. </div>
  875. <a class="anchor" id="abe312251854aebf5b8d6b4f9896660ed"></a>
  876. <div class="memitem">
  877. <div class="memproto">
  878. <table class="mlabels">
  879. <tr>
  880. <td class="mlabels-left">
  881. <table class="memname">
  882. <tr>
  883. <td class="memname">void SdFatBase::initErrorHalt </td>
  884. <td>(</td>
  885. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  886. <td class="paramname"><em>msg</em></td><td>)</td>
  887. <td></td>
  888. </tr>
  889. </table>
  890. </td>
  891. <td class="mlabels-right">
  892. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  893. </tr>
  894. </table>
  895. </div><div class="memdoc">
  896. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  897. <dl class="params"><dt>Parameters</dt><dd>
  898. <table class="params">
  899. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  900. </table>
  901. </dd>
  902. </dl>
  903. </div>
  904. </div>
  905. <a class="anchor" id="aa93c7fec40b37e7f5dd1e362ebf5ff69"></a>
  906. <div class="memitem">
  907. <div class="memproto">
  908. <table class="memname">
  909. <tr>
  910. <td class="memname">void SdFatBase::initErrorHalt </td>
  911. <td>(</td>
  912. <td class="paramtype">Print *&#160;</td>
  913. <td class="paramname"><em>pr</em>, </td>
  914. </tr>
  915. <tr>
  916. <td class="paramkey"></td>
  917. <td></td>
  918. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  919. <td class="paramname"><em>msg</em>&#160;</td>
  920. </tr>
  921. <tr>
  922. <td></td>
  923. <td>)</td>
  924. <td></td><td></td>
  925. </tr>
  926. </table>
  927. </div><div class="memdoc">
  928. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  929. <table class="params">
  930. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>
  931. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  932. </table>
  933. </dd>
  934. </dl>
  935. </div>
  936. </div>
  937. <a class="anchor" id="a62a979138be1b62942f7b3f04964356e"></a>
  938. <div class="memitem">
  939. <div class="memproto">
  940. <table class="mlabels">
  941. <tr>
  942. <td class="mlabels-left">
  943. <table class="memname">
  944. <tr>
  945. <td class="memname">void SdFatBase::initErrorPrint </td>
  946. <td>(</td>
  947. <td class="paramname"></td><td>)</td>
  948. <td></td>
  949. </tr>
  950. </table>
  951. </td>
  952. <td class="mlabels-right">
  953. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  954. </tr>
  955. </table>
  956. </div><div class="memdoc">
  957. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails. </p>
  958. </div>
  959. </div>
  960. <a class="anchor" id="adffd5a3e802842b371b170c6df6b2530"></a>
  961. <div class="memitem">
  962. <div class="memproto">
  963. <table class="memname">
  964. <tr>
  965. <td class="memname">void SdFatBase::initErrorPrint </td>
  966. <td>(</td>
  967. <td class="paramtype">Print *&#160;</td>
  968. <td class="paramname"><em>pr</em></td><td>)</td>
  969. <td></td>
  970. </tr>
  971. </table>
  972. </div><div class="memdoc">
  973. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  974. <dl class="params"><dt>Parameters</dt><dd>
  975. <table class="params">
  976. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  977. </table>
  978. </dd>
  979. </dl>
  980. </div>
  981. </div>
  982. <a class="anchor" id="a296855ca8cc7590b9cbe7b3aeabc8467"></a>
  983. <div class="memitem">
  984. <div class="memproto">
  985. <table class="mlabels">
  986. <tr>
  987. <td class="mlabels-left">
  988. <table class="memname">
  989. <tr>
  990. <td class="memname">void SdFatBase::initErrorPrint </td>
  991. <td>(</td>
  992. <td class="paramtype">char const *&#160;</td>
  993. <td class="paramname"><em>msg</em></td><td>)</td>
  994. <td></td>
  995. </tr>
  996. </table>
  997. </td>
  998. <td class="mlabels-right">
  999. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1000. </tr>
  1001. </table>
  1002. </div><div class="memdoc">
  1003. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1004. <dl class="params"><dt>Parameters</dt><dd>
  1005. <table class="params">
  1006. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1007. </table>
  1008. </dd>
  1009. </dl>
  1010. </div>
  1011. </div>
  1012. <a class="anchor" id="aca07f92b3a06ede0e7a56b68b76dc3b7"></a>
  1013. <div class="memitem">
  1014. <div class="memproto">
  1015. <table class="memname">
  1016. <tr>
  1017. <td class="memname">void SdFatBase::initErrorPrint </td>
  1018. <td>(</td>
  1019. <td class="paramtype">Print *&#160;</td>
  1020. <td class="paramname"><em>pr</em>, </td>
  1021. </tr>
  1022. <tr>
  1023. <td class="paramkey"></td>
  1024. <td></td>
  1025. <td class="paramtype">char const *&#160;</td>
  1026. <td class="paramname"><em>msg</em>&#160;</td>
  1027. </tr>
  1028. <tr>
  1029. <td></td>
  1030. <td>)</td>
  1031. <td></td><td></td>
  1032. </tr>
  1033. </table>
  1034. </div><div class="memdoc">
  1035. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1036. <dl class="params"><dt>Parameters</dt><dd>
  1037. <table class="params">
  1038. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1039. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1040. </table>
  1041. </dd>
  1042. </dl>
  1043. </div>
  1044. </div>
  1045. <a class="anchor" id="a9c334faf236651db265d5acf65271666"></a>
  1046. <div class="memitem">
  1047. <div class="memproto">
  1048. <table class="mlabels">
  1049. <tr>
  1050. <td class="mlabels-left">
  1051. <table class="memname">
  1052. <tr>
  1053. <td class="memname">void SdFatBase::initErrorPrint </td>
  1054. <td>(</td>
  1055. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1056. <td class="paramname"><em>msg</em></td><td>)</td>
  1057. <td></td>
  1058. </tr>
  1059. </table>
  1060. </td>
  1061. <td class="mlabels-right">
  1062. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1063. </tr>
  1064. </table>
  1065. </div><div class="memdoc">
  1066. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1067. <dl class="params"><dt>Parameters</dt><dd>
  1068. <table class="params">
  1069. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1070. </table>
  1071. </dd>
  1072. </dl>
  1073. </div>
  1074. </div>
  1075. <a class="anchor" id="ac0b7161c1385841264323ac244f5c89c"></a>
  1076. <div class="memitem">
  1077. <div class="memproto">
  1078. <table class="memname">
  1079. <tr>
  1080. <td class="memname">void SdFatBase::initErrorPrint </td>
  1081. <td>(</td>
  1082. <td class="paramtype">Print *&#160;</td>
  1083. <td class="paramname"><em>pr</em>, </td>
  1084. </tr>
  1085. <tr>
  1086. <td class="paramkey"></td>
  1087. <td></td>
  1088. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1089. <td class="paramname"><em>msg</em>&#160;</td>
  1090. </tr>
  1091. <tr>
  1092. <td></td>
  1093. <td>)</td>
  1094. <td></td><td></td>
  1095. </tr>
  1096. </table>
  1097. </div><div class="memdoc">
  1098. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1099. <dl class="params"><dt>Parameters</dt><dd>
  1100. <table class="params">
  1101. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1102. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1103. </table>
  1104. </dd>
  1105. </dl>
  1106. </div>
  1107. </div>
  1108. <a class="anchor" id="ad17f2a0925b34cb3807e4c1677a2872f"></a>
  1109. <div class="memitem">
  1110. <div class="memproto">
  1111. <table class="mlabels">
  1112. <tr>
  1113. <td class="mlabels-left">
  1114. <table class="memname">
  1115. <tr>
  1116. <td class="memname">void FatFileSystem::ls </td>
  1117. <td>(</td>
  1118. <td class="paramtype"><a class="el" href="_fat_file_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1119. <td class="paramname"><em>pr</em>, </td>
  1120. </tr>
  1121. <tr>
  1122. <td class="paramkey"></td>
  1123. <td></td>
  1124. <td class="paramtype">uint8_t&#160;</td>
  1125. <td class="paramname"><em>flags</em>&#160;</td>
  1126. </tr>
  1127. <tr>
  1128. <td></td>
  1129. <td>)</td>
  1130. <td></td><td></td>
  1131. </tr>
  1132. </table>
  1133. </td>
  1134. <td class="mlabels-right">
  1135. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1136. </tr>
  1137. </table>
  1138. </div><div class="memdoc">
  1139. <p>List the directory contents of the volume working directory.</p>
  1140. <dl class="params"><dt>Parameters</dt><dd>
  1141. <table class="params">
  1142. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1143. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1144. </table>
  1145. </dd>
  1146. </dl>
  1147. <p>LS_DATE - Print file modification date</p>
  1148. <p>LS_SIZE - Print file size.</p>
  1149. <p>LS_R - Recursive list of subdirectories. </p>
  1150. </div>
  1151. </div>
  1152. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>
  1153. <div class="memitem">
  1154. <div class="memproto">
  1155. <table class="mlabels">
  1156. <tr>
  1157. <td class="mlabels-left">
  1158. <table class="memname">
  1159. <tr>
  1160. <td class="memname">void FatFileSystem::ls </td>
  1161. <td>(</td>
  1162. <td class="paramtype"><a class="el" href="_fat_file_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1163. <td class="paramname"><em>pr</em>, </td>
  1164. </tr>
  1165. <tr>
  1166. <td class="paramkey"></td>
  1167. <td></td>
  1168. <td class="paramtype">const char *&#160;</td>
  1169. <td class="paramname"><em>path</em>, </td>
  1170. </tr>
  1171. <tr>
  1172. <td class="paramkey"></td>
  1173. <td></td>
  1174. <td class="paramtype">uint8_t&#160;</td>
  1175. <td class="paramname"><em>flags</em>&#160;</td>
  1176. </tr>
  1177. <tr>
  1178. <td></td>
  1179. <td>)</td>
  1180. <td></td><td></td>
  1181. </tr>
  1182. </table>
  1183. </td>
  1184. <td class="mlabels-right">
  1185. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1186. </tr>
  1187. </table>
  1188. </div><div class="memdoc">
  1189. <p>List the directory contents of a directory.</p>
  1190. <dl class="params"><dt>Parameters</dt><dd>
  1191. <table class="params">
  1192. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1193. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1194. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1195. </table>
  1196. </dd>
  1197. </dl>
  1198. <p>LS_DATE - Print file modification date</p>
  1199. <p>LS_SIZE - Print file size.</p>
  1200. <p>LS_R - Recursive list of subdirectories. </p>
  1201. </div>
  1202. </div>
  1203. <a class="anchor" id="a6e2ba60320f47912a96ad83820073ce8"></a>
  1204. <div class="memitem">
  1205. <div class="memproto">
  1206. <table class="mlabels">
  1207. <tr>
  1208. <td class="mlabels-left">
  1209. <table class="memname">
  1210. <tr>
  1211. <td class="memname">void SdFatBase::ls </td>
  1212. <td>(</td>
  1213. <td class="paramtype">uint8_t&#160;</td>
  1214. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1215. <td></td>
  1216. </tr>
  1217. </table>
  1218. </td>
  1219. <td class="mlabels-right">
  1220. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1221. </tr>
  1222. </table>
  1223. </div><div class="memdoc">
  1224. <p>List the directory contents of the volume working directory to Serial.</p>
  1225. <dl class="params"><dt>Parameters</dt><dd>
  1226. <table class="params">
  1227. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1228. </table>
  1229. </dd>
  1230. </dl>
  1231. <p>LS_DATE - Print file modification date</p>
  1232. <p>LS_SIZE - Print file size.</p>
  1233. <p>LS_R - Recursive list of subdirectories. </p>
  1234. </div>
  1235. </div>
  1236. <a class="anchor" id="a85bd146c6fb0120ac69c3d93267321e6"></a>
  1237. <div class="memitem">
  1238. <div class="memproto">
  1239. <table class="mlabels">
  1240. <tr>
  1241. <td class="mlabels-left">
  1242. <table class="memname">
  1243. <tr>
  1244. <td class="memname">void SdFatBase::ls </td>
  1245. <td>(</td>
  1246. <td class="paramtype">const char *&#160;</td>
  1247. <td class="paramname"><em>path</em>, </td>
  1248. </tr>
  1249. <tr>
  1250. <td class="paramkey"></td>
  1251. <td></td>
  1252. <td class="paramtype">uint8_t&#160;</td>
  1253. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1254. </tr>
  1255. <tr>
  1256. <td></td>
  1257. <td>)</td>
  1258. <td></td><td></td>
  1259. </tr>
  1260. </table>
  1261. </td>
  1262. <td class="mlabels-right">
  1263. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1264. </tr>
  1265. </table>
  1266. </div><div class="memdoc">
  1267. <p>List the directory contents of a directory to Serial.</p>
  1268. <dl class="params"><dt>Parameters</dt><dd>
  1269. <table class="params">
  1270. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1271. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1272. </table>
  1273. </dd>
  1274. </dl>
  1275. <p>LS_DATE - Print file modification date</p>
  1276. <p>LS_SIZE - Print file size.</p>
  1277. <p>LS_R - Recursive list of subdirectories. </p>
  1278. </div>
  1279. </div>
  1280. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  1281. <div class="memitem">
  1282. <div class="memproto">
  1283. <table class="mlabels">
  1284. <tr>
  1285. <td class="mlabels-left">
  1286. <table class="memname">
  1287. <tr>
  1288. <td class="memname">bool FatFileSystem::mkdir </td>
  1289. <td>(</td>
  1290. <td class="paramtype">const char *&#160;</td>
  1291. <td class="paramname"><em>path</em>, </td>
  1292. </tr>
  1293. <tr>
  1294. <td class="paramkey"></td>
  1295. <td></td>
  1296. <td class="paramtype">bool&#160;</td>
  1297. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1298. </tr>
  1299. <tr>
  1300. <td></td>
  1301. <td>)</td>
  1302. <td></td><td></td>
  1303. </tr>
  1304. </table>
  1305. </td>
  1306. <td class="mlabels-right">
  1307. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1308. </tr>
  1309. </table>
  1310. </div><div class="memdoc">
  1311. <p>Make a subdirectory in the volume working directory.</p>
  1312. <dl class="params"><dt>Parameters</dt><dd>
  1313. <table class="params">
  1314. <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>
  1315. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1316. </table>
  1317. </dd>
  1318. </dl>
  1319. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  1320. </div>
  1321. </div>
  1322. <a class="anchor" id="af2b23a0be384abb31989eb86aabdb5d8"></a>
  1323. <div class="memitem">
  1324. <div class="memproto">
  1325. <table class="memname">
  1326. <tr>
  1327. <td class="memname"><a class="el" href="class_file.html">File</a> SdFatBase::open </td>
  1328. <td>(</td>
  1329. <td class="paramtype">const char *&#160;</td>
  1330. <td class="paramname"><em>path</em>, </td>
  1331. </tr>
  1332. <tr>
  1333. <td class="paramkey"></td>
  1334. <td></td>
  1335. <td class="paramtype">uint8_t&#160;</td>
  1336. <td class="paramname"><em>mode</em> = <code><a class="el" href="_sd_file_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1337. </tr>
  1338. <tr>
  1339. <td></td>
  1340. <td>)</td>
  1341. <td></td><td></td>
  1342. </tr>
  1343. </table>
  1344. </div><div class="memdoc">
  1345. <p>open a file</p>
  1346. <dl class="params"><dt>Parameters</dt><dd>
  1347. <table class="params">
  1348. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1349. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1350. </table>
  1351. </dd>
  1352. </dl>
  1353. <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>
  1354. </div>
  1355. </div>
  1356. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  1357. <div class="memitem">
  1358. <div class="memproto">
  1359. <table class="mlabels">
  1360. <tr>
  1361. <td class="mlabels-left">
  1362. <table class="memname">
  1363. <tr>
  1364. <td class="memname">bool FatFileSystem::remove </td>
  1365. <td>(</td>
  1366. <td class="paramtype">const char *&#160;</td>
  1367. <td class="paramname"><em>path</em></td><td>)</td>
  1368. <td></td>
  1369. </tr>
  1370. </table>
  1371. </td>
  1372. <td class="mlabels-right">
  1373. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1374. </tr>
  1375. </table>
  1376. </div><div class="memdoc">
  1377. <p>Remove a file from the volume working directory.</p>
  1378. <dl class="params"><dt>Parameters</dt><dd>
  1379. <table class="params">
  1380. <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>
  1381. </table>
  1382. </dd>
  1383. </dl>
  1384. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  1385. </div>
  1386. </div>
  1387. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>
  1388. <div class="memitem">
  1389. <div class="memproto">
  1390. <table class="mlabels">
  1391. <tr>
  1392. <td class="mlabels-left">
  1393. <table class="memname">
  1394. <tr>
  1395. <td class="memname">bool FatFileSystem::rename </td>
  1396. <td>(</td>
  1397. <td class="paramtype">const char *&#160;</td>
  1398. <td class="paramname"><em>oldPath</em>, </td>
  1399. </tr>
  1400. <tr>
  1401. <td class="paramkey"></td>
  1402. <td></td>
  1403. <td class="paramtype">const char *&#160;</td>
  1404. <td class="paramname"><em>newPath</em>&#160;</td>
  1405. </tr>
  1406. <tr>
  1407. <td></td>
  1408. <td>)</td>
  1409. <td></td><td></td>
  1410. </tr>
  1411. </table>
  1412. </td>
  1413. <td class="mlabels-right">
  1414. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1415. </tr>
  1416. </table>
  1417. </div><div class="memdoc">
  1418. <p>Rename a file or subdirectory.</p>
  1419. <dl class="params"><dt>Parameters</dt><dd>
  1420. <table class="params">
  1421. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1422. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1423. </table>
  1424. </dd>
  1425. </dl>
  1426. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1427. <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>
  1428. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  1429. </div>
  1430. </div>
  1431. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  1432. <div class="memitem">
  1433. <div class="memproto">
  1434. <table class="mlabels">
  1435. <tr>
  1436. <td class="mlabels-left">
  1437. <table class="memname">
  1438. <tr>
  1439. <td class="memname">bool FatFileSystem::rmdir </td>
  1440. <td>(</td>
  1441. <td class="paramtype">const char *&#160;</td>
  1442. <td class="paramname"><em>path</em></td><td>)</td>
  1443. <td></td>
  1444. </tr>
  1445. </table>
  1446. </td>
  1447. <td class="mlabels-right">
  1448. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1449. </tr>
  1450. </table>
  1451. </div><div class="memdoc">
  1452. <p>Remove a subdirectory from the volume's working directory.</p>
  1453. <dl class="params"><dt>Parameters</dt><dd>
  1454. <table class="params">
  1455. <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>
  1456. </table>
  1457. </dd>
  1458. </dl>
  1459. <p>The subdirectory file will be removed only if it is empty.</p>
  1460. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  1461. </div>
  1462. </div>
  1463. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  1464. <div class="memitem">
  1465. <div class="memproto">
  1466. <table class="mlabels">
  1467. <tr>
  1468. <td class="mlabels-left">
  1469. <table class="memname">
  1470. <tr>
  1471. <td class="memname">bool FatFileSystem::truncate </td>
  1472. <td>(</td>
  1473. <td class="paramtype">const char *&#160;</td>
  1474. <td class="paramname"><em>path</em>, </td>
  1475. </tr>
  1476. <tr>
  1477. <td class="paramkey"></td>
  1478. <td></td>
  1479. <td class="paramtype">uint32_t&#160;</td>
  1480. <td class="paramname"><em>length</em>&#160;</td>
  1481. </tr>
  1482. <tr>
  1483. <td></td>
  1484. <td>)</td>
  1485. <td></td><td></td>
  1486. </tr>
  1487. </table>
  1488. </td>
  1489. <td class="mlabels-right">
  1490. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1491. </tr>
  1492. </table>
  1493. </div><div class="memdoc">
  1494. <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>
  1495. <dl class="params"><dt>Parameters</dt><dd>
  1496. <table class="params">
  1497. <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>
  1498. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1499. </table>
  1500. </dd>
  1501. </dl>
  1502. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include file is read only, file is a directory, <em>length</em> is greater than the current file size or an I/O error occurs. </dd></dl>
  1503. </div>
  1504. </div>
  1505. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  1506. <div class="memitem">
  1507. <div class="memproto">
  1508. <table class="mlabels">
  1509. <tr>
  1510. <td class="mlabels-left">
  1511. <table class="memname">
  1512. <tr>
  1513. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  1514. <td>(</td>
  1515. <td class="paramname"></td><td>)</td>
  1516. <td></td>
  1517. </tr>
  1518. </table>
  1519. </td>
  1520. <td class="mlabels-right">
  1521. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1522. </tr>
  1523. </table>
  1524. </div><div class="memdoc">
  1525. <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>
  1526. </div>
  1527. </div>
  1528. <a class="anchor" id="a24dfcd1a1c716e8e56f8128d69dc1463"></a>
  1529. <div class="memitem">
  1530. <div class="memproto">
  1531. <table class="mlabels">
  1532. <tr>
  1533. <td class="mlabels-left">
  1534. <table class="memname">
  1535. <tr>
  1536. <td class="memname"><a class="el" href="class_sd_base_file.html">SdBaseFile</a>* SdFatBase::vwd </td>
  1537. <td>(</td>
  1538. <td class="paramname"></td><td>)</td>
  1539. <td></td>
  1540. </tr>
  1541. </table>
  1542. </td>
  1543. <td class="mlabels-right">
  1544. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1545. </tr>
  1546. </table>
  1547. </div><div class="memdoc">
  1548. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  1549. </div>
  1550. </div>
  1551. <hr/>The documentation for this class was generated from the following files:<ul>
  1552. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  1553. <li>Arduino/libraries/SdFat/SdFatBase.cpp</li>
  1554. </ul>
  1555. </div><!-- contents -->
  1556. <!-- start footer part -->
  1557. <hr class="footer"/><address class="footer"><small>
  1558. Generated on Sat Nov 15 2014 10:05:36 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1559. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1560. </a> 1.8.8
  1561. </small></address>
  1562. </body>
  1563. </html>