visus
/
teensy-sdfat
Tarkkaile 1
Äänestä 0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 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.
15 Commitit
1 Haara
Puu: 43c44ac8c7
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '43c44ac8c7'
${ noResults }
teensy-sdfat/html/class_print_file.html

3290 lines
147KB
Raaka Blame Historia 

  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: PrintFile 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_print_file-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p><a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> with Print.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for PrintFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node7" href="class_sd_file.html" title="Class for backward compatibility. " alt="" coords="47,155,105,181"/>
<area shape="rect" id="node2" href="class_fat_file.html" title="Basic file class. " alt="" coords="5,5,67,32"/>
</map>

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

  104. <div class="dynheader">

  105. Collaboration diagram for PrintFile:</div>

  106. <div class="dyncontent">

  107. <div class="center"><img src="class_print_file__coll__graph.png" border="0" usemap="#_print_file_coll__map" alt="Collaboration graph"/></div>

  108. <map name="_print_file_coll__map" id="_print_file_coll__map">

  109. <area shape="rect" id="node2" href="class_fat_file.html" title="Basic file class. " alt="" coords="5,5,67,32"/>
</map>

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

  111. <table class="memberdecls">

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

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

  114. <tr class="memitem:a600592235b2bee6bdb3a9701d0d6eee3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_file.html#a600592235b2bee6bdb3a9701d0d6eee3">available</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  148. <tr class="memitem:a53c4cb94af030fdf83a9160ec9a96949"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_file.html#a53c4cb94af030fdf83a9160ec9a96949">flush</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  182. <tr class="memitem:ad49f688a494b351ccbb0102dcfafb925"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad49f688a494b351ccbb0102dcfafb925">ls</a> (uint8_t flags=0)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  260. <tr class="memitem:a460b033ff85e85f684f8d9b615645db1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_file.html#a460b033ff85e85f684f8d9b615645db1">write</a> (uint8_t b)</td></tr>

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

  262. <tr class="memitem:a29c1d534d21c3a82ad04232d37119a57"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_file.html#a29c1d534d21c3a82ad04232d37119a57">write</a> (const uint8_t *buf, size_t size)</td></tr>

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

  264. <tr class="memitem:aa4a5b81161994cea07938702cdfce49f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write</a> (const char *str)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  281. <tr class="memitem:a8fdb038aafdf3a17ac80b53c063aa73b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8fdb038aafdf3a17ac80b53c063aa73b">printFatDate</a> (uint16_t fatDate)</td></tr>

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

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

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

  285. <tr class="memitem:a7740731f08ef97de7dfbc9b075c4c7d1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7740731f08ef97de7dfbc9b075c4c7d1">printFatTime</a> (uint16_t fatTime)</td></tr>

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

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

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

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

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

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

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

  293. </table>

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

  295. <div class="textblock"><p><a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> with Print. </p>

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

  297. <a class="anchor" id="adc3bcb2a5c4207de7ff7e9be3ac54233"></a>

  298. <div class="memitem">

  299. <div class="memproto">

  300. <table class="mlabels">

  301.   <tr>

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

  303.       <table class="memname">

  304.         <tr>

  305.           <td class="memname">PrintFile::PrintFile </td>

  306.           <td>(</td>

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

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

  309.         </tr>

  310.         <tr>

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

  312.           <td></td>

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

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

  315.         </tr>

  316.         <tr>

  317.           <td></td>

  318.           <td>)</td>

  319.           <td></td><td></td>

  320.         </tr>

  321.       </table>

  322.   </td>

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

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

  325.   </tr>

  326. </table>

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

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

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

  330.   <table class="params">

  331.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>

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

  333.   </table>

  334.   </dd>

  335. </dl>

  336. 

  337. </div>

  338. </div>

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

  340. <a class="anchor" id="a600592235b2bee6bdb3a9701d0d6eee3"></a>

  341. <div class="memitem">

  342. <div class="memproto">

  343. <table class="mlabels">

  344.   <tr>

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

  346.       <table class="memname">

  347.         <tr>

  348.           <td class="memname">int PrintFile::available </td>

  349.           <td>(</td>

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

  351.           <td></td>

  352.         </tr>

  353.       </table>

  354.   </td>

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

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

  357.   </tr>

  358. </table>

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

  360. <dl class="section return"><dt>Returns</dt><dd>number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available. </dd></dl>

  361. 

  362. </div>

  363. </div>

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

  365. <div class="memitem">

  366. <div class="memproto">

  367. <table class="mlabels">

  368.   <tr>

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

  370.       <table class="memname">

  371.         <tr>

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

  373.           <td>(</td>

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

  375.           <td></td>

  376.         </tr>

  377.       </table>

  378.   </td>

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

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

  381.   </tr>

  382. </table>

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

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

  385. 

  386. </div>

  387. </div>

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

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

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

  394.       <table class="memname">

  395.         <tr>

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

  397.           <td>(</td>

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

  399.           <td></td>

  400.         </tr>

  401.       </table>

  402.   </td>

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

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

  405.   </tr>

  406. </table>

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

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

  409. 

  410. </div>

  411. </div>

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

  413. <div class="memitem">

  414. <div class="memproto">

  415. <table class="mlabels">

  416.   <tr>

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

  418.       <table class="memname">

  419.         <tr>

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

  421.           <td>(</td>

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

  423.           <td></td>

  424.         </tr>

  425.       </table>

  426.   </td>

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

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

  429.   </tr>

  430. </table>

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

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

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

  434. 

  435. </div>

  436. </div>

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

  438. <div class="memitem">

  439. <div class="memproto">

  440. <table class="mlabels">

  441.   <tr>

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

  443.       <table class="memname">

  444.         <tr>

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

  446.           <td>(</td>

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

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

  449.         </tr>

  450.         <tr>

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

  452.           <td></td>

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

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

  455.         </tr>

  456.         <tr>

  457.           <td></td>

  458.           <td>)</td>

  459.           <td></td><td></td>

  460.         </tr>

  461.       </table>

  462.   </td>

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

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

  465.   </tr>

  466. </table>

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

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

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

  470.   <table class="params">

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

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

  473.   </table>

  474.   </dd>

  475. </dl>

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

  477. 

  478. </div>

  479. </div>

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

  481. <div class="memitem">

  482. <div class="memproto">

  483. <table class="mlabels">

  484.   <tr>

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

  486.       <table class="memname">

  487.         <tr>

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

  489.           <td>(</td>

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

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

  492.         </tr>

  493.         <tr>

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

  495.           <td></td>

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

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

  498.         </tr>

  499.         <tr>

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

  501.           <td></td>

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

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

  504.         </tr>

  505.         <tr>

  506.           <td></td>

  507.           <td>)</td>

  508.           <td></td><td></td>

  509.         </tr>

  510.       </table>

  511.   </td>

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

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

  514.   </tr>

  515. </table>

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

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

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

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

  520.   <table class="params">

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

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

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

  524.   </table>

  525.   </dd>

  526. </dl>

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

  528. 

  529. </div>

  530. </div>

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

  532. <div class="memitem">

  533. <div class="memproto">

  534. <table class="mlabels">

  535.   <tr>

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

  537.       <table class="memname">

  538.         <tr>

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

  540.           <td>(</td>

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

  542.           <td> const</td>

  543.         </tr>

  544.       </table>

  545.   </td>

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

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

  548.   </tr>

  549. </table>

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

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

  552. 

  553. </div>

  554. </div>

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

  556. <div class="memitem">

  557. <div class="memproto">

  558. <table class="mlabels">

  559.   <tr>

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

  561.       <table class="memname">

  562.         <tr>

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

  564.           <td>(</td>

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

  566.           <td> const</td>

  567.         </tr>

  568.       </table>

  569.   </td>

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

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

  572.   </tr>

  573. </table>

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

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

  576. 

  577. </div>

  578. </div>

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

  580. <div class="memitem">

  581. <div class="memproto">

  582. <table class="mlabels">

  583.   <tr>

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

  585.       <table class="memname">

  586.         <tr>

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

  588.           <td>(</td>

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

  590.           <td></td>

  591.         </tr>

  592.       </table>

  593.   </td>

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

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

  596.   </tr>

  597. </table>

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

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

  600. 

  601. </div>

  602. </div>

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

  604. <div class="memitem">

  605. <div class="memproto">

  606. <table class="mlabels">

  607.   <tr>

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

  609.       <table class="memname">

  610.         <tr>

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

  612.           <td>(</td>

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

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

  615.           <td></td>

  616.         </tr>

  617.       </table>

  618.   </td>

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

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

  621.   </tr>

  622. </table>

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

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

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

  626.   <table class="params">

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

  628.   </table>

  629.   </dd>

  630. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

  643. </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>

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

  645. 

  646. </div>

  647. </div>

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

  649. <div class="memitem">

  650. <div class="memproto">

  651. <table class="mlabels">

  652.   <tr>

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

  654.       <table class="memname">

  655.         <tr>

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

  657.           <td>(</td>

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

  659.           <td></td>

  660.         </tr>

  661.       </table>

  662.   </td>

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

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

  665.   </tr>

  666. </table>

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

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

  669. 

  670. </div>

  671. </div>

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

  673. <div class="memitem">

  674. <div class="memproto">

  675. <table class="mlabels">

  676.   <tr>

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

  678.       <table class="memname">

  679.         <tr>

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

  681.           <td>(</td>

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

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

  684.           <td></td>

  685.         </tr>

  686.       </table>

  687.   </td>

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

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

  690.   </tr>

  691. </table>

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

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

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

  695.   <table class="params">

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

  697.   </table>

  698.   </dd>

  699. </dl>

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

  701. 

  702. </div>

  703. </div>

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

  705. <div class="memitem">

  706. <div class="memproto">

  707. <table class="mlabels">

  708.   <tr>

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

  710.       <table class="memname">

  711.         <tr>

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

  713.           <td>(</td>

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

  715.           <td></td>

  716.         </tr>

  717.       </table>

  718.   </td>

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

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

  721.   </tr>

  722. </table>

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

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

  725. 

  726. </div>

  727. </div>

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

  729. <div class="memitem">

  730. <div class="memproto">

  731. <table class="mlabels">

  732.   <tr>

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

  734.       <table class="memname">

  735.         <tr>

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

  737.           <td>(</td>

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

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

  740.         </tr>

  741.         <tr>

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

  743.           <td></td>

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

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

  746.         </tr>

  747.         <tr>

  748.           <td></td>

  749.           <td>)</td>

  750.           <td></td><td></td>

  751.         </tr>

  752.       </table>

  753.   </td>

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

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

  756.   </tr>

  757. </table>

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

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

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

  761.   <table class="params">

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

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

  764.   </table>

  765.   </dd>

  766. </dl>

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

  768. 

  769. </div>

  770. </div>

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

  772. <div class="memitem">

  773. <div class="memproto">

  774. <table class="mlabels">

  775.   <tr>

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

  777.       <table class="memname">

  778.         <tr>

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

  780.           <td>(</td>

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

  782.           <td></td>

  783.         </tr>

  784.       </table>

  785.   </td>

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

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

  788.   </tr>

  789. </table>

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

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

  792. 

  793. </div>

  794. </div>

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

  796. <div class="memitem">

  797. <div class="memproto">

  798. <table class="mlabels">

  799.   <tr>

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

  801.       <table class="memname">

  802.         <tr>

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

  804.           <td>(</td>

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

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

  807.         </tr>

  808.         <tr>

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

  810.           <td></td>

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

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

  813.         </tr>

  814.         <tr>

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

  816.           <td></td>

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

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

  819.         </tr>

  820.         <tr>

  821.           <td></td>

  822.           <td>)</td>

  823.           <td></td><td></td>

  824.         </tr>

  825.       </table>

  826.   </td>

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

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

  829.   </tr>

  830. </table>

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

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

  833.   <table class="params">

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

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

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

  837.   </table>

  838.   </dd>

  839. </dl>

  840. 

  841. </div>

  842. </div>

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

  844. <div class="memitem">

  845. <div class="memproto">

  846. <table class="mlabels">

  847.   <tr>

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

  849.       <table class="memname">

  850.         <tr>

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

  852.           <td>(</td>

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

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

  855.           <td></td>

  856.         </tr>

  857.       </table>

  858.   </td>

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

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

  861.   </tr>

  862. </table>

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

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

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

  866.   <table class="params">

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

  868.   </table>

  869.   </dd>

  870. </dl>

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

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

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

  874. 

  875. </div>

  876. </div>

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

  878. <div class="memitem">

  879. <div class="memproto">

  880. <table class="mlabels">

  881.   <tr>

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

  883.       <table class="memname">

  884.         <tr>

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

  886.           <td>(</td>

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

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

  889.         </tr>

  890.         <tr>

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

  892.           <td></td>

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

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

  895.         </tr>

  896.         <tr>

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

  898.           <td></td>

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

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

  901.         </tr>

  902.         <tr>

  903.           <td></td>

  904.           <td>)</td>

  905.           <td></td><td></td>

  906.         </tr>

  907.       </table>

  908.   </td>

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

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

  911.   </tr>

  912. </table>

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

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

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

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

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

  918.   <table class="params">

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

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

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

  922.   </table>

  923.   </dd>

  924. </dl>

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

  926. 

  927. </div>

  928. </div>

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

  930. <div class="memitem">

  931. <div class="memproto">

  932. <table class="mlabels">

  933.   <tr>

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

  935.       <table class="memname">

  936.         <tr>

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

  938.           <td>(</td>

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

  940.           <td> const</td>

  941.         </tr>

  942.       </table>

  943.   </td>

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

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

  946.   </tr>

  947. </table>

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

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

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

  951. 

  952. </div>

  953. </div>

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

  955. <div class="memitem">

  956. <div class="memproto">

  957. <table class="mlabels">

  958.   <tr>

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

  960.       <table class="memname">

  961.         <tr>

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

  963.           <td>(</td>

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

  965.           <td> const</td>

  966.         </tr>

  967.       </table>

  968.   </td>

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

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

  971.   </tr>

  972. </table>

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

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

  975. 

  976. </div>

  977. </div>

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

  979. <div class="memitem">

  980. <div class="memproto">

  981. <table class="mlabels">

  982.   <tr>

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

  984.       <table class="memname">

  985.         <tr>

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

  987.           <td>(</td>

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

  989.           <td> const</td>

  990.         </tr>

  991.       </table>

  992.   </td>

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

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

  995.   </tr>

  996. </table>

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

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

  999. 

  1000. </div>

  1001. </div>

  1002. <a class="anchor" id="a53c4cb94af030fdf83a9160ec9a96949"></a>

  1003. <div class="memitem">

  1004. <div class="memproto">

  1005. <table class="mlabels">

  1006.   <tr>

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

  1008.       <table class="memname">

  1009.         <tr>

  1010.           <td class="memname">void PrintFile::flush </td>

  1011.           <td>(</td>

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

  1013.           <td></td>

  1014.         </tr>

  1015.       </table>

  1016.   </td>

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

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

  1019.   </tr>

  1020. </table>

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

  1022. <p>Ensure that any bytes written to the file are saved to the SD card. </p>

  1023. 

  1024. </div>

  1025. </div>

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

  1027. <div class="memitem">

  1028. <div class="memproto">

  1029. <table class="mlabels">

  1030.   <tr>

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

  1032.       <table class="memname">

  1033.         <tr>

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

  1035.           <td>(</td>

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

  1037.           <td></td>

  1038.         </tr>

  1039.       </table>

  1040.   </td>

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

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

  1043.   </tr>

  1044. </table>

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

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

  1047. 

  1048. </div>

  1049. </div>

  1050. <a class="anchor" id="aafa565e286440aab612cdb430fc01da5"></a>

  1051. <div class="memitem">

  1052. <div class="memproto">

  1053. <table class="mlabels">

  1054.   <tr>

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

  1056.       <table class="memname">

  1057.         <tr>

  1058.           <td class="memname">bool FatFile::getName </td>

  1059.           <td>(</td>

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

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

  1062.         </tr>

  1063.         <tr>

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

  1065.           <td></td>

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

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

  1068.         </tr>

  1069.         <tr>

  1070.           <td></td>

  1071.           <td>)</td>

  1072.           <td></td><td></td>

  1073.         </tr>

  1074.       </table>

  1075.   </td>

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

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

  1078.   </tr>

  1079. </table>

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

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

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

  1083.   <table class="params">

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

  1085.     <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's name will be truncated if the file's name is too long. </td></tr>

  1086.   </table>

  1087.   </dd>

  1088. </dl>

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

  1090. 

  1091. </div>

  1092. </div>

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

  1094. <div class="memitem">

  1095. <div class="memproto">

  1096. <table class="mlabels">

  1097.   <tr>

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

  1099.       <table class="memname">

  1100.         <tr>

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

  1102.           <td>(</td>

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

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

  1105.           <td></td>

  1106.         </tr>

  1107.       </table>

  1108.   </td>

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

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

  1111.   </tr>

  1112. </table>

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

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

  1115.   <table class="params">

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

  1117.   </table>

  1118.   </dd>

  1119. </dl>

  1120. 

  1121. </div>

  1122. </div>

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

  1124. <div class="memitem">

  1125. <div class="memproto">

  1126. <table class="mlabels">

  1127.   <tr>

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

  1129.       <table class="memname">

  1130.         <tr>

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

  1132.           <td>(</td>

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

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

  1135.           <td></td>

  1136.         </tr>

  1137.       </table>

  1138.   </td>

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

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

  1141.   </tr>

  1142. </table>

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

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

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

  1146.   <table class="params">

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

  1148.   </table>

  1149.   </dd>

  1150. </dl>

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

  1152. 

  1153. </div>

  1154. </div>

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

  1156. <div class="memitem">

  1157. <div class="memproto">

  1158. <table class="mlabels">

  1159.   <tr>

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

  1161.       <table class="memname">

  1162.         <tr>

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

  1164.           <td>(</td>

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

  1166.           <td></td>

  1167.         </tr>

  1168.       </table>

  1169.   </td>

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

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

  1172.   </tr>

  1173. </table>

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

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

  1176. 

  1177. </div>

  1178. </div>

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

  1180. <div class="memitem">

  1181. <div class="memproto">

  1182. <table class="mlabels">

  1183.   <tr>

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

  1185.       <table class="memname">

  1186.         <tr>

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

  1188.           <td>(</td>

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

  1190.           <td> const</td>

  1191.         </tr>

  1192.       </table>

  1193.   </td>

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

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

  1196.   </tr>

  1197. </table>

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

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

  1200. 

  1201. </div>

  1202. </div>

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

  1204. <div class="memitem">

  1205. <div class="memproto">

  1206. <table class="mlabels">

  1207.   <tr>

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

  1209.       <table class="memname">

  1210.         <tr>

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

  1212.           <td>(</td>

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

  1214.           <td> const</td>

  1215.         </tr>

  1216.       </table>

  1217.   </td>

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

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

  1220.   </tr>

  1221. </table>

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

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

  1224. 

  1225. </div>

  1226. </div>

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

  1228. <div class="memitem">

  1229. <div class="memproto">

  1230. <table class="mlabels">

  1231.   <tr>

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

  1233.       <table class="memname">

  1234.         <tr>

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

  1236.           <td>(</td>

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

  1238.           <td> const</td>

  1239.         </tr>

  1240.       </table>

  1241.   </td>

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

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

  1244.   </tr>

  1245. </table>

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

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

  1248. 

  1249. </div>

  1250. </div>

  1251. <a class="anchor" id="aed36d17f8fde597b6ed9446faec1f7e3"></a>

  1252. <div class="memitem">

  1253. <div class="memproto">

  1254. <table class="mlabels">

  1255.   <tr>

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

  1257.       <table class="memname">

  1258.         <tr>

  1259.           <td class="memname">bool FatFile::isLFN </td>

  1260.           <td>(</td>

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

  1262.           <td> const</td>

  1263.         </tr>

  1264.       </table>

  1265.   </td>

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

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

  1268.   </tr>

  1269. </table>

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

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

  1272. 

  1273. </div>

  1274. </div>

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

  1276. <div class="memitem">

  1277. <div class="memproto">

  1278. <table class="mlabels">

  1279.   <tr>

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

  1281.       <table class="memname">

  1282.         <tr>

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

  1284.           <td>(</td>

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

  1286.           <td> const</td>

  1287.         </tr>

  1288.       </table>

  1289.   </td>

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

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

  1292.   </tr>

  1293. </table>

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

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

  1296. 

  1297. </div>

  1298. </div>

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

  1300. <div class="memitem">

  1301. <div class="memproto">

  1302. <table class="mlabels">

  1303.   <tr>

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

  1305.       <table class="memname">

  1306.         <tr>

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

  1308.           <td>(</td>

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

  1310.           <td> const</td>

  1311.         </tr>

  1312.       </table>

  1313.   </td>

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

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

  1316.   </tr>

  1317. </table>

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

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

  1320. 

  1321. </div>

  1322. </div>

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

  1324. <div class="memitem">

  1325. <div class="memproto">

  1326. <table class="mlabels">

  1327.   <tr>

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

  1329.       <table class="memname">

  1330.         <tr>

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

  1332.           <td>(</td>

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

  1334.           <td> const</td>

  1335.         </tr>

  1336.       </table>

  1337.   </td>

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

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

  1340.   </tr>

  1341. </table>

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

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

  1344. 

  1345. </div>

  1346. </div>

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

  1348. <div class="memitem">

  1349. <div class="memproto">

  1350. <table class="mlabels">

  1351.   <tr>

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

  1353.       <table class="memname">

  1354.         <tr>

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

  1356.           <td>(</td>

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

  1358.           <td> const</td>

  1359.         </tr>

  1360.       </table>

  1361.   </td>

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

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

  1364.   </tr>

  1365. </table>

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

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

  1368. 

  1369. </div>

  1370. </div>

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

  1372. <div class="memitem">

  1373. <div class="memproto">

  1374. <table class="mlabels">

  1375.   <tr>

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

  1377.       <table class="memname">

  1378.         <tr>

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

  1380.           <td>(</td>

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

  1382.           <td> const</td>

  1383.         </tr>

  1384.       </table>

  1385.   </td>

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

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

  1388.   </tr>

  1389. </table>

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

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

  1392. 

  1393. </div>

  1394. </div>

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

  1396. <div class="memitem">

  1397. <div class="memproto">

  1398. <table class="mlabels">

  1399.   <tr>

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

  1401.       <table class="memname">

  1402.         <tr>

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

  1404.           <td>(</td>

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

  1406.           <td> const</td>

  1407.         </tr>

  1408.       </table>

  1409.   </td>

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

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

  1412.   </tr>

  1413. </table>

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

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

  1416. 

  1417. </div>

  1418. </div>

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

  1420. <div class="memitem">

  1421. <div class="memproto">

  1422. <table class="mlabels">

  1423.   <tr>

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

  1425.       <table class="memname">

  1426.         <tr>

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

  1428.           <td>(</td>

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

  1430.           <td> const</td>

  1431.         </tr>

  1432.       </table>

  1433.   </td>

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

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

  1436.   </tr>

  1437. </table>

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

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

  1440. 

  1441. </div>

  1442. </div>

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

  1444. <div class="memitem">

  1445. <div class="memproto">

  1446. <table class="mlabels">

  1447.   <tr>

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

  1449.       <table class="memname">

  1450.         <tr>

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

  1452.           <td>(</td>

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

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

  1455.           <td></td>

  1456.         </tr>

  1457.       </table>

  1458.   </td>

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

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

  1461.   </tr>

  1462. </table>

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

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

  1465.   <table class="params">

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

  1467.   </table>

  1468.   </dd>

  1469. </dl>

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

  1471. 

  1472. </div>

  1473. </div>

  1474. <a class="anchor" id="ad49f688a494b351ccbb0102dcfafb925"></a>

  1475. <div class="memitem">

  1476. <div class="memproto">

  1477. <table class="mlabels">

  1478.   <tr>

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

  1480.       <table class="memname">

  1481.         <tr>

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

  1483.           <td>(</td>

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

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

  1486.           <td></td>

  1487.         </tr>

  1488.       </table>

  1489.   </td>

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

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

  1492.   </tr>

  1493. </table>

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

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

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

  1497.   <table class="params">

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

  1499.   </table>

  1500.   </dd>

  1501. </dl>

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

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

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

  1505. 

  1506. </div>

  1507. </div>

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

  1509. <div class="memitem">

  1510. <div class="memproto">

  1511. <table class="mlabels">

  1512.   <tr>

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

  1514.       <table class="memname">

  1515.         <tr>

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

  1517.           <td>(</td>

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

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

  1520.         </tr>

  1521.         <tr>

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

  1523.           <td></td>

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

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

  1526.         </tr>

  1527.         <tr>

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

  1529.           <td></td>

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

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

  1532.         </tr>

  1533.         <tr>

  1534.           <td></td>

  1535.           <td>)</td>

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

  1537.         </tr>

  1538.       </table>

  1539.   </td>

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

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

  1542.   </tr>

  1543. </table>

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

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

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

  1547.   <table class="params">

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

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

  1550.   </table>

  1551.   </dd>

  1552. </dl>

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

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

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

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

  1557.   <table class="params">

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

  1559.   </table>

  1560.   </dd>

  1561. </dl>

  1562. 

  1563. </div>

  1564. </div>

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

  1566. <div class="memitem">

  1567. <div class="memproto">

  1568. <table class="mlabels">

  1569.   <tr>

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

  1571.       <table class="memname">

  1572.         <tr>

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

  1574.           <td>(</td>

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

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

  1577.         </tr>

  1578.         <tr>

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

  1580.           <td></td>

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

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

  1583.         </tr>

  1584.         <tr>

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

  1586.           <td></td>

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

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

  1589.         </tr>

  1590.         <tr>

  1591.           <td></td>

  1592.           <td>)</td>

  1593.           <td></td><td></td>

  1594.         </tr>

  1595.       </table>

  1596.   </td>

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

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

  1599.   </tr>

  1600. </table>

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

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

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

  1604.   <table class="params">

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

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

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

  1608.   </table>

  1609.   </dd>

  1610. </dl>

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

  1612. 

  1613. </div>

  1614. </div>

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

  1616. <div class="memitem">

  1617. <div class="memproto">

  1618. <table class="mlabels">

  1619.   <tr>

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

  1621.       <table class="memname">

  1622.         <tr>

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

  1624.           <td>(</td>

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

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

  1627.         </tr>

  1628.         <tr>

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

  1630.           <td></td>

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

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

  1633.         </tr>

  1634.         <tr>

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

  1636.           <td></td>

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

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

  1639.         </tr>

  1640.         <tr>

  1641.           <td></td>

  1642.           <td>)</td>

  1643.           <td></td><td></td>

  1644.         </tr>

  1645.       </table>

  1646.   </td>

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

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

  1649.   </tr>

  1650. </table>

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

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

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

  1654.   <table class="params">

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

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

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

  1658.   </table>

  1659.   </dd>

  1660. </dl>

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

  1662. 

  1663. </div>

  1664. </div>

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

  1666. <div class="memitem">

  1667. <div class="memproto">

  1668. <table class="mlabels">

  1669.   <tr>

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

  1671.       <table class="memname">

  1672.         <tr>

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

  1674.           <td>(</td>

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

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

  1677.         </tr>

  1678.         <tr>

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

  1680.           <td></td>

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

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

  1683.         </tr>

  1684.         <tr>

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

  1686.           <td></td>

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

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

  1689.         </tr>

  1690.         <tr>

  1691.           <td></td>

  1692.           <td>)</td>

  1693.           <td></td><td></td>

  1694.         </tr>

  1695.       </table>

  1696.   </td>

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

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

  1699.   </tr>

  1700. </table>

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

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

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

  1704.   <table class="params">

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

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

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

  1708.   </table>

  1709.   </dd>

  1710. </dl>

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

  1712. 

  1713. </div>

  1714. </div>

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

  1716. <div class="memitem">

  1717. <div class="memproto">

  1718. <table class="mlabels">

  1719.   <tr>

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

  1721.       <table class="memname">

  1722.         <tr>

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

  1724.           <td>(</td>

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

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

  1727.         </tr>

  1728.         <tr>

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

  1730.           <td></td>

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

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

  1733.         </tr>

  1734.         <tr>

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

  1736.           <td></td>

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

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

  1739.         </tr>

  1740.         <tr>

  1741.           <td></td>

  1742.           <td>)</td>

  1743.           <td></td><td></td>

  1744.         </tr>

  1745.       </table>

  1746.   </td>

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

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

  1749.   </tr>

  1750. </table>

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

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

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

  1754.   <table class="params">

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

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

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

  1758.   </table>

  1759.   </dd>

  1760. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1775. 

  1776. </div>

  1777. </div>

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

  1779. <div class="memitem">

  1780. <div class="memproto">

  1781. <table class="mlabels">

  1782.   <tr>

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

  1784.       <table class="memname">

  1785.         <tr>

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

  1787.           <td>(</td>

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

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

  1790.         </tr>

  1791.         <tr>

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

  1793.           <td></td>

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

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

  1796.         </tr>

  1797.         <tr>

  1798.           <td></td>

  1799.           <td>)</td>

  1800.           <td></td><td></td>

  1801.         </tr>

  1802.       </table>

  1803.   </td>

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

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

  1806.   </tr>

  1807. </table>

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

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

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

  1811.   <table class="params">

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

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

  1814.   </table>

  1815.   </dd>

  1816. </dl>

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

  1818. 

  1819. </div>

  1820. </div>

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

  1822. <div class="memitem">

  1823. <div class="memproto">

  1824. <table class="mlabels">

  1825.   <tr>

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

  1827.       <table class="memname">

  1828.         <tr>

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

  1830.           <td>(</td>

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

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

  1833.         </tr>

  1834.         <tr>

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

  1836.           <td></td>

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

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

  1839.         </tr>

  1840.         <tr>

  1841.           <td></td>

  1842.           <td>)</td>

  1843.           <td></td><td></td>

  1844.         </tr>

  1845.       </table>

  1846.   </td>

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

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

  1849.   </tr>

  1850. </table>

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

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

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

  1854.   <table class="params">

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

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

  1857.   </table>

  1858.   </dd>

  1859. </dl>

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

  1861. 

  1862. </div>

  1863. </div>

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

  1865. <div class="memitem">

  1866. <div class="memproto">

  1867. <table class="mlabels">

  1868.   <tr>

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

  1870.       <table class="memname">

  1871.         <tr>

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

  1873.           <td>(</td>

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

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

  1876.           <td></td>

  1877.         </tr>

  1878.       </table>

  1879.   </td>

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

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

  1882.   </tr>

  1883. </table>

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

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

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

  1887.   <table class="params">

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

  1889.   </table>

  1890.   </dd>

  1891. </dl>

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

  1893. 

  1894. </div>

  1895. </div>

  1896. <a class="anchor" id="a3a2a66f4a0cb69ab4edc66d39997fda7"></a>

  1897. <div class="memitem">

  1898. <div class="memproto">

  1899. <table class="mlabels">

  1900.   <tr>

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

  1902.       <table class="memname">

  1903.         <tr>

  1904.           <td class="memname">int PrintFile::peek </td>

  1905.           <td>(</td>

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

  1907.           <td></td>

  1908.         </tr>

  1909.       </table>

  1910.   </td>

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

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

  1913.   </tr>

  1914. </table>

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

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

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

  1918. 

  1919. </div>

  1920. </div>

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

  1922. <div class="memitem">

  1923. <div class="memproto">

  1924. <table class="mlabels">

  1925.   <tr>

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

  1927.       <table class="memname">

  1928.         <tr>

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

  1930.           <td>(</td>

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

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

  1933.           <td></td>

  1934.         </tr>

  1935.       </table>

  1936.   </td>

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

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

  1939.   </tr>

  1940. </table>

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

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

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

  1944.   <table class="params">

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

  1946.   </table>

  1947.   </dd>

  1948. </dl>

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

  1950. 

  1951. </div>

  1952. </div>

  1953. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1954. <div class="memitem">

  1955. <div class="memproto">

  1956. <table class="mlabels">

  1957.   <tr>

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

  1959.       <table class="memname">

  1960.         <tr>

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

  1962.           <td>(</td>

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

  1964.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1965.           <td></td>

  1966.         </tr>

  1967.       </table>

  1968.   </td>

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

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

  1971.   </tr>

  1972. </table>

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

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

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

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

  1977.   <table class="params">

  1978.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1979.   </table>

  1980.   </dd>

  1981. </dl>

  1982. 

  1983. </div>

  1984. </div>

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

  1986. <div class="memitem">

  1987. <div class="memproto">

  1988. <table class="mlabels">

  1989.   <tr>

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

  1991.       <table class="memname">

  1992.         <tr>

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

  1994.           <td>(</td>

  1995.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1996.           <td class="paramname"><em>pr</em>, </td>

  1997.         </tr>

  1998.         <tr>

  1999.           <td class="paramkey"></td>

  2000.           <td></td>

  2001.           <td class="paramtype">uint16_t&#160;</td>

  2002.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2003.         </tr>

  2004.         <tr>

  2005.           <td></td>

  2006.           <td>)</td>

  2007.           <td></td><td></td>

  2008.         </tr>

  2009.       </table>

  2010.   </td>

  2011.   <td class="mlabels-right">

  2012. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2013.   </tr>

  2014. </table>

  2015. </div><div class="memdoc">

  2016. <p>Print a directory date field.</p>

  2017. <p>Format is yyyy-mm-dd.</p>

  2018. <dl class="params"><dt>Parameters</dt><dd>

  2019.   <table class="params">

  2020.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2021.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2022.   </table>

  2023.   </dd>

  2024. </dl>

  2025. 

  2026. </div>

  2027. </div>

  2028. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2029. <div class="memitem">

  2030. <div class="memproto">

  2031. <table class="mlabels">

  2032.   <tr>

  2033.   <td class="mlabels-left">

  2034.       <table class="memname">

  2035.         <tr>

  2036.           <td class="memname">static void FatFile::printFatTime </td>

  2037.           <td>(</td>

  2038.           <td class="paramtype">uint16_t&#160;</td>

  2039.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2040.           <td></td>

  2041.         </tr>

  2042.       </table>

  2043.   </td>

  2044.   <td class="mlabels-right">

  2045. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2046.   </tr>

  2047. </table>

  2048. </div><div class="memdoc">

  2049. <p>Print a directory time field.</p>

  2050. <p>Format is hh:mm:ss.</p>

  2051. <dl class="params"><dt>Parameters</dt><dd>

  2052.   <table class="params">

  2053.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2054.   </table>

  2055.   </dd>

  2056. </dl>

  2057. 

  2058. </div>

  2059. </div>

  2060. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2061. <div class="memitem">

  2062. <div class="memproto">

  2063. <table class="mlabels">

  2064.   <tr>

  2065.   <td class="mlabels-left">

  2066.       <table class="memname">

  2067.         <tr>

  2068.           <td class="memname">void FatFile::printFatTime </td>

  2069.           <td>(</td>

  2070.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2071.           <td class="paramname"><em>pr</em>, </td>

  2072.         </tr>

  2073.         <tr>

  2074.           <td class="paramkey"></td>

  2075.           <td></td>

  2076.           <td class="paramtype">uint16_t&#160;</td>

  2077.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2078.         </tr>

  2079.         <tr>

  2080.           <td></td>

  2081.           <td>)</td>

  2082.           <td></td><td></td>

  2083.         </tr>

  2084.       </table>

  2085.   </td>

  2086.   <td class="mlabels-right">

  2087. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2088.   </tr>

  2089. </table>

  2090. </div><div class="memdoc">

  2091. <p>Print a directory time field.</p>

  2092. <p>Format is hh:mm:ss.</p>

  2093. <dl class="params"><dt>Parameters</dt><dd>

  2094.   <table class="params">

  2095.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2096.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2097.   </table>

  2098.   </dd>

  2099. </dl>

  2100. 

  2101. </div>

  2102. </div>

  2103. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2104. <div class="memitem">

  2105. <div class="memproto">

  2106. <table class="mlabels">

  2107.   <tr>

  2108.   <td class="mlabels-left">

  2109.       <table class="memname">

  2110.         <tr>

  2111.           <td class="memname">int FatFile::printField </td>

  2112.           <td>(</td>

  2113.           <td class="paramtype">float&#160;</td>

  2114.           <td class="paramname"><em>value</em>, </td>

  2115.         </tr>

  2116.         <tr>

  2117.           <td class="paramkey"></td>

  2118.           <td></td>

  2119.           <td class="paramtype">char&#160;</td>

  2120.           <td class="paramname"><em>term</em>, </td>

  2121.         </tr>

  2122.         <tr>

  2123.           <td class="paramkey"></td>

  2124.           <td></td>

  2125.           <td class="paramtype">uint8_t&#160;</td>

  2126.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2127.         </tr>

  2128.         <tr>

  2129.           <td></td>

  2130.           <td>)</td>

  2131.           <td></td><td></td>

  2132.         </tr>

  2133.       </table>

  2134.   </td>

  2135.   <td class="mlabels-right">

  2136. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2137.   </tr>

  2138. </table>

  2139. </div><div class="memdoc">

  2140. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2141.   <table class="params">

  2142.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2143.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2144.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2145.   </table>

  2146.   </dd>

  2147. </dl>

  2148. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2149. 

  2150. </div>

  2151. </div>

  2152. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2153. <div class="memitem">

  2154. <div class="memproto">

  2155. <table class="mlabels">

  2156.   <tr>

  2157.   <td class="mlabels-left">

  2158.       <table class="memname">

  2159.         <tr>

  2160.           <td class="memname">int FatFile::printField </td>

  2161.           <td>(</td>

  2162.           <td class="paramtype">int16_t&#160;</td>

  2163.           <td class="paramname"><em>value</em>, </td>

  2164.         </tr>

  2165.         <tr>

  2166.           <td class="paramkey"></td>

  2167.           <td></td>

  2168.           <td class="paramtype">char&#160;</td>

  2169.           <td class="paramname"><em>term</em>&#160;</td>

  2170.         </tr>

  2171.         <tr>

  2172.           <td></td>

  2173.           <td>)</td>

  2174.           <td></td><td></td>

  2175.         </tr>

  2176.       </table>

  2177.   </td>

  2178.   <td class="mlabels-right">

  2179. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2180.   </tr>

  2181. </table>

  2182. </div><div class="memdoc">

  2183. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2184.   <table class="params">

  2185.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2186.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2187.   </table>

  2188.   </dd>

  2189. </dl>

  2190. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2191. 

  2192. </div>

  2193. </div>

  2194. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2195. <div class="memitem">

  2196. <div class="memproto">

  2197. <table class="mlabels">

  2198.   <tr>

  2199.   <td class="mlabels-left">

  2200.       <table class="memname">

  2201.         <tr>

  2202.           <td class="memname">int FatFile::printField </td>

  2203.           <td>(</td>

  2204.           <td class="paramtype">uint16_t&#160;</td>

  2205.           <td class="paramname"><em>value</em>, </td>

  2206.         </tr>

  2207.         <tr>

  2208.           <td class="paramkey"></td>

  2209.           <td></td>

  2210.           <td class="paramtype">char&#160;</td>

  2211.           <td class="paramname"><em>term</em>&#160;</td>

  2212.         </tr>

  2213.         <tr>

  2214.           <td></td>

  2215.           <td>)</td>

  2216.           <td></td><td></td>

  2217.         </tr>

  2218.       </table>

  2219.   </td>

  2220.   <td class="mlabels-right">

  2221. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2222.   </tr>

  2223. </table>

  2224. </div><div class="memdoc">

  2225. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2226.   <table class="params">

  2227.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2228.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2229.   </table>

  2230.   </dd>

  2231. </dl>

  2232. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2233. 

  2234. </div>

  2235. </div>

  2236. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2237. <div class="memitem">

  2238. <div class="memproto">

  2239. <table class="mlabels">

  2240.   <tr>

  2241.   <td class="mlabels-left">

  2242.       <table class="memname">

  2243.         <tr>

  2244.           <td class="memname">int FatFile::printField </td>

  2245.           <td>(</td>

  2246.           <td class="paramtype">int32_t&#160;</td>

  2247.           <td class="paramname"><em>value</em>, </td>

  2248.         </tr>

  2249.         <tr>

  2250.           <td class="paramkey"></td>

  2251.           <td></td>

  2252.           <td class="paramtype">char&#160;</td>

  2253.           <td class="paramname"><em>term</em>&#160;</td>

  2254.         </tr>

  2255.         <tr>

  2256.           <td></td>

  2257.           <td>)</td>

  2258.           <td></td><td></td>

  2259.         </tr>

  2260.       </table>

  2261.   </td>

  2262.   <td class="mlabels-right">

  2263. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2264.   </tr>

  2265. </table>

  2266. </div><div class="memdoc">

  2267. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2268.   <table class="params">

  2269.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2270.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2271.   </table>

  2272.   </dd>

  2273. </dl>

  2274. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2275. 

  2276. </div>

  2277. </div>

  2278. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2279. <div class="memitem">

  2280. <div class="memproto">

  2281. <table class="mlabels">

  2282.   <tr>

  2283.   <td class="mlabels-left">

  2284.       <table class="memname">

  2285.         <tr>

  2286.           <td class="memname">int FatFile::printField </td>

  2287.           <td>(</td>

  2288.           <td class="paramtype">uint32_t&#160;</td>

  2289.           <td class="paramname"><em>value</em>, </td>

  2290.         </tr>

  2291.         <tr>

  2292.           <td class="paramkey"></td>

  2293.           <td></td>

  2294.           <td class="paramtype">char&#160;</td>

  2295.           <td class="paramname"><em>term</em>&#160;</td>

  2296.         </tr>

  2297.         <tr>

  2298.           <td></td>

  2299.           <td>)</td>

  2300.           <td></td><td></td>

  2301.         </tr>

  2302.       </table>

  2303.   </td>

  2304.   <td class="mlabels-right">

  2305. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2306.   </tr>

  2307. </table>

  2308. </div><div class="memdoc">

  2309. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2310.   <table class="params">

  2311.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2312.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2313.   </table>

  2314.   </dd>

  2315. </dl>

  2316. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2317. 

  2318. </div>

  2319. </div>

  2320. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2321. <div class="memitem">

  2322. <div class="memproto">

  2323. <table class="mlabels">

  2324.   <tr>

  2325.   <td class="mlabels-left">

  2326.       <table class="memname">

  2327.         <tr>

  2328.           <td class="memname">size_t FatFile::printFileSize </td>

  2329.           <td>(</td>

  2330.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2331.           <td class="paramname"><em>pr</em></td><td>)</td>

  2332.           <td></td>

  2333.         </tr>

  2334.       </table>

  2335.   </td>

  2336.   <td class="mlabels-right">

  2337. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2338.   </tr>

  2339. </table>

  2340. </div><div class="memdoc">

  2341. <p>Print a file's size.</p>

  2342. <dl class="params"><dt>Parameters</dt><dd>

  2343.   <table class="params">

  2344.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2345.   </table>

  2346.   </dd>

  2347. </dl>

  2348. <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>

  2349. 

  2350. </div>

  2351. </div>

  2352. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2353. <div class="memitem">

  2354. <div class="memproto">

  2355. <table class="mlabels">

  2356.   <tr>

  2357.   <td class="mlabels-left">

  2358.       <table class="memname">

  2359.         <tr>

  2360.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2361.           <td>(</td>

  2362.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2363.           <td class="paramname"><em>pr</em></td><td>)</td>

  2364.           <td></td>

  2365.         </tr>

  2366.       </table>

  2367.   </td>

  2368.   <td class="mlabels-right">

  2369. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2370.   </tr>

  2371. </table>

  2372. </div><div class="memdoc">

  2373. <p>Print a file's modify date and time</p>

  2374. <dl class="params"><dt>Parameters</dt><dd>

  2375.   <table class="params">

  2376.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2377.   </table>

  2378.   </dd>

  2379. </dl>

  2380. <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>

  2381. 

  2382. </div>

  2383. </div>

  2384. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></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">size_t FatFile::printName </td>

  2393.           <td>(</td>

  2394.           <td class="paramname"></td><td>)</td>

  2395.           <td></td>

  2396.         </tr>

  2397.       </table>

  2398.   </td>

  2399.   <td class="mlabels-right">

  2400. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2401.   </tr>

  2402. </table>

  2403. </div><div class="memdoc">

  2404. <p>Print a file's name.</p>

  2405. <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>

  2406. 

  2407. </div>

  2408. </div>

  2409. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2410. <div class="memitem">

  2411. <div class="memproto">

  2412. <table class="mlabels">

  2413.   <tr>

  2414.   <td class="mlabels-left">

  2415.       <table class="memname">

  2416.         <tr>

  2417.           <td class="memname">size_t FatFile::printName </td>

  2418.           <td>(</td>

  2419.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2420.           <td class="paramname"><em>pr</em></td><td>)</td>

  2421.           <td></td>

  2422.         </tr>

  2423.       </table>

  2424.   </td>

  2425.   <td class="mlabels-right">

  2426. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2427.   </tr>

  2428. </table>

  2429. </div><div class="memdoc">

  2430. <p>Print a file's name</p>

  2431. <dl class="params"><dt>Parameters</dt><dd>

  2432.   <table class="params">

  2433.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2434.   </table>

  2435.   </dd>

  2436. </dl>

  2437. <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>

  2438. 

  2439. </div>

  2440. </div>

  2441. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2442. <div class="memitem">

  2443. <div class="memproto">

  2444. <table class="mlabels">

  2445.   <tr>

  2446.   <td class="mlabels-left">

  2447.       <table class="memname">

  2448.         <tr>

  2449.           <td class="memname">size_t FatFile::printSFN </td>

  2450.           <td>(</td>

  2451.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2452.           <td class="paramname"><em>pr</em></td><td>)</td>

  2453.           <td></td>

  2454.         </tr>

  2455.       </table>

  2456.   </td>

  2457.   <td class="mlabels-right">

  2458. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2459.   </tr>

  2460. </table>

  2461. </div><div class="memdoc">

  2462. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2463. <dl class="params"><dt>Parameters</dt><dd>

  2464.   <table class="params">

  2465.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2466.   </table>

  2467.   </dd>

  2468. </dl>

  2469. <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>

  2470. 

  2471. </div>

  2472. </div>

  2473. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2474. <div class="memitem">

  2475. <div class="memproto">

  2476. <table class="mlabels">

  2477.   <tr>

  2478.   <td class="mlabels-left">

  2479.       <table class="memname">

  2480.         <tr>

  2481.           <td class="memname">int FatFile::read </td>

  2482.           <td>(</td>

  2483.           <td class="paramname"></td><td>)</td>

  2484.           <td></td>

  2485.         </tr>

  2486.       </table>

  2487.   </td>

  2488.   <td class="mlabels-right">

  2489. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2490.   </tr>

  2491. </table>

  2492. </div><div class="memdoc">

  2493. <p>Read the next byte from a file.</p>

  2494. <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>

  2495. 

  2496. </div>

  2497. </div>

  2498. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2499. <div class="memitem">

  2500. <div class="memproto">

  2501. <table class="mlabels">

  2502.   <tr>

  2503.   <td class="mlabels-left">

  2504.       <table class="memname">

  2505.         <tr>

  2506.           <td class="memname">int FatFile::read </td>

  2507.           <td>(</td>

  2508.           <td class="paramtype">void *&#160;</td>

  2509.           <td class="paramname"><em>buf</em>, </td>

  2510.         </tr>

  2511.         <tr>

  2512.           <td class="paramkey"></td>

  2513.           <td></td>

  2514.           <td class="paramtype">size_t&#160;</td>

  2515.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2516.         </tr>

  2517.         <tr>

  2518.           <td></td>

  2519.           <td>)</td>

  2520.           <td></td><td></td>

  2521.         </tr>

  2522.       </table>

  2523.   </td>

  2524.   <td class="mlabels-right">

  2525. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2526.   </tr>

  2527. </table>

  2528. </div><div class="memdoc">

  2529. <p>Read data from a file starting at the current position.</p>

  2530. <dl class="params"><dt>Parameters</dt><dd>

  2531.   <table class="params">

  2532.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2533.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2534.   </table>

  2535.   </dd>

  2536. </dl>

  2537. <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>

  2538. 

  2539. </div>

  2540. </div>

  2541. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2542. <div class="memitem">

  2543. <div class="memproto">

  2544. <table class="mlabels">

  2545.   <tr>

  2546.   <td class="mlabels-left">

  2547.       <table class="memname">

  2548.         <tr>

  2549.           <td class="memname">int8_t FatFile::readDir </td>

  2550.           <td>(</td>

  2551.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2552.           <td class="paramname"><em>dir</em></td><td>)</td>

  2553.           <td></td>

  2554.         </tr>

  2555.       </table>

  2556.   </td>

  2557.   <td class="mlabels-right">

  2558. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2559.   </tr>

  2560. </table>

  2561. </div><div class="memdoc">

  2562. <p>Read the next directory entry from a directory file.</p>

  2563. <dl class="params"><dt>Parameters</dt><dd>

  2564.   <table class="params">

  2565.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2566.   </table>

  2567.   </dd>

  2568. </dl>

  2569. <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>

  2570. 

  2571. </div>

  2572. </div>

  2573. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2574. <div class="memitem">

  2575. <div class="memproto">

  2576. <table class="mlabels">

  2577.   <tr>

  2578.   <td class="mlabels-left">

  2579.       <table class="memname">

  2580.         <tr>

  2581.           <td class="memname">bool FatFile::remove </td>

  2582.           <td>(</td>

  2583.           <td class="paramname"></td><td>)</td>

  2584.           <td></td>

  2585.         </tr>

  2586.       </table>

  2587.   </td>

  2588.   <td class="mlabels-right">

  2589. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2590.   </tr>

  2591. </table>

  2592. </div><div class="memdoc">

  2593. <p>Remove a file.</p>

  2594. <p>The directory entry and all data for the file are deleted.</p>

  2595. <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>

  2596. <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>

  2597. 

  2598. </div>

  2599. </div>

  2600. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2601. <div class="memitem">

  2602. <div class="memproto">

  2603. <table class="mlabels">

  2604.   <tr>

  2605.   <td class="mlabels-left">

  2606.       <table class="memname">

  2607.         <tr>

  2608.           <td class="memname">bool FatFile::remove </td>

  2609.           <td>(</td>

  2610.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2611.           <td class="paramname"><em>dirFile</em>, </td>

  2612.         </tr>

  2613.         <tr>

  2614.           <td class="paramkey"></td>

  2615.           <td></td>

  2616.           <td class="paramtype">const char *&#160;</td>

  2617.           <td class="paramname"><em>path</em>&#160;</td>

  2618.         </tr>

  2619.         <tr>

  2620.           <td></td>

  2621.           <td>)</td>

  2622.           <td></td><td></td>

  2623.         </tr>

  2624.       </table>

  2625.   </td>

  2626.   <td class="mlabels-right">

  2627. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2628.   </tr>

  2629. </table>

  2630. </div><div class="memdoc">

  2631. <p>Remove a file.</p>

  2632. <p>The directory entry and all data for the file are deleted.</p>

  2633. <dl class="params"><dt>Parameters</dt><dd>

  2634.   <table class="params">

  2635.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2636.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2637.   </table>

  2638.   </dd>

  2639. </dl>

  2640. <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>

  2641. <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>

  2642. 

  2643. </div>

  2644. </div>

  2645. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2646. <div class="memitem">

  2647. <div class="memproto">

  2648. <table class="mlabels">

  2649.   <tr>

  2650.   <td class="mlabels-left">

  2651.       <table class="memname">

  2652.         <tr>

  2653.           <td class="memname">bool FatFile::rename </td>

  2654.           <td>(</td>

  2655.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2656.           <td class="paramname"><em>dirFile</em>, </td>

  2657.         </tr>

  2658.         <tr>

  2659.           <td class="paramkey"></td>

  2660.           <td></td>

  2661.           <td class="paramtype">const char *&#160;</td>

  2662.           <td class="paramname"><em>newPath</em>&#160;</td>

  2663.         </tr>

  2664.         <tr>

  2665.           <td></td>

  2666.           <td>)</td>

  2667.           <td></td><td></td>

  2668.         </tr>

  2669.       </table>

  2670.   </td>

  2671.   <td class="mlabels-right">

  2672. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2673.   </tr>

  2674. </table>

  2675. </div><div class="memdoc">

  2676. <p>Rename a file or subdirectory.</p>

  2677. <dl class="params"><dt>Parameters</dt><dd>

  2678.   <table class="params">

  2679.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2680.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2681.   </table>

  2682.   </dd>

  2683. </dl>

  2684. <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>

  2685. 

  2686. </div>

  2687. </div>

  2688. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2689. <div class="memitem">

  2690. <div class="memproto">

  2691. <table class="mlabels">

  2692.   <tr>

  2693.   <td class="mlabels-left">

  2694.       <table class="memname">

  2695.         <tr>

  2696.           <td class="memname">void FatFile::rewind </td>

  2697.           <td>(</td>

  2698.           <td class="paramname"></td><td>)</td>

  2699.           <td></td>

  2700.         </tr>

  2701.       </table>

  2702.   </td>

  2703.   <td class="mlabels-right">

  2704. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2705.   </tr>

  2706. </table>

  2707. </div><div class="memdoc">

  2708. <p>Set the file's current position to zero. </p>

  2709. 

  2710. </div>

  2711. </div>

  2712. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2713. <div class="memitem">

  2714. <div class="memproto">

  2715. <table class="mlabels">

  2716.   <tr>

  2717.   <td class="mlabels-left">

  2718.       <table class="memname">

  2719.         <tr>

  2720.           <td class="memname">bool FatFile::rmdir </td>

  2721.           <td>(</td>

  2722.           <td class="paramname"></td><td>)</td>

  2723.           <td></td>

  2724.         </tr>

  2725.       </table>

  2726.   </td>

  2727.   <td class="mlabels-right">

  2728. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2729.   </tr>

  2730. </table>

  2731. </div><div class="memdoc">

  2732. <p>Remove a directory file.</p>

  2733. <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>

  2734. <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>

  2735. <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>

  2736. 

  2737. </div>

  2738. </div>

  2739. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2740. <div class="memitem">

  2741. <div class="memproto">

  2742. <table class="mlabels">

  2743.   <tr>

  2744.   <td class="mlabels-left">

  2745.       <table class="memname">

  2746.         <tr>

  2747.           <td class="memname">bool FatFile::rmRfStar </td>

  2748.           <td>(</td>

  2749.           <td class="paramname"></td><td>)</td>

  2750.           <td></td>

  2751.         </tr>

  2752.       </table>

  2753.   </td>

  2754.   <td class="mlabels-right">

  2755. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2756.   </tr>

  2757. </table>

  2758. </div><div class="memdoc">

  2759. <p>Recursively delete a directory and all contained files.</p>

  2760. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2761. <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>

  2762. <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>

  2763. <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>

  2764. 

  2765. </div>

  2766. </div>

  2767. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2768. <div class="memitem">

  2769. <div class="memproto">

  2770. <table class="mlabels">

  2771.   <tr>

  2772.   <td class="mlabels-left">

  2773.       <table class="memname">

  2774.         <tr>

  2775.           <td class="memname">bool FatFile::seekCur </td>

  2776.           <td>(</td>

  2777.           <td class="paramtype">int32_t&#160;</td>

  2778.           <td class="paramname"><em>offset</em></td><td>)</td>

  2779.           <td></td>

  2780.         </tr>

  2781.       </table>

  2782.   </td>

  2783.   <td class="mlabels-right">

  2784. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2785.   </tr>

  2786. </table>

  2787. </div><div class="memdoc">

  2788. <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>

  2789.   <table class="params">

  2790.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2791.   </table>

  2792.   </dd>

  2793. </dl>

  2794. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2795. 

  2796. </div>

  2797. </div>

  2798. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2799. <div class="memitem">

  2800. <div class="memproto">

  2801. <table class="mlabels">

  2802.   <tr>

  2803.   <td class="mlabels-left">

  2804.       <table class="memname">

  2805.         <tr>

  2806.           <td class="memname">bool FatFile::seekEnd </td>

  2807.           <td>(</td>

  2808.           <td class="paramtype">int32_t&#160;</td>

  2809.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2810.           <td></td>

  2811.         </tr>

  2812.       </table>

  2813.   </td>

  2814.   <td class="mlabels-right">

  2815. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2816.   </tr>

  2817. </table>

  2818. </div><div class="memdoc">

  2819. <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>

  2820.   <table class="params">

  2821.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2822.   </table>

  2823.   </dd>

  2824. </dl>

  2825. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2826. 

  2827. </div>

  2828. </div>

  2829. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2830. <div class="memitem">

  2831. <div class="memproto">

  2832. <table class="mlabels">

  2833.   <tr>

  2834.   <td class="mlabels-left">

  2835.       <table class="memname">

  2836.         <tr>

  2837.           <td class="memname">bool FatFile::seekSet </td>

  2838.           <td>(</td>

  2839.           <td class="paramtype">uint32_t&#160;</td>

  2840.           <td class="paramname"><em>pos</em></td><td>)</td>

  2841.           <td></td>

  2842.         </tr>

  2843.       </table>

  2844.   </td>

  2845.   <td class="mlabels-right">

  2846. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2847.   </tr>

  2848. </table>

  2849. </div><div class="memdoc">

  2850. <p>Sets a file's position.</p>

  2851. <dl class="params"><dt>Parameters</dt><dd>

  2852.   <table class="params">

  2853.     <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>

  2854.   </table>

  2855.   </dd>

  2856. </dl>

  2857. <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>

  2858. 

  2859. </div>

  2860. </div>

  2861. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2862. <div class="memitem">

  2863. <div class="memproto">

  2864. <table class="mlabels">

  2865.   <tr>

  2866.   <td class="mlabels-left">

  2867.       <table class="memname">

  2868.         <tr>

  2869.           <td class="memname">static bool FatFile::setCwd </td>

  2870.           <td>(</td>

  2871.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2872.           <td class="paramname"><em>dir</em></td><td>)</td>

  2873.           <td></td>

  2874.         </tr>

  2875.       </table>

  2876.   </td>

  2877.   <td class="mlabels-right">

  2878. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2879.   </tr>

  2880. </table>

  2881. </div><div class="memdoc">

  2882. <p>Set the current working directory.</p>

  2883. <dl class="params"><dt>Parameters</dt><dd>

  2884.   <table class="params">

  2885.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2886.   </table>

  2887.   </dd>

  2888. </dl>

  2889. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2890. 

  2891. </div>

  2892. </div>

  2893. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2894. <div class="memitem">

  2895. <div class="memproto">

  2896. <table class="mlabels">

  2897.   <tr>

  2898.   <td class="mlabels-left">

  2899.       <table class="memname">

  2900.         <tr>

  2901.           <td class="memname">void FatFile::setpos </td>

  2902.           <td>(</td>

  2903.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2904.           <td class="paramname"><em>pos</em></td><td>)</td>

  2905.           <td></td>

  2906.         </tr>

  2907.       </table>

  2908.   </td>

  2909.   <td class="mlabels-right">

  2910. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2911.   </tr>

  2912. </table>

  2913. </div><div class="memdoc">

  2914. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2915.   <table class="params">

  2916.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2917.   </table>

  2918.   </dd>

  2919. </dl>

  2920. 

  2921. </div>

  2922. </div>

  2923. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2924. <div class="memitem">

  2925. <div class="memproto">

  2926. <table class="mlabels">

  2927.   <tr>

  2928.   <td class="mlabels-left">

  2929.       <table class="memname">

  2930.         <tr>

  2931.           <td class="memname">bool FatFile::sync </td>

  2932.           <td>(</td>

  2933.           <td class="paramname"></td><td>)</td>

  2934.           <td></td>

  2935.         </tr>

  2936.       </table>

  2937.   </td>

  2938.   <td class="mlabels-right">

  2939. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2940.   </tr>

  2941. </table>

  2942. </div><div class="memdoc">

  2943. <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>

  2944. <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>

  2945. 

  2946. </div>

  2947. </div>

  2948. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2949. <div class="memitem">

  2950. <div class="memproto">

  2951. <table class="mlabels">

  2952.   <tr>

  2953.   <td class="mlabels-left">

  2954.       <table class="memname">

  2955.         <tr>

  2956.           <td class="memname">bool FatFile::timestamp </td>

  2957.           <td>(</td>

  2958.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2959.           <td class="paramname"><em>file</em></td><td>)</td>

  2960.           <td></td>

  2961.         </tr>

  2962.       </table>

  2963.   </td>

  2964.   <td class="mlabels-right">

  2965. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2966.   </tr>

  2967. </table>

  2968. </div><div class="memdoc">

  2969. <p>Copy a file's timestamps</p>

  2970. <dl class="params"><dt>Parameters</dt><dd>

  2971.   <table class="params">

  2972.     <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>

  2973.   </table>

  2974.   </dd>

  2975. </dl>

  2976. <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>

  2977. <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>

  2978. 

  2979. </div>

  2980. </div>

  2981. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2982. <div class="memitem">

  2983. <div class="memproto">

  2984. <table class="mlabels">

  2985.   <tr>

  2986.   <td class="mlabels-left">

  2987.       <table class="memname">

  2988.         <tr>

  2989.           <td class="memname">bool FatFile::timestamp </td>

  2990.           <td>(</td>

  2991.           <td class="paramtype">uint8_t&#160;</td>

  2992.           <td class="paramname"><em>flags</em>, </td>

  2993.         </tr>

  2994.         <tr>

  2995.           <td class="paramkey"></td>

  2996.           <td></td>

  2997.           <td class="paramtype">uint16_t&#160;</td>

  2998.           <td class="paramname"><em>year</em>, </td>

  2999.         </tr>

  3000.         <tr>

  3001.           <td class="paramkey"></td>

  3002.           <td></td>

  3003.           <td class="paramtype">uint8_t&#160;</td>

  3004.           <td class="paramname"><em>month</em>, </td>

  3005.         </tr>

  3006.         <tr>

  3007.           <td class="paramkey"></td>

  3008.           <td></td>

  3009.           <td class="paramtype">uint8_t&#160;</td>

  3010.           <td class="paramname"><em>day</em>, </td>

  3011.         </tr>

  3012.         <tr>

  3013.           <td class="paramkey"></td>

  3014.           <td></td>

  3015.           <td class="paramtype">uint8_t&#160;</td>

  3016.           <td class="paramname"><em>hour</em>, </td>

  3017.         </tr>

  3018.         <tr>

  3019.           <td class="paramkey"></td>

  3020.           <td></td>

  3021.           <td class="paramtype">uint8_t&#160;</td>

  3022.           <td class="paramname"><em>minute</em>, </td>

  3023.         </tr>

  3024.         <tr>

  3025.           <td class="paramkey"></td>

  3026.           <td></td>

  3027.           <td class="paramtype">uint8_t&#160;</td>

  3028.           <td class="paramname"><em>second</em>&#160;</td>

  3029.         </tr>

  3030.         <tr>

  3031.           <td></td>

  3032.           <td>)</td>

  3033.           <td></td><td></td>

  3034.         </tr>

  3035.       </table>

  3036.   </td>

  3037.   <td class="mlabels-right">

  3038. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3039.   </tr>

  3040. </table>

  3041. </div><div class="memdoc">

  3042. <p>Set a file's timestamps in its directory entry.</p>

  3043. <dl class="params"><dt>Parameters</dt><dd>

  3044.   <table class="params">

  3045.     <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>

  3046.   </table>

  3047.   </dd>

  3048. </dl>

  3049. <p>T_ACCESS - Set the file's last access date.</p>

  3050. <p>T_CREATE - Set the file's creation date and time.</p>

  3051. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3052. <dl class="params"><dt>Parameters</dt><dd>

  3053.   <table class="params">

  3054.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3055.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3056.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3057.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3058.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3059.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3060.   </table>

  3061.   </dd>

  3062. </dl>

  3063. <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>

  3064. <dd>

  3065. 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>

  3066. <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>

  3067. 

  3068. </div>

  3069. </div>

  3070. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3071. <div class="memitem">

  3072. <div class="memproto">

  3073. <table class="mlabels">

  3074.   <tr>

  3075.   <td class="mlabels-left">

  3076.       <table class="memname">

  3077.         <tr>

  3078.           <td class="memname">bool FatFile::truncate </td>

  3079.           <td>(</td>

  3080.           <td class="paramtype">uint32_t&#160;</td>

  3081.           <td class="paramname"><em>length</em></td><td>)</td>

  3082.           <td></td>

  3083.         </tr>

  3084.       </table>

  3085.   </td>

  3086.   <td class="mlabels-right">

  3087. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3088.   </tr>

  3089. </table>

  3090. </div><div class="memdoc">

  3091. <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>

  3092. <dl class="params"><dt>Parameters</dt><dd>

  3093.   <table class="params">

  3094.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3095.   </table>

  3096.   </dd>

  3097. </dl>

  3098. <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>

  3099. 

  3100. </div>

  3101. </div>

  3102. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3103. <div class="memitem">

  3104. <div class="memproto">

  3105. <table class="mlabels">

  3106.   <tr>

  3107.   <td class="mlabels-left">

  3108.       <table class="memname">

  3109.         <tr>

  3110.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3111.           <td>(</td>

  3112.           <td class="paramname"></td><td>)</td>

  3113.           <td> const</td>

  3114.         </tr>

  3115.       </table>

  3116.   </td>

  3117.   <td class="mlabels-right">

  3118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3119.   </tr>

  3120. </table>

  3121. </div><div class="memdoc">

  3122. <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>

  3123. 

  3124. </div>

  3125. </div>

  3126. <a class="anchor" id="a460b033ff85e85f684f8d9b615645db1"></a>

  3127. <div class="memitem">

  3128. <div class="memproto">

  3129. <table class="mlabels">

  3130.   <tr>

  3131.   <td class="mlabels-left">

  3132.       <table class="memname">

  3133.         <tr>

  3134.           <td class="memname">size_t PrintFile::write </td>

  3135.           <td>(</td>

  3136.           <td class="paramtype">uint8_t&#160;</td>

  3137.           <td class="paramname"><em>b</em></td><td>)</td>

  3138.           <td></td>

  3139.         </tr>

  3140.       </table>

  3141.   </td>

  3142.   <td class="mlabels-right">

  3143. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3144.   </tr>

  3145. </table>

  3146. </div><div class="memdoc">

  3147. <p>Read the next byte from a file.</p>

  3148. <dl class="section return"><dt>Returns</dt><dd>For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1. Write a byte to a file. Required by the Arduino Print class. </dd></dl>

  3149. <dl class="params"><dt>Parameters</dt><dd>

  3150.   <table class="params">

  3151.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>the byte to be written. Use getWriteError to check for errors. </td></tr>

  3152.   </table>

  3153.   </dd>

  3154. </dl>

  3155. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3156. 

  3157. </div>

  3158. </div>

  3159. <a class="anchor" id="a29c1d534d21c3a82ad04232d37119a57"></a>

  3160. <div class="memitem">

  3161. <div class="memproto">

  3162. <table class="mlabels">

  3163.   <tr>

  3164.   <td class="mlabels-left">

  3165.       <table class="memname">

  3166.         <tr>

  3167.           <td class="memname">size_t PrintFile::write </td>

  3168.           <td>(</td>

  3169.           <td class="paramtype">const uint8_t *&#160;</td>

  3170.           <td class="paramname"><em>buf</em>, </td>

  3171.         </tr>

  3172.         <tr>

  3173.           <td class="paramkey"></td>

  3174.           <td></td>

  3175.           <td class="paramtype">size_t&#160;</td>

  3176.           <td class="paramname"><em>size</em>&#160;</td>

  3177.         </tr>

  3178.         <tr>

  3179.           <td></td>

  3180.           <td>)</td>

  3181.           <td></td><td></td>

  3182.         </tr>

  3183.       </table>

  3184.   </td>

  3185.   <td class="mlabels-right">

  3186. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3187.   </tr>

  3188. </table>

  3189. </div><div class="memdoc">

  3190. <p>Write data to an open file. Form required by Print.</p>

  3191. <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>

  3192. <dl class="params"><dt>Parameters</dt><dd>

  3193.   <table class="params">

  3194.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3195.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3196.   </table>

  3197.   </dd>

  3198. </dl>

  3199. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_print_file.html#a460b033ff85e85f684f8d9b615645db1">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_print_file.html#a460b033ff85e85f684f8d9b615645db1">write()</a> returns -1. Possible errors include <a class="el" href="class_print_file.html#a460b033ff85e85f684f8d9b615645db1">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>

  3200. 

  3201. </div>

  3202. </div>

  3203. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3204. <div class="memitem">

  3205. <div class="memproto">

  3206. <table class="mlabels">

  3207.   <tr>

  3208.   <td class="mlabels-left">

  3209.       <table class="memname">

  3210.         <tr>

  3211.           <td class="memname">int FatFile::write </td>

  3212.           <td>(</td>

  3213.           <td class="paramtype">const char *&#160;</td>

  3214.           <td class="paramname"><em>str</em></td><td>)</td>

  3215.           <td></td>

  3216.         </tr>

  3217.       </table>

  3218.   </td>

  3219.   <td class="mlabels-right">

  3220. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3221.   </tr>

  3222. </table>

  3223. </div><div class="memdoc">

  3224. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3225.   <table class="params">

  3226.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3227.   </table>

  3228.   </dd>

  3229. </dl>

  3230. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3231. 

  3232. </div>

  3233. </div>

  3234. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3235. <div class="memitem">

  3236. <div class="memproto">

  3237. <table class="mlabels">

  3238.   <tr>

  3239.   <td class="mlabels-left">

  3240.       <table class="memname">

  3241.         <tr>

  3242.           <td class="memname">int FatFile::write </td>

  3243.           <td>(</td>

  3244.           <td class="paramtype">const void *&#160;</td>

  3245.           <td class="paramname"><em>buf</em>, </td>

  3246.         </tr>

  3247.         <tr>

  3248.           <td class="paramkey"></td>

  3249.           <td></td>

  3250.           <td class="paramtype">size_t&#160;</td>

  3251.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3252.         </tr>

  3253.         <tr>

  3254.           <td></td>

  3255.           <td>)</td>

  3256.           <td></td><td></td>

  3257.         </tr>

  3258.       </table>

  3259.   </td>

  3260.   <td class="mlabels-right">

  3261. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3262.   </tr>

  3263. </table>

  3264. </div><div class="memdoc">

  3265. <p>Write data to an open file.</p>

  3266. <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>

  3267. <dl class="params"><dt>Parameters</dt><dd>

  3268.   <table class="params">

  3269.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3270.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3271.   </table>

  3272.   </dd>

  3273. </dl>

  3274. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">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>

  3275. 

  3276. </div>

  3277. </div>

  3278. <hr/>The documentation for this class was generated from the following file:<ul>

  3279. <li>Arduino/libraries/SdFat/utility/<a class="el" href="_arduino_files_8h.html">ArduinoFiles.h</a></li>

  3280. </ul>

  3281. </div><!-- contents -->

  3282. <!-- start footer part -->

  3283. <hr class="footer"/><address class="footer"><small>

  3284. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3285. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3286. </a> 1.8.8

  3287. </small></address>

  3288. </body>

  3289. </html>