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.

1644 lines
71KB

  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#aee22e896c14d3baca69ddf0ec1c39724">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_volume_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_volume_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. <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>
  196. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. </table>
  198. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  199. <div class="textblock"><p>Virtual base class for SdFat library. </p>
  200. </div><h2 class="groupheader">Member Function Documentation</h2>
  201. <a class="anchor" id="a3d3f2cc4df1b6f2a129c3a614c1e5e1f"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">bool SdFatBase::begin </td>
  210. <td>(</td>
  211. <td class="paramtype"><a class="el" href="class_sd_spi_card.html#aee22e896c14d3baca69ddf0ec1c39724">SdSpiCard::m_spi_t</a> *&#160;</td>
  212. <td class="paramname"><em>spi</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">uint8_t&#160;</td>
  218. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">uint8_t&#160;</td>
  224. <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>
  225. </tr>
  226. <tr>
  227. <td></td>
  228. <td>)</td>
  229. <td></td><td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Initialize SD card and file system. </p><dl class="params"><dt>Parameters</dt><dd>
  239. <table class="params">
  240. <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI object for the card. </td></tr>
  241. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  242. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>
  243. </table>
  244. </dd>
  245. </dl>
  246. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  247. </div>
  248. </div>
  249. <a class="anchor" id="a899294ced4e4585feae7668099338534"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a>* SdFatBase::card </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>
  270. </div>
  271. </div>
  272. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">bool FatFileSystem::chdir </td>
  281. <td>(</td>
  282. <td class="paramtype">bool&#160;</td>
  283. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  284. <td></td>
  285. </tr>
  286. </table>
  287. </td>
  288. <td class="mlabels-right">
  289. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Change a volume's working directory to root</p>
  294. <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>
  295. <dl class="params"><dt>Parameters</dt><dd>
  296. <table class="params">
  297. <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>
  298. </table>
  299. </dd>
  300. </dl>
  301. <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>
  302. </div>
  303. </div>
  304. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="mlabels">
  308. <tr>
  309. <td class="mlabels-left">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">bool FatFileSystem::chdir </td>
  313. <td>(</td>
  314. <td class="paramtype">const char *&#160;</td>
  315. <td class="paramname"><em>path</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">bool&#160;</td>
  321. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  322. </tr>
  323. <tr>
  324. <td></td>
  325. <td>)</td>
  326. <td></td><td></td>
  327. </tr>
  328. </table>
  329. </td>
  330. <td class="mlabels-right">
  331. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Change a volume's working directory</p>
  336. <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>
  337. <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>
  338. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  339. <dl class="params"><dt>Parameters</dt><dd>
  340. <table class="params">
  341. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  342. <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>
  343. </table>
  344. </dd>
  345. </dl>
  346. <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>
  347. </div>
  348. </div>
  349. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="mlabels">
  353. <tr>
  354. <td class="mlabels-left">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">void FatFileSystem::chvol </td>
  358. <td>(</td>
  359. <td class="paramname"></td><td>)</td>
  360. <td></td>
  361. </tr>
  362. </table>
  363. </td>
  364. <td class="mlabels-right">
  365. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Set the current working directory to a volume's working directory.</p>
  370. <p>This is useful with multiple SD cards.</p>
  371. <p>The current working directory is changed to this volume's working directory.</p>
  372. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  373. </div>
  374. </div>
  375. <a class="anchor" id="a905d883dcbaa60aa35a6eb0cad63cc9e"></a>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">void SdFatBase::errorHalt </td>
  384. <td>(</td>
  385. <td class="paramname"></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </td>
  390. <td class="mlabels-right">
  391. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>Print any SD error code to Serial and halt. </p>
  396. </div>
  397. </div>
  398. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></a>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">void SdFatBase::errorHalt </td>
  404. <td>(</td>
  405. <td class="paramtype">Print *&#160;</td>
  406. <td class="paramname"><em>pr</em></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>Print any SD error code and halt.</p>
  412. <dl class="params"><dt>Parameters</dt><dd>
  413. <table class="params">
  414. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  415. </table>
  416. </dd>
  417. </dl>
  418. </div>
  419. </div>
  420. <a class="anchor" id="a07e04b976ffcaf7e9492e50c6e4900a8"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="mlabels">
  424. <tr>
  425. <td class="mlabels-left">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">void SdFatBase::errorHalt </td>
  429. <td>(</td>
  430. <td class="paramtype">char const *&#160;</td>
  431. <td class="paramname"><em>msg</em></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </td>
  436. <td class="mlabels-right">
  437. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Print msg, any SD error code and halt.</p>
  442. <dl class="params"><dt>Parameters</dt><dd>
  443. <table class="params">
  444. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  445. </table>
  446. </dd>
  447. </dl>
  448. </div>
  449. </div>
  450. <a class="anchor" id="a7c52e1a1909c9aa532b8525cf721fd89"></a>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname">void SdFatBase::errorHalt </td>
  456. <td>(</td>
  457. <td class="paramtype">Print *&#160;</td>
  458. <td class="paramname"><em>pr</em>, </td>
  459. </tr>
  460. <tr>
  461. <td class="paramkey"></td>
  462. <td></td>
  463. <td class="paramtype">char const *&#160;</td>
  464. <td class="paramname"><em>msg</em>&#160;</td>
  465. </tr>
  466. <tr>
  467. <td></td>
  468. <td>)</td>
  469. <td></td><td></td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <p>Print msg, any SD error code, and halt.</p>
  474. <dl class="params"><dt>Parameters</dt><dd>
  475. <table class="params">
  476. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  477. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  478. </table>
  479. </dd>
  480. </dl>
  481. </div>
  482. </div>
  483. <a class="anchor" id="a111cecbcc7ea5c068c44051491a77a52"></a>
  484. <div class="memitem">
  485. <div class="memproto">
  486. <table class="mlabels">
  487. <tr>
  488. <td class="mlabels-left">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">void SdFatBase::errorHalt </td>
  492. <td>(</td>
  493. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  494. <td class="paramname"><em>msg</em></td><td>)</td>
  495. <td></td>
  496. </tr>
  497. </table>
  498. </td>
  499. <td class="mlabels-right">
  500. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. <p>Print msg, any SD error code, and halt.</p>
  505. <dl class="params"><dt>Parameters</dt><dd>
  506. <table class="params">
  507. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  508. </table>
  509. </dd>
  510. </dl>
  511. </div>
  512. </div>
  513. <a class="anchor" id="a4c34e68605243269f96122a9cb909004"></a>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">void SdFatBase::errorHalt </td>
  519. <td>(</td>
  520. <td class="paramtype">Print *&#160;</td>
  521. <td class="paramname"><em>pr</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  527. <td class="paramname"><em>msg</em>&#160;</td>
  528. </tr>
  529. <tr>
  530. <td></td>
  531. <td>)</td>
  532. <td></td><td></td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <p>Print msg, any SD error code, and halt.</p>
  537. <dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  540. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  541. </table>
  542. </dd>
  543. </dl>
  544. </div>
  545. </div>
  546. <a class="anchor" id="a2deadc5b8bcdf5710fefba39b895e008"></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">void SdFatBase::errorPrint </td>
  555. <td>(</td>
  556. <td class="paramname"></td><td>)</td>
  557. <td></td>
  558. </tr>
  559. </table>
  560. </td>
  561. <td class="mlabels-right">
  562. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  563. </tr>
  564. </table>
  565. </div><div class="memdoc">
  566. <p>Print any SD error code to Serial </p>
  567. </div>
  568. </div>
  569. <a class="anchor" id="aaa950f290e41c0ff2d62b94cb425ba12"></a>
  570. <div class="memitem">
  571. <div class="memproto">
  572. <table class="memname">
  573. <tr>
  574. <td class="memname">void SdFatBase::errorPrint </td>
  575. <td>(</td>
  576. <td class="paramtype">Print *&#160;</td>
  577. <td class="paramname"><em>pr</em></td><td>)</td>
  578. <td></td>
  579. </tr>
  580. </table>
  581. </div><div class="memdoc">
  582. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  583. <table class="params">
  584. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  585. </table>
  586. </dd>
  587. </dl>
  588. </div>
  589. </div>
  590. <a class="anchor" id="a84fe32d89460471cf9f66495f545e2ae"></a>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="mlabels">
  594. <tr>
  595. <td class="mlabels-left">
  596. <table class="memname">
  597. <tr>
  598. <td class="memname">void SdFatBase::errorPrint </td>
  599. <td>(</td>
  600. <td class="paramtype">const char *&#160;</td>
  601. <td class="paramname"><em>msg</em></td><td>)</td>
  602. <td></td>
  603. </tr>
  604. </table>
  605. </td>
  606. <td class="mlabels-right">
  607. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  608. </tr>
  609. </table>
  610. </div><div class="memdoc">
  611. <p>Print msg, any SD error code.</p>
  612. <dl class="params"><dt>Parameters</dt><dd>
  613. <table class="params">
  614. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  615. </table>
  616. </dd>
  617. </dl>
  618. </div>
  619. </div>
  620. <a class="anchor" id="a5ecc4177c65f8e2837a9ef4d17368a98"></a>
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">void SdFatBase::errorPrint </td>
  626. <td>(</td>
  627. <td class="paramtype">Print *&#160;</td>
  628. <td class="paramname"><em>pr</em>, </td>
  629. </tr>
  630. <tr>
  631. <td class="paramkey"></td>
  632. <td></td>
  633. <td class="paramtype">char const *&#160;</td>
  634. <td class="paramname"><em>msg</em>&#160;</td>
  635. </tr>
  636. <tr>
  637. <td></td>
  638. <td>)</td>
  639. <td></td><td></td>
  640. </tr>
  641. </table>
  642. </div><div class="memdoc">
  643. <p>Print msg, any SD error code.</p>
  644. <dl class="params"><dt>Parameters</dt><dd>
  645. <table class="params">
  646. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  647. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  648. </table>
  649. </dd>
  650. </dl>
  651. </div>
  652. </div>
  653. <a class="anchor" id="a7eed2449f96d62e87bea96c6da4f618a"></a>
  654. <div class="memitem">
  655. <div class="memproto">
  656. <table class="mlabels">
  657. <tr>
  658. <td class="mlabels-left">
  659. <table class="memname">
  660. <tr>
  661. <td class="memname">void SdFatBase::errorPrint </td>
  662. <td>(</td>
  663. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  664. <td class="paramname"><em>msg</em></td><td>)</td>
  665. <td></td>
  666. </tr>
  667. </table>
  668. </td>
  669. <td class="mlabels-right">
  670. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  671. </tr>
  672. </table>
  673. </div><div class="memdoc">
  674. <p>Print msg, any SD error code.</p>
  675. <dl class="params"><dt>Parameters</dt><dd>
  676. <table class="params">
  677. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  678. </table>
  679. </dd>
  680. </dl>
  681. </div>
  682. </div>
  683. <a class="anchor" id="aace11e097b69144a80a4abbca54d35b0"></a>
  684. <div class="memitem">
  685. <div class="memproto">
  686. <table class="memname">
  687. <tr>
  688. <td class="memname">void SdFatBase::errorPrint </td>
  689. <td>(</td>
  690. <td class="paramtype">Print *&#160;</td>
  691. <td class="paramname"><em>pr</em>, </td>
  692. </tr>
  693. <tr>
  694. <td class="paramkey"></td>
  695. <td></td>
  696. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  697. <td class="paramname"><em>msg</em>&#160;</td>
  698. </tr>
  699. <tr>
  700. <td></td>
  701. <td>)</td>
  702. <td></td><td></td>
  703. </tr>
  704. </table>
  705. </div><div class="memdoc">
  706. <p>Print msg, any SD error code.</p>
  707. <dl class="params"><dt>Parameters</dt><dd>
  708. <table class="params">
  709. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  710. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  711. </table>
  712. </dd>
  713. </dl>
  714. </div>
  715. </div>
  716. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>
  717. <div class="memitem">
  718. <div class="memproto">
  719. <table class="mlabels">
  720. <tr>
  721. <td class="mlabels-left">
  722. <table class="memname">
  723. <tr>
  724. <td class="memname">bool FatFileSystem::exists </td>
  725. <td>(</td>
  726. <td class="paramtype">const char *&#160;</td>
  727. <td class="paramname"><em>path</em></td><td>)</td>
  728. <td></td>
  729. </tr>
  730. </table>
  731. </td>
  732. <td class="mlabels-right">
  733. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Test for the existence of a file.</p>
  738. <dl class="params"><dt>Parameters</dt><dd>
  739. <table class="params">
  740. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  741. </table>
  742. </dd>
  743. </dl>
  744. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  745. </div>
  746. </div>
  747. <a class="anchor" id="a389f0ef6fb556c67b48ade5c0c1b3a9a"></a>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="mlabels">
  751. <tr>
  752. <td class="mlabels-left">
  753. <table class="memname">
  754. <tr>
  755. <td class="memname">bool SdFatBase::fsBegin </td>
  756. <td>(</td>
  757. <td class="paramname"></td><td>)</td>
  758. <td></td>
  759. </tr>
  760. </table>
  761. </td>
  762. <td class="mlabels-right">
  763. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  764. </tr>
  765. </table>
  766. </div><div class="memdoc">
  767. <p>Diagnostic call to initialize <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> - use for diagnostic purposes only. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  768. </div>
  769. </div>
  770. <a class="anchor" id="adbfd9264f972f054e561128bad0b267e"></a>
  771. <div class="memitem">
  772. <div class="memproto">
  773. <table class="mlabels">
  774. <tr>
  775. <td class="mlabels-left">
  776. <table class="memname">
  777. <tr>
  778. <td class="memname">void SdFatBase::initErrorHalt </td>
  779. <td>(</td>
  780. <td class="paramname"></td><td>)</td>
  781. <td></td>
  782. </tr>
  783. </table>
  784. </td>
  785. <td class="mlabels-right">
  786. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  787. </tr>
  788. </table>
  789. </div><div class="memdoc">
  790. <p>Print any SD error code and halt. </p>
  791. </div>
  792. </div>
  793. <a class="anchor" id="a86770dd889bffc5788172c8d34a3582c"></a>
  794. <div class="memitem">
  795. <div class="memproto">
  796. <table class="memname">
  797. <tr>
  798. <td class="memname">void SdFatBase::initErrorHalt </td>
  799. <td>(</td>
  800. <td class="paramtype">Print *&#160;</td>
  801. <td class="paramname"><em>pr</em></td><td>)</td>
  802. <td></td>
  803. </tr>
  804. </table>
  805. </div><div class="memdoc">
  806. <p>Print error details and halt after begin fails.</p>
  807. <dl class="params"><dt>Parameters</dt><dd>
  808. <table class="params">
  809. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  810. </table>
  811. </dd>
  812. </dl>
  813. </div>
  814. </div>
  815. <a class="anchor" id="a0d4c851a3243c9f8c21d3894821292e9"></a>
  816. <div class="memitem">
  817. <div class="memproto">
  818. <table class="mlabels">
  819. <tr>
  820. <td class="mlabels-left">
  821. <table class="memname">
  822. <tr>
  823. <td class="memname">void SdFatBase::initErrorHalt </td>
  824. <td>(</td>
  825. <td class="paramtype">char const *&#160;</td>
  826. <td class="paramname"><em>msg</em></td><td>)</td>
  827. <td></td>
  828. </tr>
  829. </table>
  830. </td>
  831. <td class="mlabels-right">
  832. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  833. </tr>
  834. </table>
  835. </div><div class="memdoc">
  836. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  837. <dl class="params"><dt>Parameters</dt><dd>
  838. <table class="params">
  839. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  840. </table>
  841. </dd>
  842. </dl>
  843. </div>
  844. </div>
  845. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></a>
  846. <div class="memitem">
  847. <div class="memproto">
  848. <table class="memname">
  849. <tr>
  850. <td class="memname">void SdFatBase::initErrorHalt </td>
  851. <td>(</td>
  852. <td class="paramtype">Print *&#160;</td>
  853. <td class="paramname"><em>pr</em>, </td>
  854. </tr>
  855. <tr>
  856. <td class="paramkey"></td>
  857. <td></td>
  858. <td class="paramtype">char const *&#160;</td>
  859. <td class="paramname"><em>msg</em>&#160;</td>
  860. </tr>
  861. <tr>
  862. <td></td>
  863. <td>)</td>
  864. <td></td><td></td>
  865. </tr>
  866. </table>
  867. </div><div class="memdoc">
  868. <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>
  869. <table class="params">
  870. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  871. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  872. </table>
  873. </dd>
  874. </dl>
  875. </div>
  876. </div>
  877. <a class="anchor" id="abe312251854aebf5b8d6b4f9896660ed"></a>
  878. <div class="memitem">
  879. <div class="memproto">
  880. <table class="mlabels">
  881. <tr>
  882. <td class="mlabels-left">
  883. <table class="memname">
  884. <tr>
  885. <td class="memname">void SdFatBase::initErrorHalt </td>
  886. <td>(</td>
  887. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  888. <td class="paramname"><em>msg</em></td><td>)</td>
  889. <td></td>
  890. </tr>
  891. </table>
  892. </td>
  893. <td class="mlabels-right">
  894. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  895. </tr>
  896. </table>
  897. </div><div class="memdoc">
  898. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  899. <dl class="params"><dt>Parameters</dt><dd>
  900. <table class="params">
  901. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  902. </table>
  903. </dd>
  904. </dl>
  905. </div>
  906. </div>
  907. <a class="anchor" id="aa93c7fec40b37e7f5dd1e362ebf5ff69"></a>
  908. <div class="memitem">
  909. <div class="memproto">
  910. <table class="memname">
  911. <tr>
  912. <td class="memname">void SdFatBase::initErrorHalt </td>
  913. <td>(</td>
  914. <td class="paramtype">Print *&#160;</td>
  915. <td class="paramname"><em>pr</em>, </td>
  916. </tr>
  917. <tr>
  918. <td class="paramkey"></td>
  919. <td></td>
  920. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  921. <td class="paramname"><em>msg</em>&#160;</td>
  922. </tr>
  923. <tr>
  924. <td></td>
  925. <td>)</td>
  926. <td></td><td></td>
  927. </tr>
  928. </table>
  929. </div><div class="memdoc">
  930. <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>
  931. <table class="params">
  932. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>
  933. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  934. </table>
  935. </dd>
  936. </dl>
  937. </div>
  938. </div>
  939. <a class="anchor" id="a62a979138be1b62942f7b3f04964356e"></a>
  940. <div class="memitem">
  941. <div class="memproto">
  942. <table class="mlabels">
  943. <tr>
  944. <td class="mlabels-left">
  945. <table class="memname">
  946. <tr>
  947. <td class="memname">void SdFatBase::initErrorPrint </td>
  948. <td>(</td>
  949. <td class="paramname"></td><td>)</td>
  950. <td></td>
  951. </tr>
  952. </table>
  953. </td>
  954. <td class="mlabels-right">
  955. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  956. </tr>
  957. </table>
  958. </div><div class="memdoc">
  959. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails. </p>
  960. </div>
  961. </div>
  962. <a class="anchor" id="adffd5a3e802842b371b170c6df6b2530"></a>
  963. <div class="memitem">
  964. <div class="memproto">
  965. <table class="memname">
  966. <tr>
  967. <td class="memname">void SdFatBase::initErrorPrint </td>
  968. <td>(</td>
  969. <td class="paramtype">Print *&#160;</td>
  970. <td class="paramname"><em>pr</em></td><td>)</td>
  971. <td></td>
  972. </tr>
  973. </table>
  974. </div><div class="memdoc">
  975. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  976. <dl class="params"><dt>Parameters</dt><dd>
  977. <table class="params">
  978. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  979. </table>
  980. </dd>
  981. </dl>
  982. </div>
  983. </div>
  984. <a class="anchor" id="a296855ca8cc7590b9cbe7b3aeabc8467"></a>
  985. <div class="memitem">
  986. <div class="memproto">
  987. <table class="mlabels">
  988. <tr>
  989. <td class="mlabels-left">
  990. <table class="memname">
  991. <tr>
  992. <td class="memname">void SdFatBase::initErrorPrint </td>
  993. <td>(</td>
  994. <td class="paramtype">char const *&#160;</td>
  995. <td class="paramname"><em>msg</em></td><td>)</td>
  996. <td></td>
  997. </tr>
  998. </table>
  999. </td>
  1000. <td class="mlabels-right">
  1001. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1002. </tr>
  1003. </table>
  1004. </div><div class="memdoc">
  1005. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1006. <dl class="params"><dt>Parameters</dt><dd>
  1007. <table class="params">
  1008. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1009. </table>
  1010. </dd>
  1011. </dl>
  1012. </div>
  1013. </div>
  1014. <a class="anchor" id="aca07f92b3a06ede0e7a56b68b76dc3b7"></a>
  1015. <div class="memitem">
  1016. <div class="memproto">
  1017. <table class="memname">
  1018. <tr>
  1019. <td class="memname">void SdFatBase::initErrorPrint </td>
  1020. <td>(</td>
  1021. <td class="paramtype">Print *&#160;</td>
  1022. <td class="paramname"><em>pr</em>, </td>
  1023. </tr>
  1024. <tr>
  1025. <td class="paramkey"></td>
  1026. <td></td>
  1027. <td class="paramtype">char const *&#160;</td>
  1028. <td class="paramname"><em>msg</em>&#160;</td>
  1029. </tr>
  1030. <tr>
  1031. <td></td>
  1032. <td>)</td>
  1033. <td></td><td></td>
  1034. </tr>
  1035. </table>
  1036. </div><div class="memdoc">
  1037. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1038. <dl class="params"><dt>Parameters</dt><dd>
  1039. <table class="params">
  1040. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1041. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1042. </table>
  1043. </dd>
  1044. </dl>
  1045. </div>
  1046. </div>
  1047. <a class="anchor" id="a9c334faf236651db265d5acf65271666"></a>
  1048. <div class="memitem">
  1049. <div class="memproto">
  1050. <table class="mlabels">
  1051. <tr>
  1052. <td class="mlabels-left">
  1053. <table class="memname">
  1054. <tr>
  1055. <td class="memname">void SdFatBase::initErrorPrint </td>
  1056. <td>(</td>
  1057. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1058. <td class="paramname"><em>msg</em></td><td>)</td>
  1059. <td></td>
  1060. </tr>
  1061. </table>
  1062. </td>
  1063. <td class="mlabels-right">
  1064. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1065. </tr>
  1066. </table>
  1067. </div><div class="memdoc">
  1068. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>
  1069. <dl class="params"><dt>Parameters</dt><dd>
  1070. <table class="params">
  1071. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1072. </table>
  1073. </dd>
  1074. </dl>
  1075. </div>
  1076. </div>
  1077. <a class="anchor" id="ac0b7161c1385841264323ac244f5c89c"></a>
  1078. <div class="memitem">
  1079. <div class="memproto">
  1080. <table class="memname">
  1081. <tr>
  1082. <td class="memname">void SdFatBase::initErrorPrint </td>
  1083. <td>(</td>
  1084. <td class="paramtype">Print *&#160;</td>
  1085. <td class="paramname"><em>pr</em>, </td>
  1086. </tr>
  1087. <tr>
  1088. <td class="paramkey"></td>
  1089. <td></td>
  1090. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1091. <td class="paramname"><em>msg</em>&#160;</td>
  1092. </tr>
  1093. <tr>
  1094. <td></td>
  1095. <td>)</td>
  1096. <td></td><td></td>
  1097. </tr>
  1098. </table>
  1099. </div><div class="memdoc">
  1100. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>
  1101. <dl class="params"><dt>Parameters</dt><dd>
  1102. <table class="params">
  1103. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1104. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1105. </table>
  1106. </dd>
  1107. </dl>
  1108. </div>
  1109. </div>
  1110. <a class="anchor" id="ad17f2a0925b34cb3807e4c1677a2872f"></a>
  1111. <div class="memitem">
  1112. <div class="memproto">
  1113. <table class="mlabels">
  1114. <tr>
  1115. <td class="mlabels-left">
  1116. <table class="memname">
  1117. <tr>
  1118. <td class="memname">void FatFileSystem::ls </td>
  1119. <td>(</td>
  1120. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1121. <td class="paramname"><em>pr</em>, </td>
  1122. </tr>
  1123. <tr>
  1124. <td class="paramkey"></td>
  1125. <td></td>
  1126. <td class="paramtype">uint8_t&#160;</td>
  1127. <td class="paramname"><em>flags</em>&#160;</td>
  1128. </tr>
  1129. <tr>
  1130. <td></td>
  1131. <td>)</td>
  1132. <td></td><td></td>
  1133. </tr>
  1134. </table>
  1135. </td>
  1136. <td class="mlabels-right">
  1137. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1138. </tr>
  1139. </table>
  1140. </div><div class="memdoc">
  1141. <p>List the directory contents of the volume working directory.</p>
  1142. <dl class="params"><dt>Parameters</dt><dd>
  1143. <table class="params">
  1144. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1145. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1146. </table>
  1147. </dd>
  1148. </dl>
  1149. <p>LS_DATE - Print file modification date</p>
  1150. <p>LS_SIZE - Print file size.</p>
  1151. <p>LS_R - Recursive list of subdirectories. </p>
  1152. </div>
  1153. </div>
  1154. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>
  1155. <div class="memitem">
  1156. <div class="memproto">
  1157. <table class="mlabels">
  1158. <tr>
  1159. <td class="mlabels-left">
  1160. <table class="memname">
  1161. <tr>
  1162. <td class="memname">void FatFileSystem::ls </td>
  1163. <td>(</td>
  1164. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1165. <td class="paramname"><em>pr</em>, </td>
  1166. </tr>
  1167. <tr>
  1168. <td class="paramkey"></td>
  1169. <td></td>
  1170. <td class="paramtype">const char *&#160;</td>
  1171. <td class="paramname"><em>path</em>, </td>
  1172. </tr>
  1173. <tr>
  1174. <td class="paramkey"></td>
  1175. <td></td>
  1176. <td class="paramtype">uint8_t&#160;</td>
  1177. <td class="paramname"><em>flags</em>&#160;</td>
  1178. </tr>
  1179. <tr>
  1180. <td></td>
  1181. <td>)</td>
  1182. <td></td><td></td>
  1183. </tr>
  1184. </table>
  1185. </td>
  1186. <td class="mlabels-right">
  1187. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1188. </tr>
  1189. </table>
  1190. </div><div class="memdoc">
  1191. <p>List the directory contents of a directory.</p>
  1192. <dl class="params"><dt>Parameters</dt><dd>
  1193. <table class="params">
  1194. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1195. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1196. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1197. </table>
  1198. </dd>
  1199. </dl>
  1200. <p>LS_DATE - Print file modification date</p>
  1201. <p>LS_SIZE - Print file size.</p>
  1202. <p>LS_R - Recursive list of subdirectories. </p>
  1203. </div>
  1204. </div>
  1205. <a class="anchor" id="a6e2ba60320f47912a96ad83820073ce8"></a>
  1206. <div class="memitem">
  1207. <div class="memproto">
  1208. <table class="mlabels">
  1209. <tr>
  1210. <td class="mlabels-left">
  1211. <table class="memname">
  1212. <tr>
  1213. <td class="memname">void SdFatBase::ls </td>
  1214. <td>(</td>
  1215. <td class="paramtype">uint8_t&#160;</td>
  1216. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1217. <td></td>
  1218. </tr>
  1219. </table>
  1220. </td>
  1221. <td class="mlabels-right">
  1222. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1223. </tr>
  1224. </table>
  1225. </div><div class="memdoc">
  1226. <p>List the directory contents of the volume working directory to Serial.</p>
  1227. <dl class="params"><dt>Parameters</dt><dd>
  1228. <table class="params">
  1229. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1230. </table>
  1231. </dd>
  1232. </dl>
  1233. <p>LS_DATE - Print file modification date</p>
  1234. <p>LS_SIZE - Print file size.</p>
  1235. <p>LS_R - Recursive list of subdirectories. </p>
  1236. </div>
  1237. </div>
  1238. <a class="anchor" id="a85bd146c6fb0120ac69c3d93267321e6"></a>
  1239. <div class="memitem">
  1240. <div class="memproto">
  1241. <table class="mlabels">
  1242. <tr>
  1243. <td class="mlabels-left">
  1244. <table class="memname">
  1245. <tr>
  1246. <td class="memname">void SdFatBase::ls </td>
  1247. <td>(</td>
  1248. <td class="paramtype">const char *&#160;</td>
  1249. <td class="paramname"><em>path</em>, </td>
  1250. </tr>
  1251. <tr>
  1252. <td class="paramkey"></td>
  1253. <td></td>
  1254. <td class="paramtype">uint8_t&#160;</td>
  1255. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1256. </tr>
  1257. <tr>
  1258. <td></td>
  1259. <td>)</td>
  1260. <td></td><td></td>
  1261. </tr>
  1262. </table>
  1263. </td>
  1264. <td class="mlabels-right">
  1265. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1266. </tr>
  1267. </table>
  1268. </div><div class="memdoc">
  1269. <p>List the directory contents of a directory to Serial.</p>
  1270. <dl class="params"><dt>Parameters</dt><dd>
  1271. <table class="params">
  1272. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1273. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1274. </table>
  1275. </dd>
  1276. </dl>
  1277. <p>LS_DATE - Print file modification date</p>
  1278. <p>LS_SIZE - Print file size.</p>
  1279. <p>LS_R - Recursive list of subdirectories. </p>
  1280. </div>
  1281. </div>
  1282. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  1283. <div class="memitem">
  1284. <div class="memproto">
  1285. <table class="mlabels">
  1286. <tr>
  1287. <td class="mlabels-left">
  1288. <table class="memname">
  1289. <tr>
  1290. <td class="memname">bool FatFileSystem::mkdir </td>
  1291. <td>(</td>
  1292. <td class="paramtype">const char *&#160;</td>
  1293. <td class="paramname"><em>path</em>, </td>
  1294. </tr>
  1295. <tr>
  1296. <td class="paramkey"></td>
  1297. <td></td>
  1298. <td class="paramtype">bool&#160;</td>
  1299. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1300. </tr>
  1301. <tr>
  1302. <td></td>
  1303. <td>)</td>
  1304. <td></td><td></td>
  1305. </tr>
  1306. </table>
  1307. </td>
  1308. <td class="mlabels-right">
  1309. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1310. </tr>
  1311. </table>
  1312. </div><div class="memdoc">
  1313. <p>Make a subdirectory in the volume working directory.</p>
  1314. <dl class="params"><dt>Parameters</dt><dd>
  1315. <table class="params">
  1316. <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>
  1317. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1318. </table>
  1319. </dd>
  1320. </dl>
  1321. <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>
  1322. </div>
  1323. </div>
  1324. <a class="anchor" id="af2b23a0be384abb31989eb86aabdb5d8"></a>
  1325. <div class="memitem">
  1326. <div class="memproto">
  1327. <table class="memname">
  1328. <tr>
  1329. <td class="memname"><a class="el" href="class_file.html">File</a> SdFatBase::open </td>
  1330. <td>(</td>
  1331. <td class="paramtype">const char *&#160;</td>
  1332. <td class="paramname"><em>path</em>, </td>
  1333. </tr>
  1334. <tr>
  1335. <td class="paramkey"></td>
  1336. <td></td>
  1337. <td class="paramtype">uint8_t&#160;</td>
  1338. <td class="paramname"><em>mode</em> = <code><a class="el" href="_sd_file_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1339. </tr>
  1340. <tr>
  1341. <td></td>
  1342. <td>)</td>
  1343. <td></td><td></td>
  1344. </tr>
  1345. </table>
  1346. </div><div class="memdoc">
  1347. <p>open a file</p>
  1348. <dl class="params"><dt>Parameters</dt><dd>
  1349. <table class="params">
  1350. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1351. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1352. </table>
  1353. </dd>
  1354. </dl>
  1355. <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>
  1356. </div>
  1357. </div>
  1358. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  1359. <div class="memitem">
  1360. <div class="memproto">
  1361. <table class="mlabels">
  1362. <tr>
  1363. <td class="mlabels-left">
  1364. <table class="memname">
  1365. <tr>
  1366. <td class="memname">bool FatFileSystem::remove </td>
  1367. <td>(</td>
  1368. <td class="paramtype">const char *&#160;</td>
  1369. <td class="paramname"><em>path</em></td><td>)</td>
  1370. <td></td>
  1371. </tr>
  1372. </table>
  1373. </td>
  1374. <td class="mlabels-right">
  1375. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1376. </tr>
  1377. </table>
  1378. </div><div class="memdoc">
  1379. <p>Remove a file from the volume working directory.</p>
  1380. <dl class="params"><dt>Parameters</dt><dd>
  1381. <table class="params">
  1382. <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>
  1383. </table>
  1384. </dd>
  1385. </dl>
  1386. <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>
  1387. </div>
  1388. </div>
  1389. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>
  1390. <div class="memitem">
  1391. <div class="memproto">
  1392. <table class="mlabels">
  1393. <tr>
  1394. <td class="mlabels-left">
  1395. <table class="memname">
  1396. <tr>
  1397. <td class="memname">bool FatFileSystem::rename </td>
  1398. <td>(</td>
  1399. <td class="paramtype">const char *&#160;</td>
  1400. <td class="paramname"><em>oldPath</em>, </td>
  1401. </tr>
  1402. <tr>
  1403. <td class="paramkey"></td>
  1404. <td></td>
  1405. <td class="paramtype">const char *&#160;</td>
  1406. <td class="paramname"><em>newPath</em>&#160;</td>
  1407. </tr>
  1408. <tr>
  1409. <td></td>
  1410. <td>)</td>
  1411. <td></td><td></td>
  1412. </tr>
  1413. </table>
  1414. </td>
  1415. <td class="mlabels-right">
  1416. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1417. </tr>
  1418. </table>
  1419. </div><div class="memdoc">
  1420. <p>Rename a file or subdirectory.</p>
  1421. <dl class="params"><dt>Parameters</dt><dd>
  1422. <table class="params">
  1423. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1424. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1425. </table>
  1426. </dd>
  1427. </dl>
  1428. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1429. <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>
  1430. <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>
  1431. </div>
  1432. </div>
  1433. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  1434. <div class="memitem">
  1435. <div class="memproto">
  1436. <table class="mlabels">
  1437. <tr>
  1438. <td class="mlabels-left">
  1439. <table class="memname">
  1440. <tr>
  1441. <td class="memname">bool FatFileSystem::rmdir </td>
  1442. <td>(</td>
  1443. <td class="paramtype">const char *&#160;</td>
  1444. <td class="paramname"><em>path</em></td><td>)</td>
  1445. <td></td>
  1446. </tr>
  1447. </table>
  1448. </td>
  1449. <td class="mlabels-right">
  1450. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1451. </tr>
  1452. </table>
  1453. </div><div class="memdoc">
  1454. <p>Remove a subdirectory from the volume's working directory.</p>
  1455. <dl class="params"><dt>Parameters</dt><dd>
  1456. <table class="params">
  1457. <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>
  1458. </table>
  1459. </dd>
  1460. </dl>
  1461. <p>The subdirectory file will be removed only if it is empty.</p>
  1462. <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>
  1463. </div>
  1464. </div>
  1465. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  1466. <div class="memitem">
  1467. <div class="memproto">
  1468. <table class="mlabels">
  1469. <tr>
  1470. <td class="mlabels-left">
  1471. <table class="memname">
  1472. <tr>
  1473. <td class="memname">bool FatFileSystem::truncate </td>
  1474. <td>(</td>
  1475. <td class="paramtype">const char *&#160;</td>
  1476. <td class="paramname"><em>path</em>, </td>
  1477. </tr>
  1478. <tr>
  1479. <td class="paramkey"></td>
  1480. <td></td>
  1481. <td class="paramtype">uint32_t&#160;</td>
  1482. <td class="paramname"><em>length</em>&#160;</td>
  1483. </tr>
  1484. <tr>
  1485. <td></td>
  1486. <td>)</td>
  1487. <td></td><td></td>
  1488. </tr>
  1489. </table>
  1490. </td>
  1491. <td class="mlabels-right">
  1492. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1493. </tr>
  1494. </table>
  1495. </div><div class="memdoc">
  1496. <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>
  1497. <dl class="params"><dt>Parameters</dt><dd>
  1498. <table class="params">
  1499. <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>
  1500. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1501. </table>
  1502. </dd>
  1503. </dl>
  1504. <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>
  1505. </div>
  1506. </div>
  1507. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  1508. <div class="memitem">
  1509. <div class="memproto">
  1510. <table class="mlabels">
  1511. <tr>
  1512. <td class="mlabels-left">
  1513. <table class="memname">
  1514. <tr>
  1515. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  1516. <td>(</td>
  1517. <td class="paramname"></td><td>)</td>
  1518. <td></td>
  1519. </tr>
  1520. </table>
  1521. </td>
  1522. <td class="mlabels-right">
  1523. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1524. </tr>
  1525. </table>
  1526. </div><div class="memdoc">
  1527. <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>
  1528. </div>
  1529. </div>
  1530. <a class="anchor" id="a24dfcd1a1c716e8e56f8128d69dc1463"></a>
  1531. <div class="memitem">
  1532. <div class="memproto">
  1533. <table class="mlabels">
  1534. <tr>
  1535. <td class="mlabels-left">
  1536. <table class="memname">
  1537. <tr>
  1538. <td class="memname"><a class="el" href="class_sd_base_file.html">SdBaseFile</a>* SdFatBase::vwd </td>
  1539. <td>(</td>
  1540. <td class="paramname"></td><td>)</td>
  1541. <td></td>
  1542. </tr>
  1543. </table>
  1544. </td>
  1545. <td class="mlabels-right">
  1546. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1547. </tr>
  1548. </table>
  1549. </div><div class="memdoc">
  1550. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  1551. </div>
  1552. </div>
  1553. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>
  1554. <div class="memitem">
  1555. <div class="memproto">
  1556. <table class="mlabels">
  1557. <tr>
  1558. <td class="mlabels-left">
  1559. <table class="memname">
  1560. <tr>
  1561. <td class="memname">bool FatFileSystem::wipe </td>
  1562. <td>(</td>
  1563. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1564. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  1565. <td></td>
  1566. </tr>
  1567. </table>
  1568. </td>
  1569. <td class="mlabels-right">
  1570. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1571. </tr>
  1572. </table>
  1573. </div><div class="memdoc">
  1574. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>
  1575. <table class="params">
  1576. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  1577. </table>
  1578. </dd>
  1579. </dl>
  1580. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  1581. </div>
  1582. </div>
  1583. <hr/>The documentation for this class was generated from the following files:<ul>
  1584. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  1585. <li>Arduino/libraries/SdFat/SdFatBase.cpp</li>
  1586. </ul>
  1587. </div><!-- contents -->
  1588. <!-- start footer part -->
  1589. <hr class="footer"/><address class="footer"><small>
  1590. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1591. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1592. </a> 1.8.8
  1593. </small></address>
  1594. </body>
  1595. </html>