visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 Commits
1 Branch
Tree: d60a3ab342
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'd60a3ab342'
${ noResults }
teensy-sdfat/html/class_fat_file.html

2747 lines
129KB
Raw Blame History 

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

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

  3. <head>

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

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

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

  7. <title>SdFat: FatFile Class Reference</title>

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

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

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

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

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

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  65.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  66.     </ul>

  67.   </div>

  68. <!-- window showing the filter options -->

  69. <div id="MSearchSelectWindow"

  70.      onmouseover="return searchBox.OnSearchSelectShow()"

  71.      onmouseout="return searchBox.OnSearchSelectHide()"

  72.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  74. 

  75. <!-- iframe showing the search results (closed by default) -->

  76. <div id="MSearchResultsWindow">

  77. <iframe src="javascript:void(0)" frameborder="0" 

  78.         name="MSearchResults" id="MSearchResults">

  79. </iframe>

  80. </div>

  81. 

  82. </div><!-- top -->

  83. <div class="header">

  84.   <div class="summary">

  85. <a href="#pub-methods">Public Member Functions</a> &#124;

  86. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  87. <a href="class_fat_file-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">FatFile Class Reference</div>  </div>

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

  91. <div class="contents">

  92. 

  93. <p>Basic file class.  

  94.  <a href="class_fat_file.html#details">More...</a></p>

  95. 

  96. <p><code>#include &lt;FatFile.h&gt;</code></p>

  97. <div class="dynheader">

  98. Inheritance diagram for FatFile:</div>

  99. <div class="dyncontent">

  100. <div class="center"><img src="class_fat_file__inherit__graph.png" border="0" usemap="#_fat_file_inherit__map" alt="Inheritance graph"/></div>

  101. <map name="_fat_file_inherit__map" id="_fat_file_inherit__map">

  102. <area shape="rect" id="node3" href="class_fat_stream_base.html" title="Base class for C++ style streams. " alt="" coords="97,80,209,107"/>
<area shape="rect" id="node11" href="class_sd_base_file.html" title="SdBaseFile base for SdFile and File. " alt="" coords="259,80,348,107"/>
<area shape="rect" id="node17" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. " alt="" coords="373,80,467,107"/>
<area shape="rect" id="node5" href="classfstream.html" title="file input/output stream. " alt="" coords="5,155,69,181"/>
<area shape="rect" id="node7" href="classifstream.html" title="file input stream. " alt="" coords="94,155,161,181"/>
<area shape="rect" id="node9" href="classofstream.html" title="file output stream. " alt="" coords="187,155,259,181"/>
<area shape="rect" id="node13" href="class_file.html" title="Arduino SD.h style File API. " alt="" coords="283,155,325,181"/>
<area shape="rect" id="node15" href="class_sd_file.html" title="SdFile SdBaseFile with Print. " alt="" coords="349,155,408,181"/>
</map>

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

  104. <table class="memberdecls">

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

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

  107. <tr class="memitem:ac1fa779d98db7ffdb96f8019ab0060d6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac1fa779d98db7ffdb96f8019ab0060d6">available</a> ()</td></tr>

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

  109. <tr class="memitem:a052e2c15a39b322a5307b693b8835b22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a052e2c15a39b322a5307b693b8835b22">clearError</a> ()</td></tr>

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

  111. <tr class="memitem:aeca2a2eff91e6aa55fe1b0e3860c9a05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aeca2a2eff91e6aa55fe1b0e3860c9a05">clearWriteError</a> ()</td></tr>

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

  113. <tr class="memitem:afd16af325e0642e4bff6430b7d8bb18b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd16af325e0642e4bff6430b7d8bb18b">close</a> ()</td></tr>

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

  115. <tr class="memitem:aa367708bcc8bc0e0c45c0c2a812c65da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa367708bcc8bc0e0c45c0c2a812c65da">contiguousRange</a> (uint32_t *bgnBlock, uint32_t *endBlock)</td></tr>

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

  117. <tr class="memitem:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0afc2a1cffa238d1cb2049bfa2d8d199">createContiguous</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint32_t size)</td></tr>

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

  119. <tr class="memitem:a4c03e2f6729526786e6ab4a623e0339b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4c03e2f6729526786e6ab4a623e0339b">curCluster</a> () const </td></tr>

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

  121. <tr class="memitem:a20c55b134bfd1d287a00bf64eba9332e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a20c55b134bfd1d287a00bf64eba9332e">curPosition</a> () const </td></tr>

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

  123. <tr class="memitem:a6858d18c807411a071fd6d1b39d50087"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6858d18c807411a071fd6d1b39d50087">dirEntry</a> (<a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir)</td></tr>

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

  125. <tr class="memitem:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae5ec24d4a94d3780384d3f2b731c7eb9">dirIndex</a> ()</td></tr>

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

  127. <tr class="memitem:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae2ed15f05c9ccbce355e7a8d3ce8382d">dirSize</a> ()</td></tr>

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

  129. <tr class="memitem:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4f01d27954ae49aeb6888ac7302f55d9">dmpFile</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>

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

  131. <tr class="memitem:a50242f98dea0d4488ce4039a279f2a57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a50242f98dea0d4488ce4039a279f2a57">exists</a> (const char *path)</td></tr>

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

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

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

  135. <tr class="memitem:a29d31067d0aa3a9a74b1a660c38775cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a29d31067d0aa3a9a74b1a660c38775cc">FatFile</a> (const char *path, uint8_t oflag)</td></tr>

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

  137. <tr class="memitem:a31ef26b3ee37cf5f5f4c6024c0ddab69"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets</a> (char *str, int16_t num, char *delim=0)</td></tr>

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

  139. <tr class="memitem:a7e043dfb89d268bfd620bbbadacf1002"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e043dfb89d268bfd620bbbadacf1002">fileAttr</a> () const </td></tr>

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

  141. <tr class="memitem:a02fc3b3ca36b4745f695f3de8c8ec36d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a02fc3b3ca36b4745f695f3de8c8ec36d">fileSize</a> () const </td></tr>

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

  143. <tr class="memitem:a1057bc23b92a074539f661e896e79a09"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1057bc23b92a074539f661e896e79a09">firstCluster</a> () const </td></tr>

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

  145. <tr class="memitem:ad0dbbd083180f44c7a3ce7124d4ce19c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad0dbbd083180f44c7a3ce7124d4ce19c">getError</a> ()</td></tr>

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

  147. <tr class="memitem:a58a8aa8e48c2d4a5ee9585184efcfbfd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a58a8aa8e48c2d4a5ee9585184efcfbfd">getFilename</a> (char *name, size_t size)</td></tr>

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

  149. <tr class="memitem:aaa4f9886887947815a61eaf015996932"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aaa4f9886887947815a61eaf015996932">getpos</a> (<a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *pos)</td></tr>

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

  151. <tr class="memitem:aba30e92a66f8e0d2f815c85662772a58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aba30e92a66f8e0d2f815c85662772a58">getSFN</a> (char *name)</td></tr>

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

  153. <tr class="memitem:a8062c0d3a118e8d77d0310418703d5f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8062c0d3a118e8d77d0310418703d5f5">getWriteError</a> ()</td></tr>

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

  155. <tr class="memitem:aef41d65e0f1ce753d18cc9ed691f7de4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aef41d65e0f1ce753d18cc9ed691f7de4">isDir</a> () const </td></tr>

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

  157. <tr class="memitem:afcf6270ea8d4a3a5f8e89523bc684e22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afcf6270ea8d4a3a5f8e89523bc684e22">isFile</a> () const </td></tr>

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

  159. <tr class="memitem:a7eefe7408f34b6326f0c6e78af7eb05f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7eefe7408f34b6326f0c6e78af7eb05f">isHidden</a> () const </td></tr>

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

  161. <tr class="memitem:aed36d17f8fde597b6ed9446faec1f7e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aed36d17f8fde597b6ed9446faec1f7e3">isLFN</a> () const </td></tr>

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

  163. <tr class="memitem:a4c8a07b081f04aa25839c6f56c739bdc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4c8a07b081f04aa25839c6f56c739bdc">isOpen</a> () const </td></tr>

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

  165. <tr class="memitem:a6872d3acb1e70f81c9c2be2495977583"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6872d3acb1e70f81c9c2be2495977583">isReadOnly</a> () const </td></tr>

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

  167. <tr class="memitem:aa4a206803a4bf8243be20244c1aef4d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa4a206803a4bf8243be20244c1aef4d2">isRoot</a> () const </td></tr>

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

  169. <tr class="memitem:a1449b294e3a838396c62e47674ca8cf0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1449b294e3a838396c62e47674ca8cf0">isRoot32</a> () const </td></tr>

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

  171. <tr class="memitem:a8215bd4b21e11ec83fa88ef226ceb06f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8215bd4b21e11ec83fa88ef226ceb06f">isRootFixed</a> () const </td></tr>

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

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

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

  175. <tr class="memitem:add932e13e5bf32ad467af6ec34824e3c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#add932e13e5bf32ad467af6ec34824e3c">isSystem</a> () const </td></tr>

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

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

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

  179. <tr class="memitem:abab5b9f72cc796388dd4eed01d13d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abab5b9f72cc796388dd4eed01d13d90d">mkdir</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir, const char *path, bool pFlag=true)</td></tr>

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

  181. <tr class="memitem:a5f64576d3d19177ab3cf3812b69abdfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open</a> (<a class="el" href="class_fat_file_system.html">FatFileSystem</a> *fs, const char *path, uint8_t oflag)</td></tr>

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

  183. <tr class="memitem:ad3fa9daaccb4e4179fb88a8ca037aa80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad3fa9daaccb4e4179fb88a8ca037aa80">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, uint8_t oflag)</td></tr>

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

  185. <tr class="memitem:a211be757679b18708f6b6a36464e4f61"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint8_t oflag)</td></tr>

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

  187. <tr class="memitem:ab0e7075062c89f356441f80fc64d03e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab0e7075062c89f356441f80fc64d03e6">open</a> (const char *path, uint8_t oflag=O_READ)</td></tr>

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

  189. <tr class="memitem:a8034c4649eb0d26715b1a8a69e73d9d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8034c4649eb0d26715b1a8a69e73d9d0">openNext</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint8_t oflag=O_READ)</td></tr>

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

  191. <tr class="memitem:a7e0c0548fed3a69e7284b91b694439d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e0c0548fed3a69e7284b91b694439d4">openRoot</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol)</td></tr>

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

  193. <tr class="memitem:ac05b7136b887539426856c623869aa3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac05b7136b887539426856c623869aa3a">peek</a> ()</td></tr>

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

  195. <tr class="memitem:a558530f20314a8d8ee3d1a488fc7f46e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a558530f20314a8d8ee3d1a488fc7f46e">printCreateDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  197. <tr class="memitem:a7478cad0f9e5079311b9e1fa558016ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7478cad0f9e5079311b9e1fa558016ff">printField</a> (float value, char term, uint8_t prec=2)</td></tr>

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

  199. <tr class="memitem:abd3e1747511216462b3ef98167156cbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abd3e1747511216462b3ef98167156cbb">printField</a> (int16_t value, char term)</td></tr>

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

  201. <tr class="memitem:a9972c2419c293ef9c382bff666b9ae4d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9972c2419c293ef9c382bff666b9ae4d">printField</a> (uint16_t value, char term)</td></tr>

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

  203. <tr class="memitem:a41b3b32dd8482429b74c7af3432d6cf8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a41b3b32dd8482429b74c7af3432d6cf8">printField</a> (int32_t value, char term)</td></tr>

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

  205. <tr class="memitem:a097240f08baadeb1c64b63eab9afb088"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a097240f08baadeb1c64b63eab9afb088">printField</a> (uint32_t value, char term)</td></tr>

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

  207. <tr class="memitem:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a12a5d2de2737c201aa39ca1bd2ab9c47">printFileSize</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  209. <tr class="memitem:a05cee5df46a370bf916d3ba597c82e39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a05cee5df46a370bf916d3ba597c82e39">printModifyDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  211. <tr class="memitem:afe18a787fb8640e2d2483370c770f82f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe18a787fb8640e2d2483370c770f82f">printName</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  213. <tr class="memitem:a791cd7aade71f609aab62ec018aea3c0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a791cd7aade71f609aab62ec018aea3c0">printSFN</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  215. <tr class="memitem:a60ae55ff6fe158c2340071d702a363c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read</a> ()</td></tr>

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

  217. <tr class="memitem:a200e6e0553d5b709520c9dfac9ef77dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a200e6e0553d5b709520c9dfac9ef77dd">read</a> (void *buf, size_t nbyte)</td></tr>

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

  219. <tr class="memitem:a1325afe074c3efecff666678cd9f116a"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir</a> (<a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir)</td></tr>

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

  221. <tr class="memitem:ac837a537fbcca14c7aa390c5fc9f4e7c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove</a> ()</td></tr>

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

  223. <tr class="memitem:a4b42f2454ff462555c07ea094a92a1e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4b42f2454ff462555c07ea094a92a1e0">rename</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *newPath)</td></tr>

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

  225. <tr class="memitem:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5aac6e0b3cb08fc8b8668e916a8b0ca5">rewind</a> ()</td></tr>

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

  227. <tr class="memitem:a9515bac181d33e7f0125e88fa2ccd283"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir</a> ()</td></tr>

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

  229. <tr class="memitem:ac780a80526f86d3def701ecdc99d8bfe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac780a80526f86d3def701ecdc99d8bfe">rmRfStar</a> ()</td></tr>

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

  231. <tr class="memitem:a5812037ea30777cc350698ad26f2c73f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5812037ea30777cc350698ad26f2c73f">seekCur</a> (int32_t offset)</td></tr>

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

  233. <tr class="memitem:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a84f677f4e75ef6fa2eb632f4cdf6b486">seekEnd</a> (int32_t offset=0)</td></tr>

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

  235. <tr class="memitem:ab067190d25733ed7e697d9890f61fd7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet</a> (uint32_t pos)</td></tr>

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

  237. <tr class="memitem:acf264de4e3ca36c5e8a39e56173c9044"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acf264de4e3ca36c5e8a39e56173c9044">setpos</a> (<a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *pos)</td></tr>

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

  239. <tr class="memitem:a67f3dc4896c542d695e11aac927f585e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync</a> ()</td></tr>

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

  241. <tr class="memitem:aa53a8d1d2467ad9af7d61cbf8ee85243"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa53a8d1d2467ad9af7d61cbf8ee85243">timestamp</a> (<a class="el" href="class_fat_file.html">FatFile</a> *file)</td></tr>

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

  243. <tr class="memitem:a56dabdf73833b7e961c4530eb8e16d23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a56dabdf73833b7e961c4530eb8e16d23">timestamp</a> (uint8_t flags, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)</td></tr>

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

  245. <tr class="memitem:aa6e663098a578635d37d92e82d18d616"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa6e663098a578635d37d92e82d18d616">truncate</a> (uint32_t length)</td></tr>

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

  247. <tr class="memitem:a3c64bd8a9abb9a6461d4addb405614df"><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.html#a3c64bd8a9abb9a6461d4addb405614df">volume</a> () const </td></tr>

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

  249. <tr class="memitem:a5524bd9f3b8f54ee163e391cba618186"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write</a> (uint8_t b)</td></tr>

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

  251. <tr class="memitem:a0ab9df44a9ee4b6eb0a78f15f1e30004"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0ab9df44a9ee4b6eb0a78f15f1e30004">write</a> (const void *buf, size_t nbyte)</td></tr>

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

  253. </table><table class="memberdecls">

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

  255. Static Public Member Functions</h2></td></tr>

  256. <tr class="memitem:a3b68e603ad8e47bad915f0547e580adb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a3b68e603ad8e47bad915f0547e580adb">cwd</a> ()</td></tr>

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

  258. <tr class="memitem:a29a623f50df057e8b49045ba6611ec2b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback</a> (void(*dateTime)(uint16_t *date, uint16_t *time))</td></tr>

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

  260. <tr class="memitem:a5df02f1d037e6091375488af25244ebc"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5df02f1d037e6091375488af25244ebc">dateTimeCallbackCancel</a> ()</td></tr>

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

  262. <tr class="memitem:a648461081fe07578780f4cd3f246cb66"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a648461081fe07578780f4cd3f246cb66">dirName</a> (const <a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir, char *name)</td></tr>

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

  264. <tr class="memitem:a94df8090f16e9666cdc53ca20f6aff90"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a94df8090f16e9666cdc53ca20f6aff90">legal83Char</a> (uint8_t c)</td></tr>

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

  266. <tr class="memitem:ada5364f66204b1a64afbf9d2e6cd2b0b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ada5364f66204b1a64afbf9d2e6cd2b0b">printFatDate</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatDate)</td></tr>

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

  268. <tr class="memitem:a4e7e56ba52ca17c602af1b85684b09a9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4e7e56ba52ca17c602af1b85684b09a9">printFatTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatTime)</td></tr>

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

  270. <tr class="memitem:afe820bbb056863e91ec482961c8dc695"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe820bbb056863e91ec482961c8dc695">remove</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path)</td></tr>

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

  272. <tr class="memitem:a360ef9c05e677271bed6c0a4d663634c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a360ef9c05e677271bed6c0a4d663634c">setCwd</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir)</td></tr>

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

  274. </table>

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

  276. <div class="textblock"><p>Basic file class. </p>

  277. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  278. <a class="anchor" id="a7b591c9b92165fa8e4eae8c30c30e533"></a>

  279. <div class="memitem">

  280. <div class="memproto">

  281. <table class="mlabels">

  282.   <tr>

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

  284.       <table class="memname">

  285.         <tr>

  286.           <td class="memname">FatFile::FatFile </td>

  287.           <td>(</td>

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

  289.           <td></td>

  290.         </tr>

  291.       </table>

  292.   </td>

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

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

  295.   </tr>

  296. </table>

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

  298. <p>Create an instance. </p>

  299. 

  300. </div>

  301. </div>

  302. <a class="anchor" id="a29d31067d0aa3a9a74b1a660c38775cc"></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">FatFile::FatFile </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">uint8_t&#160;</td>

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

  320.         </tr>

  321.         <tr>

  322.           <td></td>

  323.           <td>)</td>

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

  325.         </tr>

  326.       </table>

  327.   </td>

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

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

  330.   </tr>

  331. </table>

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

  333. <p>Create a file object and open it in the current working directory.</p>

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

  335.   <table class="params">

  336.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  337.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of open flags. see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>. </td></tr>

  338.   </table>

  339.   </dd>

  340. </dl>

  341. 

  342. </div>

  343. </div>

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

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

  346. <div class="memitem">

  347. <div class="memproto">

  348. <table class="mlabels">

  349.   <tr>

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

  351.       <table class="memname">

  352.         <tr>

  353.           <td class="memname">uint32_t FatFile::available </td>

  354.           <td>(</td>

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

  356.           <td></td>

  357.         </tr>

  358.       </table>

  359.   </td>

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

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

  362.   </tr>

  363. </table>

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

  365. <dl class="section return"><dt>Returns</dt><dd>The number of bytes available from the current position to EOF for normal files. Zero is returned for directory files. </dd></dl>

  366. 

  367. </div>

  368. </div>

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

  370. <div class="memitem">

  371. <div class="memproto">

  372. <table class="mlabels">

  373.   <tr>

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

  375.       <table class="memname">

  376.         <tr>

  377.           <td class="memname">void FatFile::clearError </td>

  378.           <td>(</td>

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

  380.           <td></td>

  381.         </tr>

  382.       </table>

  383.   </td>

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

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

  386.   </tr>

  387. </table>

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

  389. <p>Clear all error bits. </p>

  390. 

  391. </div>

  392. </div>

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

  394. <div class="memitem">

  395. <div class="memproto">

  396. <table class="mlabels">

  397.   <tr>

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

  399.       <table class="memname">

  400.         <tr>

  401.           <td class="memname">void FatFile::clearWriteError </td>

  402.           <td>(</td>

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

  404.           <td></td>

  405.         </tr>

  406.       </table>

  407.   </td>

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

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

  410.   </tr>

  411. </table>

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

  413. <p>Set writeError to zero </p>

  414. 

  415. </div>

  416. </div>

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

  418. <div class="memitem">

  419. <div class="memproto">

  420.       <table class="memname">

  421.         <tr>

  422.           <td class="memname">bool FatFile::close </td>

  423.           <td>(</td>

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

  425.           <td></td>

  426.         </tr>

  427.       </table>

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

  429. <p>Close a file and force cached data and directory information to be written to the storage device.</p>

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

  431. 

  432. </div>

  433. </div>

  434. <a class="anchor" id="aa367708bcc8bc0e0c45c0c2a812c65da"></a>

  435. <div class="memitem">

  436. <div class="memproto">

  437.       <table class="memname">

  438.         <tr>

  439.           <td class="memname">bool FatFile::contiguousRange </td>

  440.           <td>(</td>

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

  442.           <td class="paramname"><em>bgnBlock</em>, </td>

  443.         </tr>

  444.         <tr>

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

  446.           <td></td>

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

  448.           <td class="paramname"><em>endBlock</em>&#160;</td>

  449.         </tr>

  450.         <tr>

  451.           <td></td>

  452.           <td>)</td>

  453.           <td></td><td></td>

  454.         </tr>

  455.       </table>

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

  457. <p>Check for contiguous file and return its raw block range.</p>

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

  459.   <table class="params">

  460.     <tr><td class="paramdir">[out]</td><td class="paramname">bgnBlock</td><td>the first block address for the file. </td></tr>

  461.     <tr><td class="paramdir">[out]</td><td class="paramname">endBlock</td><td>the last block address for the file.</td></tr>

  462.   </table>

  463.   </dd>

  464. </dl>

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

  466. 

  467. </div>

  468. </div>

  469. <a class="anchor" id="a0afc2a1cffa238d1cb2049bfa2d8d199"></a>

  470. <div class="memitem">

  471. <div class="memproto">

  472.       <table class="memname">

  473.         <tr>

  474.           <td class="memname">bool FatFile::createContiguous </td>

  475.           <td>(</td>

  476.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  477.           <td class="paramname"><em>dirFile</em>, </td>

  478.         </tr>

  479.         <tr>

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

  481.           <td></td>

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

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

  484.         </tr>

  485.         <tr>

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

  487.           <td></td>

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

  489.           <td class="paramname"><em>size</em>&#160;</td>

  490.         </tr>

  491.         <tr>

  492.           <td></td>

  493.           <td>)</td>

  494.           <td></td><td></td>

  495.         </tr>

  496.       </table>

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

  498. <p>Create and open a new contiguous file of a specified size.</p>

  499. <dl class="section note"><dt>Note</dt><dd>This function only supports short DOS 8.3 names. See <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> for more information.</dd></dl>

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

  501.   <table class="params">

  502.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory where the file will be created. </td></tr>

  503.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid DOS 8.3 file name. </td></tr>

  504.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>

  505.   </table>

  506.   </dd>

  507. </dl>

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

  509. 

  510. </div>

  511. </div>

  512. <a class="anchor" id="a4c03e2f6729526786e6ab4a623e0339b"></a>

  513. <div class="memitem">

  514. <div class="memproto">

  515. <table class="mlabels">

  516.   <tr>

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

  518.       <table class="memname">

  519.         <tr>

  520.           <td class="memname">uint32_t FatFile::curCluster </td>

  521.           <td>(</td>

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

  523.           <td> const</td>

  524.         </tr>

  525.       </table>

  526.   </td>

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

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

  529.   </tr>

  530. </table>

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

  532. <dl class="section return"><dt>Returns</dt><dd>The current cluster number for a file or directory. </dd></dl>

  533. 

  534. </div>

  535. </div>

  536. <a class="anchor" id="a20c55b134bfd1d287a00bf64eba9332e"></a>

  537. <div class="memitem">

  538. <div class="memproto">

  539. <table class="mlabels">

  540.   <tr>

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

  542.       <table class="memname">

  543.         <tr>

  544.           <td class="memname">uint32_t FatFile::curPosition </td>

  545.           <td>(</td>

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

  547.           <td> const</td>

  548.         </tr>

  549.       </table>

  550.   </td>

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

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

  553.   </tr>

  554. </table>

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

  556. <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>

  557. 

  558. </div>

  559. </div>

  560. <a class="anchor" id="a3b68e603ad8e47bad915f0547e580adb"></a>

  561. <div class="memitem">

  562. <div class="memproto">

  563. <table class="mlabels">

  564.   <tr>

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

  566.       <table class="memname">

  567.         <tr>

  568.           <td class="memname">static <a class="el" href="class_fat_file.html">FatFile</a>* FatFile::cwd </td>

  569.           <td>(</td>

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

  571.           <td></td>

  572.         </tr>

  573.       </table>

  574.   </td>

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

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

  577.   </tr>

  578. </table>

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

  580. <dl class="section return"><dt>Returns</dt><dd>Current working directory </dd></dl>

  581. 

  582. </div>

  583. </div>

  584. <a class="anchor" id="a29a623f50df057e8b49045ba6611ec2b"></a>

  585. <div class="memitem">

  586. <div class="memproto">

  587. <table class="mlabels">

  588.   <tr>

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

  590.       <table class="memname">

  591.         <tr>

  592.           <td class="memname">static void FatFile::dateTimeCallback </td>

  593.           <td>(</td>

  594.           <td class="paramtype">void(*)(uint16_t *date, uint16_t *time)&#160;</td>

  595.           <td class="paramname"><em>dateTime</em></td><td>)</td>

  596.           <td></td>

  597.         </tr>

  598.       </table>

  599.   </td>

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

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

  602.   </tr>

  603. </table>

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

  605. <p>Set the date/time callback function</p>

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

  607.   <table class="params">

  608.     <tr><td class="paramdir">[in]</td><td class="paramname">dateTime</td><td>The user's call back function. The callback function is of the form:</td></tr>

  609.   </table>

  610.   </dd>

  611. </dl>

  612. <div class="fragment"><div class="line"><span class="keywordtype">void</span> dateTime(uint16_t* date, uint16_t* time) {</div>

  613. <div class="line">  uint16_t year;</div>

  614. <div class="line">  uint8_t month, day, hour, minute, second;</div>

  615. <div class="line"></div>

  616. <div class="line">  <span class="comment">// User gets date and time from GPS or real-time clock here</span></div>

  617. <div class="line"></div>

  618. <div class="line">  <span class="comment">// return date using FAT_DATE macro to format fields</span></div>

  619. <div class="line">  *date = <a class="code" href="_fat_structs_8h.html#a44899ad42ddf32ff1c1a73b5251b304a">FAT_DATE</a>(year, month, day);</div>

  620. <div class="line"></div>

  621. <div class="line">  <span class="comment">// return time using FAT_TIME macro to format fields</span></div>

  622. <div class="line">  *time = <a class="code" href="_fat_structs_8h.html#a375720927be5a39475d48b2d75dae29a">FAT_TIME</a>(hour, minute, second);</div>

  623. <div class="line">}</div>

  624. </div><!-- fragment --><p>Sets the function that is called when a file is created or when a file's directory entry is modified by <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a>. All timestamps, access, creation, and modify, are set when a file is created. <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> maintains the last access date and last modify date/time.</p>

  625. <p>See the <a class="el" href="class_fat_file.html#aa53a8d1d2467ad9af7d61cbf8ee85243">timestamp()</a> function. </p>

  626. 

  627. </div>

  628. </div>

  629. <a class="anchor" id="a5df02f1d037e6091375488af25244ebc"></a>

  630. <div class="memitem">

  631. <div class="memproto">

  632. <table class="mlabels">

  633.   <tr>

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

  635.       <table class="memname">

  636.         <tr>

  637.           <td class="memname">static void FatFile::dateTimeCallbackCancel </td>

  638.           <td>(</td>

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

  640.           <td></td>

  641.         </tr>

  642.       </table>

  643.   </td>

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

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

  646.   </tr>

  647. </table>

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

  649. <p>Cancel the date/time callback function. </p>

  650. 

  651. </div>

  652. </div>

  653. <a class="anchor" id="a6858d18c807411a071fd6d1b39d50087"></a>

  654. <div class="memitem">

  655. <div class="memproto">

  656.       <table class="memname">

  657.         <tr>

  658.           <td class="memname">bool FatFile::dirEntry </td>

  659.           <td>(</td>

  660.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  661.           <td class="paramname"><em>dir</em></td><td>)</td>

  662.           <td></td>

  663.         </tr>

  664.       </table>

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

  666. <p>Return a file's directory entry.</p>

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

  668.   <table class="params">

  669.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>Location for return of the file's directory entry.</td></tr>

  670.   </table>

  671.   </dd>

  672. </dl>

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

  674. 

  675. </div>

  676. </div>

  677. <a class="anchor" id="ae5ec24d4a94d3780384d3f2b731c7eb9"></a>

  678. <div class="memitem">

  679. <div class="memproto">

  680. <table class="mlabels">

  681.   <tr>

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

  683.       <table class="memname">

  684.         <tr>

  685.           <td class="memname">uint16_t FatFile::dirIndex </td>

  686.           <td>(</td>

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

  688.           <td></td>

  689.         </tr>

  690.       </table>

  691.   </td>

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

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

  694.   </tr>

  695. </table>

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

  697. <dl class="section return"><dt>Returns</dt><dd>The index of this file in it's directory. </dd></dl>

  698. 

  699. </div>

  700. </div>

  701. <a class="anchor" id="a648461081fe07578780f4cd3f246cb66"></a>

  702. <div class="memitem">

  703. <div class="memproto">

  704. <table class="mlabels">

  705.   <tr>

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

  707.       <table class="memname">

  708.         <tr>

  709.           <td class="memname">uint8_t FatFile::dirName </td>

  710.           <td>(</td>

  711.           <td class="paramtype">const <a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  712.           <td class="paramname"><em>dir</em>, </td>

  713.         </tr>

  714.         <tr>

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

  716.           <td></td>

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

  718.           <td class="paramname"><em>name</em>&#160;</td>

  719.         </tr>

  720.         <tr>

  721.           <td></td>

  722.           <td>)</td>

  723.           <td></td><td></td>

  724.         </tr>

  725.       </table>

  726.   </td>

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

  728. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  729.   </tr>

  730. </table>

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

  732. <p>Format the name field of <em>dir</em> into the 13 byte array <em>name</em> in standard 8.3 short name format.</p>

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

  734.   <table class="params">

  735.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>The directory structure containing the name. </td></tr>

  736.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>A 13 byte char array for the formatted name. </td></tr>

  737.   </table>

  738.   </dd>

  739. </dl>

  740. <dl class="section return"><dt>Returns</dt><dd>length of the name. </dd></dl>

  741. 

  742. </div>

  743. </div>

  744. <a class="anchor" id="ae2ed15f05c9ccbce355e7a8d3ce8382d"></a>

  745. <div class="memitem">

  746. <div class="memproto">

  747.       <table class="memname">

  748.         <tr>

  749.           <td class="memname">uint32_t FatFile::dirSize </td>

  750.           <td>(</td>

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

  752.           <td></td>

  753.         </tr>

  754.       </table>

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

  756. <dl class="section return"><dt>Returns</dt><dd>The number of bytes allocated to a directory or zero if an error occurs. </dd></dl>

  757. 

  758. </div>

  759. </div>

  760. <a class="anchor" id="a4f01d27954ae49aeb6888ac7302f55d9"></a>

  761. <div class="memitem">

  762. <div class="memproto">

  763.       <table class="memname">

  764.         <tr>

  765.           <td class="memname">void FatFile::dmpFile </td>

  766.           <td>(</td>

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

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

  769.         </tr>

  770.         <tr>

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

  772.           <td></td>

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

  774.           <td class="paramname"><em>pos</em>, </td>

  775.         </tr>

  776.         <tr>

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

  778.           <td></td>

  779.           <td class="paramtype">size_t&#160;</td>

  780.           <td class="paramname"><em>n</em>&#160;</td>

  781.         </tr>

  782.         <tr>

  783.           <td></td>

  784.           <td>)</td>

  785.           <td></td><td></td>

  786.         </tr>

  787.       </table>

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

  789. <p>Dump file in Hex </p><dl class="params"><dt>Parameters</dt><dd>

  790.   <table class="params">

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

  792.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>Start position in file. </td></tr>

  793.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number of locations to dump. </td></tr>

  794.   </table>

  795.   </dd>

  796. </dl>

  797. 

  798. </div>

  799. </div>

  800. <a class="anchor" id="a50242f98dea0d4488ce4039a279f2a57"></a>

  801. <div class="memitem">

  802. <div class="memproto">

  803. <table class="mlabels">

  804.   <tr>

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

  806.       <table class="memname">

  807.         <tr>

  808.           <td class="memname">bool FatFile::exists </td>

  809.           <td>(</td>

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

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

  812.           <td></td>

  813.         </tr>

  814.       </table>

  815.   </td>

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

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

  818.   </tr>

  819. </table>

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

  821. <p>Test for the existence of a file in a directory</p>

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

  823.   <table class="params">

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

  825.   </table>

  826.   </dd>

  827. </dl>

  828. <p>The calling instance must be an open directory file.</p>

  829. <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>

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

  831. 

  832. </div>

  833. </div>

  834. <a class="anchor" id="a31ef26b3ee37cf5f5f4c6024c0ddab69"></a>

  835. <div class="memitem">

  836. <div class="memproto">

  837.       <table class="memname">

  838.         <tr>

  839.           <td class="memname">int16_t FatFile::fgets </td>

  840.           <td>(</td>

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

  842.           <td class="paramname"><em>str</em>, </td>

  843.         </tr>

  844.         <tr>

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

  846.           <td></td>

  847.           <td class="paramtype">int16_t&#160;</td>

  848.           <td class="paramname"><em>num</em>, </td>

  849.         </tr>

  850.         <tr>

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

  852.           <td></td>

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

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

  855.         </tr>

  856.         <tr>

  857.           <td></td>

  858.           <td>)</td>

  859.           <td></td><td></td>

  860.         </tr>

  861.       </table>

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

  863. <p>Get a string from a file.</p>

  864. <p><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> reads bytes from a file into the array pointed to by <em>str</em>, until <em>num</em> - 1 bytes are read, or a delimiter is read and transferred to <em>str</em>, or end-of-file is encountered. The string is then terminated with a null byte.</p>

  865. <p><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> deletes CR, '\r', from the string. This insures only a '\n' terminates the string for Windows text files which use CRLF for newline.</p>

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

  867.   <table class="params">

  868.     <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>

  869.     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Maximum number of characters to be read (including the final null byte). Usually the length of the array <em>str</em> is used. </td></tr>

  870.     <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>

  871.   </table>

  872.   </dd>

  873. </dl>

  874. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> returns the length of the string in <em>str</em>. If no data is read, <a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>

  875. 

  876. </div>

  877. </div>

  878. <a class="anchor" id="a7e043dfb89d268bfd620bbbadacf1002"></a>

  879. <div class="memitem">

  880. <div class="memproto">

  881. <table class="mlabels">

  882.   <tr>

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

  884.       <table class="memname">

  885.         <tr>

  886.           <td class="memname">uint8_t FatFile::fileAttr </td>

  887.           <td>(</td>

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

  889.           <td> const</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>Type of file. You should use <a class="el" href="class_fat_file.html#afcf6270ea8d4a3a5f8e89523bc684e22">isFile()</a> or <a class="el" href="class_fat_file.html#aef41d65e0f1ce753d18cc9ed691f7de4">isDir()</a> instead of fileType() if possible.</p>

  899. <dl class="section return"><dt>Returns</dt><dd>The file or directory type. </dd></dl>

  900. 

  901. </div>

  902. </div>

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

  904. <div class="memitem">

  905. <div class="memproto">

  906. <table class="mlabels">

  907.   <tr>

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

  909.       <table class="memname">

  910.         <tr>

  911.           <td class="memname">uint32_t FatFile::fileSize </td>

  912.           <td>(</td>

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

  914.           <td> const</td>

  915.         </tr>

  916.       </table>

  917.   </td>

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

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

  920.   </tr>

  921. </table>

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

  923. <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>

  924. 

  925. </div>

  926. </div>

  927. <a class="anchor" id="a1057bc23b92a074539f661e896e79a09"></a>

  928. <div class="memitem">

  929. <div class="memproto">

  930. <table class="mlabels">

  931.   <tr>

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

  933.       <table class="memname">

  934.         <tr>

  935.           <td class="memname">uint32_t FatFile::firstCluster </td>

  936.           <td>(</td>

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

  938.           <td> const</td>

  939.         </tr>

  940.       </table>

  941.   </td>

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

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

  944.   </tr>

  945. </table>

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

  947. <dl class="section return"><dt>Returns</dt><dd>The first cluster number for a file or directory. </dd></dl>

  948. 

  949. </div>

  950. </div>

  951. <a class="anchor" id="ad0dbbd083180f44c7a3ce7124d4ce19c"></a>

  952. <div class="memitem">

  953. <div class="memproto">

  954. <table class="mlabels">

  955.   <tr>

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

  957.       <table class="memname">

  958.         <tr>

  959.           <td class="memname">uint8_t FatFile::getError </td>

  960.           <td>(</td>

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

  962.           <td></td>

  963.         </tr>

  964.       </table>

  965.   </td>

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

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

  968.   </tr>

  969. </table>

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

  971. <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>

  972. 

  973. </div>

  974. </div>

  975. <a class="anchor" id="a58a8aa8e48c2d4a5ee9585184efcfbfd"></a>

  976. <div class="memitem">

  977. <div class="memproto">

  978.       <table class="memname">

  979.         <tr>

  980.           <td class="memname">bool FatFile::getFilename </td>

  981.           <td>(</td>

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

  983.           <td class="paramname"><em>name</em>, </td>

  984.         </tr>

  985.         <tr>

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

  987.           <td></td>

  988.           <td class="paramtype">size_t&#160;</td>

  989.           <td class="paramname"><em>size</em>&#160;</td>

  990.         </tr>

  991.         <tr>

  992.           <td></td>

  993.           <td>)</td>

  994.           <td></td><td></td>

  995.         </tr>

  996.       </table>

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

  998. <p>Get a file's name followed by a zero byte.</p>

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

  1000.   <table class="params">

  1001.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>

  1002.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in bytes. The array must be at least 13 bytes long. The file name will be truncated if it is too long. </td></tr>

  1003.   </table>

  1004.   </dd>

  1005. </dl>

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

  1007. 

  1008. </div>

  1009. </div>

  1010. <a class="anchor" id="aaa4f9886887947815a61eaf015996932"></a>

  1011. <div class="memitem">

  1012. <div class="memproto">

  1013.       <table class="memname">

  1014.         <tr>

  1015.           <td class="memname">void FatFile::getpos </td>

  1016.           <td>(</td>

  1017.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  1018.           <td class="paramname"><em>pos</em></td><td>)</td>

  1019.           <td></td>

  1020.         </tr>

  1021.       </table>

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

  1023. <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  1024.   <table class="params">

  1025.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>

  1026.   </table>

  1027.   </dd>

  1028. </dl>

  1029. 

  1030. </div>

  1031. </div>

  1032. <a class="anchor" id="aba30e92a66f8e0d2f815c85662772a58"></a>

  1033. <div class="memitem">

  1034. <div class="memproto">

  1035.       <table class="memname">

  1036.         <tr>

  1037.           <td class="memname">bool FatFile::getSFN </td>

  1038.           <td>(</td>

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

  1040.           <td class="paramname"><em>name</em></td><td>)</td>

  1041.           <td></td>

  1042.         </tr>

  1043.       </table>

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

  1045. <p>Get a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name followed by a zero byte.</p>

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

  1047.   <table class="params">

  1048.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. The array must be at least 13 bytes long. </td></tr>

  1049.   </table>

  1050.   </dd>

  1051. </dl>

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

  1053. 

  1054. </div>

  1055. </div>

  1056. <a class="anchor" id="a8062c0d3a118e8d77d0310418703d5f5"></a>

  1057. <div class="memitem">

  1058. <div class="memproto">

  1059. <table class="mlabels">

  1060.   <tr>

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

  1062.       <table class="memname">

  1063.         <tr>

  1064.           <td class="memname">bool FatFile::getWriteError </td>

  1065.           <td>(</td>

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

  1067.           <td></td>

  1068.         </tr>

  1069.       </table>

  1070.   </td>

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

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

  1073.   </tr>

  1074. </table>

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

  1076. <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>

  1077. 

  1078. </div>

  1079. </div>

  1080. <a class="anchor" id="aef41d65e0f1ce753d18cc9ed691f7de4"></a>

  1081. <div class="memitem">

  1082. <div class="memproto">

  1083. <table class="mlabels">

  1084.   <tr>

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

  1086.       <table class="memname">

  1087.         <tr>

  1088.           <td class="memname">bool FatFile::isDir </td>

  1089.           <td>(</td>

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

  1091.           <td> const</td>

  1092.         </tr>

  1093.       </table>

  1094.   </td>

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

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

  1097.   </tr>

  1098. </table>

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

  1100. <dl class="section return"><dt>Returns</dt><dd>True if this is a directory else false. </dd></dl>

  1101. 

  1102. </div>

  1103. </div>

  1104. <a class="anchor" id="afcf6270ea8d4a3a5f8e89523bc684e22"></a>

  1105. <div class="memitem">

  1106. <div class="memproto">

  1107. <table class="mlabels">

  1108.   <tr>

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

  1110.       <table class="memname">

  1111.         <tr>

  1112.           <td class="memname">bool FatFile::isFile </td>

  1113.           <td>(</td>

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

  1115.           <td> const</td>

  1116.         </tr>

  1117.       </table>

  1118.   </td>

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

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

  1121.   </tr>

  1122. </table>

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

  1124. <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file else false. </dd></dl>

  1125. 

  1126. </div>

  1127. </div>

  1128. <a class="anchor" id="a7eefe7408f34b6326f0c6e78af7eb05f"></a>

  1129. <div class="memitem">

  1130. <div class="memproto">

  1131. <table class="mlabels">

  1132.   <tr>

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

  1134.       <table class="memname">

  1135.         <tr>

  1136.           <td class="memname">bool FatFile::isHidden </td>

  1137.           <td>(</td>

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

  1139.           <td> const</td>

  1140.         </tr>

  1141.       </table>

  1142.   </td>

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

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

  1145.   </tr>

  1146. </table>

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

  1148. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden file else false. </dd></dl>

  1149. 

  1150. </div>

  1151. </div>

  1152. <a class="anchor" id="aed36d17f8fde597b6ed9446faec1f7e3"></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">bool FatFile::isLFN </td>

  1161.           <td>(</td>

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

  1163.           <td> const</td>

  1164.         </tr>

  1165.       </table>

  1166.   </td>

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

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

  1169.   </tr>

  1170. </table>

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

  1172. <dl class="section return"><dt>Returns</dt><dd>true if this file has a Long <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name. </dd></dl>

  1173. 

  1174. </div>

  1175. </div>

  1176. <a class="anchor" id="a4c8a07b081f04aa25839c6f56c739bdc"></a>

  1177. <div class="memitem">

  1178. <div class="memproto">

  1179. <table class="mlabels">

  1180.   <tr>

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

  1182.       <table class="memname">

  1183.         <tr>

  1184.           <td class="memname">bool FatFile::isOpen </td>

  1185.           <td>(</td>

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

  1187.           <td> const</td>

  1188.         </tr>

  1189.       </table>

  1190.   </td>

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

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

  1193.   </tr>

  1194. </table>

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

  1196. <dl class="section return"><dt>Returns</dt><dd>True if this is an open file/directory else false. </dd></dl>

  1197. 

  1198. </div>

  1199. </div>

  1200. <a class="anchor" id="a6872d3acb1e70f81c9c2be2495977583"></a>

  1201. <div class="memitem">

  1202. <div class="memproto">

  1203. <table class="mlabels">

  1204.   <tr>

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

  1206.       <table class="memname">

  1207.         <tr>

  1208.           <td class="memname">bool FatFile::isReadOnly </td>

  1209.           <td>(</td>

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

  1211.           <td> const</td>

  1212.         </tr>

  1213.       </table>

  1214.   </td>

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

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

  1217.   </tr>

  1218. </table>

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

  1220. <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>

  1221. 

  1222. </div>

  1223. </div>

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

  1225. <div class="memitem">

  1226. <div class="memproto">

  1227. <table class="mlabels">

  1228.   <tr>

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

  1230.       <table class="memname">

  1231.         <tr>

  1232.           <td class="memname">bool FatFile::isRoot </td>

  1233.           <td>(</td>

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

  1235.           <td> const</td>

  1236.         </tr>

  1237.       </table>

  1238.   </td>

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

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

  1241.   </tr>

  1242. </table>

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

  1244. <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>

  1245. 

  1246. </div>

  1247. </div>

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

  1249. <div class="memitem">

  1250. <div class="memproto">

  1251. <table class="mlabels">

  1252.   <tr>

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

  1254.       <table class="memname">

  1255.         <tr>

  1256.           <td class="memname">bool FatFile::isRoot32 </td>

  1257.           <td>(</td>

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

  1259.           <td> const</td>

  1260.         </tr>

  1261.       </table>

  1262.   </td>

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

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

  1265.   </tr>

  1266. </table>

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

  1268. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT32 root directory. </dd></dl>

  1269. 

  1270. </div>

  1271. </div>

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

  1273. <div class="memitem">

  1274. <div class="memproto">

  1275. <table class="mlabels">

  1276.   <tr>

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

  1278.       <table class="memname">

  1279.         <tr>

  1280.           <td class="memname">bool FatFile::isRootFixed </td>

  1281.           <td>(</td>

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

  1283.           <td> const</td>

  1284.         </tr>

  1285.       </table>

  1286.   </td>

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

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

  1289.   </tr>

  1290. </table>

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

  1292. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT12 of FAT16 root directory. </dd></dl>

  1293. 

  1294. </div>

  1295. </div>

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

  1297. <div class="memitem">

  1298. <div class="memproto">

  1299. <table class="mlabels">

  1300.   <tr>

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

  1302.       <table class="memname">

  1303.         <tr>

  1304.           <td class="memname">bool FatFile::isSubDir </td>

  1305.           <td>(</td>

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

  1307.           <td> const</td>

  1308.         </tr>

  1309.       </table>

  1310.   </td>

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

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

  1313.   </tr>

  1314. </table>

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

  1316. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory else false. </dd></dl>

  1317. 

  1318. </div>

  1319. </div>

  1320. <a class="anchor" id="add932e13e5bf32ad467af6ec34824e3c"></a>

  1321. <div class="memitem">

  1322. <div class="memproto">

  1323. <table class="mlabels">

  1324.   <tr>

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

  1326.       <table class="memname">

  1327.         <tr>

  1328.           <td class="memname">bool FatFile::isSystem </td>

  1329.           <td>(</td>

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

  1331.           <td> const</td>

  1332.         </tr>

  1333.       </table>

  1334.   </td>

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

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

  1337.   </tr>

  1338. </table>

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

  1340. <dl class="section return"><dt>Returns</dt><dd>True if this is a system file else false. </dd></dl>

  1341. 

  1342. </div>

  1343. </div>

  1344. <a class="anchor" id="a94df8090f16e9666cdc53ca20f6aff90"></a>

  1345. <div class="memitem">

  1346. <div class="memproto">

  1347. <table class="mlabels">

  1348.   <tr>

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

  1350.       <table class="memname">

  1351.         <tr>

  1352.           <td class="memname">static bool FatFile::legal83Char </td>

  1353.           <td>(</td>

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

  1355.           <td class="paramname"><em>c</em></td><td>)</td>

  1356.           <td></td>

  1357.         </tr>

  1358.       </table>

  1359.   </td>

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

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

  1362.   </tr>

  1363. </table>

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

  1365. <p>Check for a legal 8.3 character. </p><dl class="params"><dt>Parameters</dt><dd>

  1366.   <table class="params">

  1367.     <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Character to be checked. </td></tr>

  1368.   </table>

  1369.   </dd>

  1370. </dl>

  1371. <dl class="section return"><dt>Returns</dt><dd>true for a legal 8.3 character else false. </dd></dl>

  1372. 

  1373. </div>

  1374. </div>

  1375. <a class="anchor" id="acabf31ff85e696fbf384c49428012fea"></a>

  1376. <div class="memitem">

  1377. <div class="memproto">

  1378.       <table class="memname">

  1379.         <tr>

  1380.           <td class="memname">void FatFile::ls </td>

  1381.           <td>(</td>

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

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

  1384.         </tr>

  1385.         <tr>

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

  1387.           <td></td>

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

  1389.           <td class="paramname"><em>flags</em> = <code>0</code>, </td>

  1390.         </tr>

  1391.         <tr>

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

  1393.           <td></td>

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

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

  1396.         </tr>

  1397.         <tr>

  1398.           <td></td>

  1399.           <td>)</td>

  1400.           <td></td><td></td>

  1401.         </tr>

  1402.       </table>

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

  1404. <p>List directory contents.</p>

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

  1406.   <table class="params">

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

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

  1409.   </table>

  1410.   </dd>

  1411. </dl>

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

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

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

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

  1416.   <table class="params">

  1417.     <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>Amount of space before file name. Used for recursive list to indicate subdirectory level. </td></tr>

  1418.   </table>

  1419.   </dd>

  1420. </dl>

  1421. 

  1422. </div>

  1423. </div>

  1424. <a class="anchor" id="abab5b9f72cc796388dd4eed01d13d90d"></a>

  1425. <div class="memitem">

  1426. <div class="memproto">

  1427.       <table class="memname">

  1428.         <tr>

  1429.           <td class="memname">bool FatFile::mkdir </td>

  1430.           <td>(</td>

  1431.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1432.           <td class="paramname"><em>dir</em>, </td>

  1433.         </tr>

  1434.         <tr>

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

  1436.           <td></td>

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

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

  1439.         </tr>

  1440.         <tr>

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

  1442.           <td></td>

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

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

  1445.         </tr>

  1446.         <tr>

  1447.           <td></td>

  1448.           <td>)</td>

  1449.           <td></td><td></td>

  1450.         </tr>

  1451.       </table>

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

  1453. <p>Make a new directory.</p>

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

  1455.   <table class="params">

  1456.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory that will contain the new directory.</td></tr>

  1457.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the new directory.</td></tr>

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

  1459.   </table>

  1460.   </dd>

  1461. </dl>

  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. 

  1464. </div>

  1465. </div>

  1466. <a class="anchor" id="a5f64576d3d19177ab3cf3812b69abdfa"></a>

  1467. <div class="memitem">

  1468. <div class="memproto">

  1469.       <table class="memname">

  1470.         <tr>

  1471.           <td class="memname">bool FatFile::open </td>

  1472.           <td>(</td>

  1473.           <td class="paramtype"><a class="el" href="class_fat_file_system.html">FatFileSystem</a> *&#160;</td>

  1474.           <td class="paramname"><em>fs</em>, </td>

  1475.         </tr>

  1476.         <tr>

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

  1478.           <td></td>

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

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

  1481.         </tr>

  1482.         <tr>

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

  1484.           <td></td>

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

  1486.           <td class="paramname"><em>oflag</em>&#160;</td>

  1487.         </tr>

  1488.         <tr>

  1489.           <td></td>

  1490.           <td>)</td>

  1491.           <td></td><td></td>

  1492.         </tr>

  1493.       </table>

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

  1495. <p>Open a file in the volume working directory of a <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a>.</p>

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

  1497.   <table class="params">

  1498.     <tr><td class="paramdir">[in]</td><td class="paramname">fs</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> System where the file is located.</td></tr>

  1499.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1500.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</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. 

  1506. </div>

  1507. </div>

  1508. <a class="anchor" id="ad3fa9daaccb4e4179fb88a8ca037aa80"></a>

  1509. <div class="memitem">

  1510. <div class="memproto">

  1511.       <table class="memname">

  1512.         <tr>

  1513.           <td class="memname">bool FatFile::open </td>

  1514.           <td>(</td>

  1515.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1516.           <td class="paramname"><em>dirFile</em>, </td>

  1517.         </tr>

  1518.         <tr>

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

  1520.           <td></td>

  1521.           <td class="paramtype">uint16_t&#160;</td>

  1522.           <td class="paramname"><em>index</em>, </td>

  1523.         </tr>

  1524.         <tr>

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

  1526.           <td></td>

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

  1528.           <td class="paramname"><em>oflag</em>&#160;</td>

  1529.         </tr>

  1530.         <tr>

  1531.           <td></td>

  1532.           <td>)</td>

  1533.           <td></td><td></td>

  1534.         </tr>

  1535.       </table>

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

  1537. <p>Open a file by index.</p>

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

  1539.   <table class="params">

  1540.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory.</td></tr>

  1541.     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The <em>index</em> of the directory entry for the file to be opened. The value for <em>index</em> is (directory file position)/32.</td></tr>

  1542.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1543.   </table>

  1544.   </dd>

  1545. </dl>

  1546. <p>See <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> by path for definition of flags. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1547. 

  1548. </div>

  1549. </div>

  1550. <a class="anchor" id="a211be757679b18708f6b6a36464e4f61"></a>

  1551. <div class="memitem">

  1552. <div class="memproto">

  1553.       <table class="memname">

  1554.         <tr>

  1555.           <td class="memname">bool FatFile::open </td>

  1556.           <td>(</td>

  1557.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1558.           <td class="paramname"><em>dirFile</em>, </td>

  1559.         </tr>

  1560.         <tr>

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

  1562.           <td></td>

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

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

  1565.         </tr>

  1566.         <tr>

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

  1568.           <td></td>

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

  1570.           <td class="paramname"><em>oflag</em>&#160;</td>

  1571.         </tr>

  1572.         <tr>

  1573.           <td></td>

  1574.           <td>)</td>

  1575.           <td></td><td></td>

  1576.         </tr>

  1577.       </table>

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

  1579. <p>Open a file or directory by name.</p>

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

  1581.   <table class="params">

  1582.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

  1583.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1584.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of flags from the following list</td></tr>

  1585.   </table>

  1586.   </dd>

  1587. </dl>

  1588. <p>O_READ - Open for reading.</p>

  1589. <p>O_RDONLY - Same as O_READ.</p>

  1590. <p>O_WRITE - Open for writing.</p>

  1591. <p>O_WRONLY - Same as O_WRITE.</p>

  1592. <p>O_RDWR - Open for reading and writing.</p>

  1593. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1594. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1595. <p>O_CREAT - If the file exists, this flag has no effect except as noted under O_EXCL below. Otherwise, the file shall be created</p>

  1596. <p>O_EXCL - If O_CREAT and O_EXCL are set, <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> shall fail if the file exists.</p>

  1597. <p>O_SYNC - Call <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> after each write. This flag should not be used with <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write(uint8_t)</a> or any functions do character at a time writes since <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> will be called after each byte.</p>

  1598. <p>O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.</p>

  1599. <p>WARNING: A given file must not be opened by more than one <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> object or file corruption may occur.</p>

  1600. <dl class="section note"><dt>Note</dt><dd>Directory files must be opened read only. Write and truncation is not allowed for directory files.</dd></dl>

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

  1602. 

  1603. </div>

  1604. </div>

  1605. <a class="anchor" id="ab0e7075062c89f356441f80fc64d03e6"></a>

  1606. <div class="memitem">

  1607. <div class="memproto">

  1608. <table class="mlabels">

  1609.   <tr>

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

  1611.       <table class="memname">

  1612.         <tr>

  1613.           <td class="memname">bool FatFile::open </td>

  1614.           <td>(</td>

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

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

  1617.         </tr>

  1618.         <tr>

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

  1620.           <td></td>

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

  1622.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1623.         </tr>

  1624.         <tr>

  1625.           <td></td>

  1626.           <td>)</td>

  1627.           <td></td><td></td>

  1628.         </tr>

  1629.       </table>

  1630.   </td>

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

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

  1633.   </tr>

  1634. </table>

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

  1636. <p>Open a file in the current working directory.</p>

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

  1638.   <table class="params">

  1639.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1640.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1641.   </table>

  1642.   </dd>

  1643. </dl>

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

  1645. 

  1646. </div>

  1647. </div>

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

  1649. <div class="memitem">

  1650. <div class="memproto">

  1651.       <table class="memname">

  1652.         <tr>

  1653.           <td class="memname">bool FatFile::openNext </td>

  1654.           <td>(</td>

  1655.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1656.           <td class="paramname"><em>dirFile</em>, </td>

  1657.         </tr>

  1658.         <tr>

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

  1660.           <td></td>

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

  1662.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1663.         </tr>

  1664.         <tr>

  1665.           <td></td>

  1666.           <td>)</td>

  1667.           <td></td><td></td>

  1668.         </tr>

  1669.       </table>

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

  1671. <p>Open the next file or subdirectory in a directory.</p>

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

  1673.   <table class="params">

  1674.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

  1675.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1676.   </table>

  1677.   </dd>

  1678. </dl>

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

  1680. 

  1681. </div>

  1682. </div>

  1683. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1684. <div class="memitem">

  1685. <div class="memproto">

  1686.       <table class="memname">

  1687.         <tr>

  1688.           <td class="memname">bool FatFile::openRoot </td>

  1689.           <td>(</td>

  1690.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1691.           <td class="paramname"><em>vol</em></td><td>)</td>

  1692.           <td></td>

  1693.         </tr>

  1694.       </table>

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

  1696. <p>Open a volume's root directory.</p>

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

  1698.   <table class="params">

  1699.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1700.   </table>

  1701.   </dd>

  1702. </dl>

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

  1704. 

  1705. </div>

  1706. </div>

  1707. <a class="anchor" id="ac05b7136b887539426856c623869aa3a"></a>

  1708. <div class="memitem">

  1709. <div class="memproto">

  1710.       <table class="memname">

  1711.         <tr>

  1712.           <td class="memname">int FatFile::peek </td>

  1713.           <td>(</td>

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

  1715.           <td></td>

  1716.         </tr>

  1717.       </table>

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

  1719. <p>Return the next available byte without consuming it.</p>

  1720. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1721. 

  1722. </div>

  1723. </div>

  1724. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1725. <div class="memitem">

  1726. <div class="memproto">

  1727.       <table class="memname">

  1728.         <tr>

  1729.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1730.           <td>(</td>

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

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

  1733.           <td></td>

  1734.         </tr>

  1735.       </table>

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

  1737. <p>Print a file's creation date and time</p>

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

  1739.   <table class="params">

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

  1741.   </table>

  1742.   </dd>

  1743. </dl>

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

  1745. 

  1746. </div>

  1747. </div>

  1748. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1749. <div class="memitem">

  1750. <div class="memproto">

  1751. <table class="mlabels">

  1752.   <tr>

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

  1754.       <table class="memname">

  1755.         <tr>

  1756.           <td class="memname">void FatFile::printFatDate </td>

  1757.           <td>(</td>

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

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

  1760.         </tr>

  1761.         <tr>

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

  1763.           <td></td>

  1764.           <td class="paramtype">uint16_t&#160;</td>

  1765.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1766.         </tr>

  1767.         <tr>

  1768.           <td></td>

  1769.           <td>)</td>

  1770.           <td></td><td></td>

  1771.         </tr>

  1772.       </table>

  1773.   </td>

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

  1775. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  1776.   </tr>

  1777. </table>

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

  1779. <p>Print a directory date field.</p>

  1780. <p>Format is yyyy-mm-dd.</p>

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

  1782.   <table class="params">

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

  1784.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1785.   </table>

  1786.   </dd>

  1787. </dl>

  1788. 

  1789. </div>

  1790. </div>

  1791. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  1792. <div class="memitem">

  1793. <div class="memproto">

  1794. <table class="mlabels">

  1795.   <tr>

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

  1797.       <table class="memname">

  1798.         <tr>

  1799.           <td class="memname">void FatFile::printFatTime </td>

  1800.           <td>(</td>

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

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

  1803.         </tr>

  1804.         <tr>

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

  1806.           <td></td>

  1807.           <td class="paramtype">uint16_t&#160;</td>

  1808.           <td class="paramname"><em>fatTime</em>&#160;</td>

  1809.         </tr>

  1810.         <tr>

  1811.           <td></td>

  1812.           <td>)</td>

  1813.           <td></td><td></td>

  1814.         </tr>

  1815.       </table>

  1816.   </td>

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

  1818. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  1819.   </tr>

  1820. </table>

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

  1822. <p>Print a directory time field.</p>

  1823. <p>Format is hh:mm:ss.</p>

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

  1825.   <table class="params">

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

  1827.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  1828.   </table>

  1829.   </dd>

  1830. </dl>

  1831. 

  1832. </div>

  1833. </div>

  1834. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  1835. <div class="memitem">

  1836. <div class="memproto">

  1837.       <table class="memname">

  1838.         <tr>

  1839.           <td class="memname">int FatFile::printField </td>

  1840.           <td>(</td>

  1841.           <td class="paramtype">float&#160;</td>

  1842.           <td class="paramname"><em>value</em>, </td>

  1843.         </tr>

  1844.         <tr>

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

  1846.           <td></td>

  1847.           <td class="paramtype">char&#160;</td>

  1848.           <td class="paramname"><em>term</em>, </td>

  1849.         </tr>

  1850.         <tr>

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

  1852.           <td></td>

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

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

  1855.         </tr>

  1856.         <tr>

  1857.           <td></td>

  1858.           <td>)</td>

  1859.           <td></td><td></td>

  1860.         </tr>

  1861.       </table>

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

  1863. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1864.   <table class="params">

  1865.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1866.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1867.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  1868.   </table>

  1869.   </dd>

  1870. </dl>

  1871. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1872. 

  1873. </div>

  1874. </div>

  1875. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  1876. <div class="memitem">

  1877. <div class="memproto">

  1878.       <table class="memname">

  1879.         <tr>

  1880.           <td class="memname">int FatFile::printField </td>

  1881.           <td>(</td>

  1882.           <td class="paramtype">int16_t&#160;</td>

  1883.           <td class="paramname"><em>value</em>, </td>

  1884.         </tr>

  1885.         <tr>

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

  1887.           <td></td>

  1888.           <td class="paramtype">char&#160;</td>

  1889.           <td class="paramname"><em>term</em>&#160;</td>

  1890.         </tr>

  1891.         <tr>

  1892.           <td></td>

  1893.           <td>)</td>

  1894.           <td></td><td></td>

  1895.         </tr>

  1896.       </table>

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

  1898. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1899.   <table class="params">

  1900.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1901.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1902.   </table>

  1903.   </dd>

  1904. </dl>

  1905. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1906. 

  1907. </div>

  1908. </div>

  1909. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  1910. <div class="memitem">

  1911. <div class="memproto">

  1912.       <table class="memname">

  1913.         <tr>

  1914.           <td class="memname">int FatFile::printField </td>

  1915.           <td>(</td>

  1916.           <td class="paramtype">uint16_t&#160;</td>

  1917.           <td class="paramname"><em>value</em>, </td>

  1918.         </tr>

  1919.         <tr>

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

  1921.           <td></td>

  1922.           <td class="paramtype">char&#160;</td>

  1923.           <td class="paramname"><em>term</em>&#160;</td>

  1924.         </tr>

  1925.         <tr>

  1926.           <td></td>

  1927.           <td>)</td>

  1928.           <td></td><td></td>

  1929.         </tr>

  1930.       </table>

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

  1932. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1933.   <table class="params">

  1934.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1935.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1936.   </table>

  1937.   </dd>

  1938. </dl>

  1939. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1940. 

  1941. </div>

  1942. </div>

  1943. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  1944. <div class="memitem">

  1945. <div class="memproto">

  1946.       <table class="memname">

  1947.         <tr>

  1948.           <td class="memname">int FatFile::printField </td>

  1949.           <td>(</td>

  1950.           <td class="paramtype">int32_t&#160;</td>

  1951.           <td class="paramname"><em>value</em>, </td>

  1952.         </tr>

  1953.         <tr>

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

  1955.           <td></td>

  1956.           <td class="paramtype">char&#160;</td>

  1957.           <td class="paramname"><em>term</em>&#160;</td>

  1958.         </tr>

  1959.         <tr>

  1960.           <td></td>

  1961.           <td>)</td>

  1962.           <td></td><td></td>

  1963.         </tr>

  1964.       </table>

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

  1966. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1967.   <table class="params">

  1968.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1969.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1970.   </table>

  1971.   </dd>

  1972. </dl>

  1973. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1974. 

  1975. </div>

  1976. </div>

  1977. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  1978. <div class="memitem">

  1979. <div class="memproto">

  1980.       <table class="memname">

  1981.         <tr>

  1982.           <td class="memname">int FatFile::printField </td>

  1983.           <td>(</td>

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

  1985.           <td class="paramname"><em>value</em>, </td>

  1986.         </tr>

  1987.         <tr>

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

  1989.           <td></td>

  1990.           <td class="paramtype">char&#160;</td>

  1991.           <td class="paramname"><em>term</em>&#160;</td>

  1992.         </tr>

  1993.         <tr>

  1994.           <td></td>

  1995.           <td>)</td>

  1996.           <td></td><td></td>

  1997.         </tr>

  1998.       </table>

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

  2000. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2001.   <table class="params">

  2002.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2003.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2004.   </table>

  2005.   </dd>

  2006. </dl>

  2007. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2008. 

  2009. </div>

  2010. </div>

  2011. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2012. <div class="memitem">

  2013. <div class="memproto">

  2014.       <table class="memname">

  2015.         <tr>

  2016.           <td class="memname">size_t FatFile::printFileSize </td>

  2017.           <td>(</td>

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

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

  2020.           <td></td>

  2021.         </tr>

  2022.       </table>

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

  2024. <p>Print a file's size.</p>

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

  2026.   <table class="params">

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

  2028.   </table>

  2029.   </dd>

  2030. </dl>

  2031. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>

  2032. 

  2033. </div>

  2034. </div>

  2035. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2036. <div class="memitem">

  2037. <div class="memproto">

  2038.       <table class="memname">

  2039.         <tr>

  2040.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2041.           <td>(</td>

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

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

  2044.           <td></td>

  2045.         </tr>

  2046.       </table>

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

  2048. <p>Print a file's modify date and time</p>

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

  2050.   <table class="params">

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

  2052.   </table>

  2053.   </dd>

  2054. </dl>

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

  2056. 

  2057. </div>

  2058. </div>

  2059. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2060. <div class="memitem">

  2061. <div class="memproto">

  2062.       <table class="memname">

  2063.         <tr>

  2064.           <td class="memname">size_t FatFile::printName </td>

  2065.           <td>(</td>

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

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

  2068.           <td></td>

  2069.         </tr>

  2070.       </table>

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

  2072. <p>Print a file's name</p>

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

  2074.   <table class="params">

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

  2076.   </table>

  2077.   </dd>

  2078. </dl>

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

  2080. 

  2081. </div>

  2082. </div>

  2083. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2084. <div class="memitem">

  2085. <div class="memproto">

  2086.       <table class="memname">

  2087.         <tr>

  2088.           <td class="memname">size_t FatFile::printSFN </td>

  2089.           <td>(</td>

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

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

  2092.           <td></td>

  2093.         </tr>

  2094.       </table>

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

  2096. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

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

  2098.   <table class="params">

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

  2100.   </table>

  2101.   </dd>

  2102. </dl>

  2103. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>

  2104. 

  2105. </div>

  2106. </div>

  2107. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2108. <div class="memitem">

  2109. <div class="memproto">

  2110. <table class="mlabels">

  2111.   <tr>

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

  2113.       <table class="memname">

  2114.         <tr>

  2115.           <td class="memname">int FatFile::read </td>

  2116.           <td>(</td>

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

  2118.           <td></td>

  2119.         </tr>

  2120.       </table>

  2121.   </td>

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

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

  2124.   </tr>

  2125. </table>

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

  2127. <p>Read the next byte from a file.</p>

  2128. <dl class="section return"><dt>Returns</dt><dd>For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned. </dd></dl>

  2129. 

  2130. </div>

  2131. </div>

  2132. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2133. <div class="memitem">

  2134. <div class="memproto">

  2135.       <table class="memname">

  2136.         <tr>

  2137.           <td class="memname">int FatFile::read </td>

  2138.           <td>(</td>

  2139.           <td class="paramtype">void *&#160;</td>

  2140.           <td class="paramname"><em>buf</em>, </td>

  2141.         </tr>

  2142.         <tr>

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

  2144.           <td></td>

  2145.           <td class="paramtype">size_t&#160;</td>

  2146.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2147.         </tr>

  2148.         <tr>

  2149.           <td></td>

  2150.           <td>)</td>

  2151.           <td></td><td></td>

  2152.         </tr>

  2153.       </table>

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

  2155. <p>Read data from a file starting at the current position.</p>

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

  2157.   <table class="params">

  2158.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2159.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2160.   </table>

  2161.   </dd>

  2162. </dl>

  2163. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns the number of bytes read. A value less than <em>nbyte</em>, including zero, will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> called before a file has been opened, corrupt file system or an I/O error occurred. </dd></dl>

  2164. 

  2165. </div>

  2166. </div>

  2167. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2168. <div class="memitem">

  2169. <div class="memproto">

  2170.       <table class="memname">

  2171.         <tr>

  2172.           <td class="memname">int8_t FatFile::readDir </td>

  2173.           <td>(</td>

  2174.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2175.           <td class="paramname"><em>dir</em></td><td>)</td>

  2176.           <td></td>

  2177.         </tr>

  2178.       </table>

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

  2180. <p>Read the next directory entry from a directory file.</p>

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

  2182.   <table class="params">

  2183.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2184.   </table>

  2185.   </dd>

  2186. </dl>

  2187. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2188. 

  2189. </div>

  2190. </div>

  2191. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2192. <div class="memitem">

  2193. <div class="memproto">

  2194.       <table class="memname">

  2195.         <tr>

  2196.           <td class="memname">bool FatFile::remove </td>

  2197.           <td>(</td>

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

  2199.           <td></td>

  2200.         </tr>

  2201.       </table>

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

  2203. <p>Remove a file.</p>

  2204. <p>The directory entry and all data for the file are deleted.</p>

  2205. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".</dd></dl>

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

  2207. 

  2208. </div>

  2209. </div>

  2210. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2211. <div class="memitem">

  2212. <div class="memproto">

  2213. <table class="mlabels">

  2214.   <tr>

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

  2216.       <table class="memname">

  2217.         <tr>

  2218.           <td class="memname">bool FatFile::remove </td>

  2219.           <td>(</td>

  2220.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2221.           <td class="paramname"><em>dirFile</em>, </td>

  2222.         </tr>

  2223.         <tr>

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

  2225.           <td></td>

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

  2227.           <td class="paramname"><em>path</em>&#160;</td>

  2228.         </tr>

  2229.         <tr>

  2230.           <td></td>

  2231.           <td>)</td>

  2232.           <td></td><td></td>

  2233.         </tr>

  2234.       </table>

  2235.   </td>

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

  2237. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2238.   </tr>

  2239. </table>

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

  2241. <p>Remove a file.</p>

  2242. <p>The directory entry and all data for the file are deleted.</p>

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

  2244.   <table class="params">

  2245.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

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

  2247.   </table>

  2248.   </dd>

  2249. </dl>

  2250. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".</dd></dl>

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

  2252. 

  2253. </div>

  2254. </div>

  2255. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2256. <div class="memitem">

  2257. <div class="memproto">

  2258.       <table class="memname">

  2259.         <tr>

  2260.           <td class="memname">bool FatFile::rename </td>

  2261.           <td>(</td>

  2262.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2263.           <td class="paramname"><em>dirFile</em>, </td>

  2264.         </tr>

  2265.         <tr>

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

  2267.           <td></td>

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

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

  2270.         </tr>

  2271.         <tr>

  2272.           <td></td>

  2273.           <td>)</td>

  2274.           <td></td><td></td>

  2275.         </tr>

  2276.       </table>

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

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

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

  2280.   <table class="params">

  2281.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2282.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2283.   </table>

  2284.   </dd>

  2285. </dl>

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

  2287. 

  2288. </div>

  2289. </div>

  2290. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2291. <div class="memitem">

  2292. <div class="memproto">

  2293. <table class="mlabels">

  2294.   <tr>

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

  2296.       <table class="memname">

  2297.         <tr>

  2298.           <td class="memname">void FatFile::rewind </td>

  2299.           <td>(</td>

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

  2301.           <td></td>

  2302.         </tr>

  2303.       </table>

  2304.   </td>

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

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

  2307.   </tr>

  2308. </table>

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

  2310. <p>Set the file's current position to zero. </p>

  2311. 

  2312. </div>

  2313. </div>

  2314. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2315. <div class="memitem">

  2316. <div class="memproto">

  2317.       <table class="memname">

  2318.         <tr>

  2319.           <td class="memname">bool FatFile::rmdir </td>

  2320.           <td>(</td>

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

  2322.           <td></td>

  2323.         </tr>

  2324.       </table>

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

  2326. <p>Remove a directory file.</p>

  2327. <p>The directory file will be removed only if it is empty and is not the root directory. <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a> follows DOS and Windows and ignores the read-only attribute for the directory.</p>

  2328. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a directory that has a long name. For example if a directory has the long name "New folder" you should not delete the 8.3 name "NEWFOL~1".</dd></dl>

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

  2330. 

  2331. </div>

  2332. </div>

  2333. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2334. <div class="memitem">

  2335. <div class="memproto">

  2336.       <table class="memname">

  2337.         <tr>

  2338.           <td class="memname">bool FatFile::rmRfStar </td>

  2339.           <td>(</td>

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

  2341.           <td></td>

  2342.         </tr>

  2343.       </table>

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

  2345. <p>Recursively delete a directory and all contained files.</p>

  2346. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2347. <p>Warning - This will remove all contents of the directory including subdirectories. The directory will then be removed if it is not root. The read-only attribute for files will be ignored.</p>

  2348. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a directory that has a long name. See <a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove()</a> and <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a>.</dd></dl>

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

  2350. 

  2351. </div>

  2352. </div>

  2353. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2354. <div class="memitem">

  2355. <div class="memproto">

  2356. <table class="mlabels">

  2357.   <tr>

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

  2359.       <table class="memname">

  2360.         <tr>

  2361.           <td class="memname">bool FatFile::seekCur </td>

  2362.           <td>(</td>

  2363.           <td class="paramtype">int32_t&#160;</td>

  2364.           <td class="paramname"><em>offset</em></td><td>)</td>

  2365.           <td></td>

  2366.         </tr>

  2367.       </table>

  2368.   </td>

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

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

  2371.   </tr>

  2372. </table>

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

  2374. <p>Set the files position to current position + <em>pos</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. </p><dl class="params"><dt>Parameters</dt><dd>

  2375.   <table class="params">

  2376.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2377.   </table>

  2378.   </dd>

  2379. </dl>

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

  2381. 

  2382. </div>

  2383. </div>

  2384. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2385. <div class="memitem">

  2386. <div class="memproto">

  2387. <table class="mlabels">

  2388.   <tr>

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

  2390.       <table class="memname">

  2391.         <tr>

  2392.           <td class="memname">bool FatFile::seekEnd </td>

  2393.           <td>(</td>

  2394.           <td class="paramtype">int32_t&#160;</td>

  2395.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2396.           <td></td>

  2397.         </tr>

  2398.       </table>

  2399.   </td>

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

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

  2402.   </tr>

  2403. </table>

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

  2405. <p>Set the files position to end-of-file + <em>offset</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. Can't be used for directory files since file size is not defined. </p><dl class="params"><dt>Parameters</dt><dd>

  2406.   <table class="params">

  2407.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2408.   </table>

  2409.   </dd>

  2410. </dl>

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

  2412. 

  2413. </div>

  2414. </div>

  2415. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2416. <div class="memitem">

  2417. <div class="memproto">

  2418.       <table class="memname">

  2419.         <tr>

  2420.           <td class="memname">bool FatFile::seekSet </td>

  2421.           <td>(</td>

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

  2423.           <td class="paramname"><em>pos</em></td><td>)</td>

  2424.           <td></td>

  2425.         </tr>

  2426.       </table>

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

  2428. <p>Sets a file's position.</p>

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

  2430.   <table class="params">

  2431.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>The new position in bytes from the beginning of the file.</td></tr>

  2432.   </table>

  2433.   </dd>

  2434. </dl>

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

  2436. 

  2437. </div>

  2438. </div>

  2439. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2440. <div class="memitem">

  2441. <div class="memproto">

  2442. <table class="mlabels">

  2443.   <tr>

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

  2445.       <table class="memname">

  2446.         <tr>

  2447.           <td class="memname">static bool FatFile::setCwd </td>

  2448.           <td>(</td>

  2449.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2450.           <td class="paramname"><em>dir</em></td><td>)</td>

  2451.           <td></td>

  2452.         </tr>

  2453.       </table>

  2454.   </td>

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

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

  2457.   </tr>

  2458. </table>

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

  2460. <p>Set the current working directory.</p>

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

  2462.   <table class="params">

  2463.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2464.   </table>

  2465.   </dd>

  2466. </dl>

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

  2468. 

  2469. </div>

  2470. </div>

  2471. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2472. <div class="memitem">

  2473. <div class="memproto">

  2474.       <table class="memname">

  2475.         <tr>

  2476.           <td class="memname">void FatFile::setpos </td>

  2477.           <td>(</td>

  2478.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2479.           <td class="paramname"><em>pos</em></td><td>)</td>

  2480.           <td></td>

  2481.         </tr>

  2482.       </table>

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

  2484. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2485.   <table class="params">

  2486.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2487.   </table>

  2488.   </dd>

  2489. </dl>

  2490. 

  2491. </div>

  2492. </div>

  2493. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2494. <div class="memitem">

  2495. <div class="memproto">

  2496.       <table class="memname">

  2497.         <tr>

  2498.           <td class="memname">bool FatFile::sync </td>

  2499.           <td>(</td>

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

  2501.           <td></td>

  2502.         </tr>

  2503.       </table>

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

  2505. <p>The <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> call causes all modified data and directory fields to be written to the storage device.</p>

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

  2507. 

  2508. </div>

  2509. </div>

  2510. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2511. <div class="memitem">

  2512. <div class="memproto">

  2513.       <table class="memname">

  2514.         <tr>

  2515.           <td class="memname">bool FatFile::timestamp </td>

  2516.           <td>(</td>

  2517.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2518.           <td class="paramname"><em>file</em></td><td>)</td>

  2519.           <td></td>

  2520.         </tr>

  2521.       </table>

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

  2523. <p>Copy a file's timestamps</p>

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

  2525.   <table class="params">

  2526.     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> to copy timestamps from.</td></tr>

  2527.   </table>

  2528.   </dd>

  2529. </dl>

  2530. <dl class="section note"><dt>Note</dt><dd>Modify and access timestamps may be overwritten if a date time callback function has been set by <a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback()</a>.</dd></dl>

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

  2532. 

  2533. </div>

  2534. </div>

  2535. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2536. <div class="memitem">

  2537. <div class="memproto">

  2538.       <table class="memname">

  2539.         <tr>

  2540.           <td class="memname">bool FatFile::timestamp </td>

  2541.           <td>(</td>

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

  2543.           <td class="paramname"><em>flags</em>, </td>

  2544.         </tr>

  2545.         <tr>

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

  2547.           <td></td>

  2548.           <td class="paramtype">uint16_t&#160;</td>

  2549.           <td class="paramname"><em>year</em>, </td>

  2550.         </tr>

  2551.         <tr>

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

  2553.           <td></td>

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

  2555.           <td class="paramname"><em>month</em>, </td>

  2556.         </tr>

  2557.         <tr>

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

  2559.           <td></td>

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

  2561.           <td class="paramname"><em>day</em>, </td>

  2562.         </tr>

  2563.         <tr>

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

  2565.           <td></td>

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

  2567.           <td class="paramname"><em>hour</em>, </td>

  2568.         </tr>

  2569.         <tr>

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

  2571.           <td></td>

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

  2573.           <td class="paramname"><em>minute</em>, </td>

  2574.         </tr>

  2575.         <tr>

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

  2577.           <td></td>

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

  2579.           <td class="paramname"><em>second</em>&#160;</td>

  2580.         </tr>

  2581.         <tr>

  2582.           <td></td>

  2583.           <td>)</td>

  2584.           <td></td><td></td>

  2585.         </tr>

  2586.       </table>

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

  2588. <p>Set a file's timestamps in its directory entry.</p>

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

  2590.   <table class="params">

  2591.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Values for <em>flags</em> are constructed by a bitwise-inclusive OR of flags from the following list</td></tr>

  2592.   </table>

  2593.   </dd>

  2594. </dl>

  2595. <p>T_ACCESS - Set the file's last access date.</p>

  2596. <p>T_CREATE - Set the file's creation date and time.</p>

  2597. <p>T_WRITE - Set the file's last write/modification date and time.</p>

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

  2599.   <table class="params">

  2600.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2601.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2602.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2603.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2604.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2605.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2606.   </table>

  2607.   </dd>

  2608. </dl>

  2609. <dl class="section note"><dt>Note</dt><dd>It is possible to set an invalid date since there is no check for the number of days in a month.</dd>

  2610. <dd>

  2611. Modify and access timestamps may be overwritten if a date time callback function has been set by <a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback()</a>.</dd></dl>

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

  2613. 

  2614. </div>

  2615. </div>

  2616. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  2617. <div class="memitem">

  2618. <div class="memproto">

  2619.       <table class="memname">

  2620.         <tr>

  2621.           <td class="memname">bool FatFile::truncate </td>

  2622.           <td>(</td>

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

  2624.           <td class="paramname"><em>length</em></td><td>)</td>

  2625.           <td></td>

  2626.         </tr>

  2627.       </table>

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

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

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

  2631.   <table class="params">

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

  2633.   </table>

  2634.   </dd>

  2635. </dl>

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

  2637. 

  2638. </div>

  2639. </div>

  2640. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  2641. <div class="memitem">

  2642. <div class="memproto">

  2643. <table class="mlabels">

  2644.   <tr>

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

  2646.       <table class="memname">

  2647.         <tr>

  2648.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  2649.           <td>(</td>

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

  2651.           <td> const</td>

  2652.         </tr>

  2653.       </table>

  2654.   </td>

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

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

  2657.   </tr>

  2658. </table>

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

  2660. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> that contains this file. </dd></dl>

  2661. 

  2662. </div>

  2663. </div>

  2664. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  2665. <div class="memitem">

  2666. <div class="memproto">

  2667. <table class="mlabels">

  2668.   <tr>

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

  2670.       <table class="memname">

  2671.         <tr>

  2672.           <td class="memname">int FatFile::write </td>

  2673.           <td>(</td>

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

  2675.           <td class="paramname"><em>b</em></td><td>)</td>

  2676.           <td></td>

  2677.         </tr>

  2678.       </table>

  2679.   </td>

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

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

  2682.   </tr>

  2683. </table>

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

  2685. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2686.   <table class="params">

  2687.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2688.   </table>

  2689.   </dd>

  2690. </dl>

  2691. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2692. 

  2693. </div>

  2694. </div>

  2695. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  2696. <div class="memitem">

  2697. <div class="memproto">

  2698.       <table class="memname">

  2699.         <tr>

  2700.           <td class="memname">int FatFile::write </td>

  2701.           <td>(</td>

  2702.           <td class="paramtype">const void *&#160;</td>

  2703.           <td class="paramname"><em>buf</em>, </td>

  2704.         </tr>

  2705.         <tr>

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

  2707.           <td></td>

  2708.           <td class="paramtype">size_t&#160;</td>

  2709.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2710.         </tr>

  2711.         <tr>

  2712.           <td></td>

  2713.           <td>)</td>

  2714.           <td></td><td></td>

  2715.         </tr>

  2716.       </table>

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

  2718. <p>Write data to an open file.</p>

  2719. <dl class="section note"><dt>Note</dt><dd>Data is moved to the cache but may not be written to the storage device until <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> is called.</dd></dl>

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

  2721.   <table class="params">

  2722.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2723.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  2724.   </table>

  2725.   </dd>

  2726. </dl>

  2727. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write()</a> is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error. </dd></dl>

  2728. 

  2729. </div>

  2730. </div>

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

  2732. <li>Arduino/libraries/SdFat/utility/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  2733. <li>Arduino/libraries/SdFat/utility/FatFile.cpp</li>

  2734. <li>Arduino/libraries/SdFat/utility/FatFileLFN.cpp</li>

  2735. <li>Arduino/libraries/SdFat/utility/FatFilePrint.cpp</li>

  2736. <li>Arduino/libraries/SdFat/utility/FatFileSFN.cpp</li>

  2737. </ul>

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

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

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

  2741. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  2743. </a> 1.8.8

  2744. </small></address>

  2745. </body>

  2746. </html>