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

3292 lines
145KB
Raw Blame History 

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

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

  3. <head>

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

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

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

  7. <title>SdFat: 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/searchdata.js"></script>

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

  88. <a href="class_print_file-members.html">List of all members</a>  </div>

  89.   <div class="headertitle">

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

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

  92. <div class="contents">

  93. 

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

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

  96. 

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

  98. <div class="dynheader">

  99. Inheritance diagram for PrintFile:</div>

  100. <div class="dyncontent">

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

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

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

  104. </map>

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

  106. <div class="dynheader">

  107. Collaboration diagram for PrintFile:</div>

  108. <div class="dyncontent">

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

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

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

  112. </map>

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

  114. <table class="memberdecls">

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

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

  117. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  296. </table>

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

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

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

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

  301. <div class="memitem">

  302. <div class="memproto">

  303. <table class="mlabels">

  304.   <tr>

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

  306.       <table class="memname">

  307.         <tr>

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

  309.           <td>(</td>

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

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

  312.         </tr>

  313.         <tr>

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

  315.           <td></td>

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

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

  318.         </tr>

  319.         <tr>

  320.           <td></td>

  321.           <td>)</td>

  322.           <td></td><td></td>

  323.         </tr>

  324.       </table>

  325.   </td>

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

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

  328.   </tr>

  329. </table>

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

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

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

  333.   <table class="params">

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

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

  336.   </table>

  337.   </dd>

  338. </dl>

  339. 

  340. </div>

  341. </div>

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

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

  344. <div class="memitem">

  345. <div class="memproto">

  346. <table class="mlabels">

  347.   <tr>

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

  349.       <table class="memname">

  350.         <tr>

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

  352.           <td>(</td>

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

  354.           <td></td>

  355.         </tr>

  356.       </table>

  357.   </td>

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

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

  360.   </tr>

  361. </table>

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

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

  364. 

  365. </div>

  366. </div>

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

  368. <div class="memitem">

  369. <div class="memproto">

  370. <table class="mlabels">

  371.   <tr>

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

  373.       <table class="memname">

  374.         <tr>

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

  376.           <td>(</td>

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

  378.           <td></td>

  379.         </tr>

  380.       </table>

  381.   </td>

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

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

  384.   </tr>

  385. </table>

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

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

  388. 

  389. </div>

  390. </div>

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

  392. <div class="memitem">

  393. <div class="memproto">

  394. <table class="mlabels">

  395.   <tr>

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

  397.       <table class="memname">

  398.         <tr>

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

  400.           <td>(</td>

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

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405.   </td>

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

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

  408.   </tr>

  409. </table>

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

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

  412. 

  413. </div>

  414. </div>

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

  416. <div class="memitem">

  417. <div class="memproto">

  418. <table class="mlabels">

  419.   <tr>

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

  421.       <table class="memname">

  422.         <tr>

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

  424.           <td>(</td>

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

  426.           <td></td>

  427.         </tr>

  428.       </table>

  429.   </td>

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

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

  432.   </tr>

  433. </table>

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

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

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

  437. 

  438. </div>

  439. </div>

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

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

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

  452.         </tr>

  453.         <tr>

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

  455.           <td></td>

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

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

  458.         </tr>

  459.         <tr>

  460.           <td></td>

  461.           <td>)</td>

  462.           <td></td><td></td>

  463.         </tr>

  464.       </table>

  465.   </td>

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

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

  468.   </tr>

  469. </table>

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

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

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

  473.   <table class="params">

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

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

  476.   </table>

  477.   </dd>

  478. </dl>

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

  480. 

  481. </div>

  482. </div>

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

  484. <div class="memitem">

  485. <div class="memproto">

  486. <table class="mlabels">

  487.   <tr>

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

  489.       <table class="memname">

  490.         <tr>

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

  492.           <td>(</td>

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

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

  495.         </tr>

  496.         <tr>

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

  498.           <td></td>

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

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

  501.         </tr>

  502.         <tr>

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

  504.           <td></td>

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

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

  507.         </tr>

  508.         <tr>

  509.           <td></td>

  510.           <td>)</td>

  511.           <td></td><td></td>

  512.         </tr>

  513.       </table>

  514.   </td>

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

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

  517.   </tr>

  518. </table>

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

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

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

  522.   <table class="params">

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

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

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

  526.   </table>

  527.   </dd>

  528. </dl>

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

  530. 

  531. </div>

  532. </div>

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

  534. <div class="memitem">

  535. <div class="memproto">

  536. <table class="mlabels">

  537.   <tr>

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

  539.       <table class="memname">

  540.         <tr>

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

  542.           <td>(</td>

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

  544.           <td> const</td>

  545.         </tr>

  546.       </table>

  547.   </td>

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

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

  550.   </tr>

  551. </table>

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

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

  554. 

  555. </div>

  556. </div>

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

  558. <div class="memitem">

  559. <div class="memproto">

  560. <table class="mlabels">

  561.   <tr>

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

  563.       <table class="memname">

  564.         <tr>

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

  566.           <td>(</td>

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

  568.           <td> const</td>

  569.         </tr>

  570.       </table>

  571.   </td>

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

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

  574.   </tr>

  575. </table>

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

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

  578. 

  579. </div>

  580. </div>

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

  582. <div class="memitem">

  583. <div class="memproto">

  584. <table class="mlabels">

  585.   <tr>

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

  587.       <table class="memname">

  588.         <tr>

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

  590.           <td>(</td>

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

  592.           <td></td>

  593.         </tr>

  594.       </table>

  595.   </td>

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

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

  598.   </tr>

  599. </table>

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

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

  602. 

  603. </div>

  604. </div>

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

  606. <div class="memitem">

  607. <div class="memproto">

  608. <table class="mlabels">

  609.   <tr>

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

  611.       <table class="memname">

  612.         <tr>

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

  614.           <td>(</td>

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

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

  617.           <td></td>

  618.         </tr>

  619.       </table>

  620.   </td>

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

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

  623.   </tr>

  624. </table>

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

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

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

  628.   <table class="params">

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

  630.   </table>

  631.   </dd>

  632. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  647. 

  648. </div>

  649. </div>

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

  651. <div class="memitem">

  652. <div class="memproto">

  653. <table class="mlabels">

  654.   <tr>

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

  656.       <table class="memname">

  657.         <tr>

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

  659.           <td>(</td>

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

  661.           <td></td>

  662.         </tr>

  663.       </table>

  664.   </td>

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

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

  667.   </tr>

  668. </table>

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

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

  671. 

  672. </div>

  673. </div>

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

  675. <div class="memitem">

  676. <div class="memproto">

  677. <table class="mlabels">

  678.   <tr>

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

  680.       <table class="memname">

  681.         <tr>

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

  683.           <td>(</td>

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

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

  686.           <td></td>

  687.         </tr>

  688.       </table>

  689.   </td>

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

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

  692.   </tr>

  693. </table>

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

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

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

  697.   <table class="params">

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

  699.   </table>

  700.   </dd>

  701. </dl>

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

  703. 

  704. </div>

  705. </div>

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

  707. <div class="memitem">

  708. <div class="memproto">

  709. <table class="mlabels">

  710.   <tr>

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

  712.       <table class="memname">

  713.         <tr>

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

  715.           <td>(</td>

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

  717.           <td></td>

  718.         </tr>

  719.       </table>

  720.   </td>

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

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

  723.   </tr>

  724. </table>

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

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

  727. 

  728. </div>

  729. </div>

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

  731. <div class="memitem">

  732. <div class="memproto">

  733. <table class="mlabels">

  734.   <tr>

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

  736.       <table class="memname">

  737.         <tr>

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

  739.           <td>(</td>

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

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

  742.         </tr>

  743.         <tr>

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

  745.           <td></td>

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

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

  748.         </tr>

  749.         <tr>

  750.           <td></td>

  751.           <td>)</td>

  752.           <td></td><td></td>

  753.         </tr>

  754.       </table>

  755.   </td>

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

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

  758.   </tr>

  759. </table>

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

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

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

  763.   <table class="params">

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

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

  766.   </table>

  767.   </dd>

  768. </dl>

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

  770. 

  771. </div>

  772. </div>

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

  774. <div class="memitem">

  775. <div class="memproto">

  776. <table class="mlabels">

  777.   <tr>

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

  779.       <table class="memname">

  780.         <tr>

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

  782.           <td>(</td>

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

  784.           <td></td>

  785.         </tr>

  786.       </table>

  787.   </td>

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

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

  790.   </tr>

  791. </table>

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

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

  794. 

  795. </div>

  796. </div>

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

  798. <div class="memitem">

  799. <div class="memproto">

  800. <table class="mlabels">

  801.   <tr>

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

  803.       <table class="memname">

  804.         <tr>

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

  806.           <td>(</td>

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

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

  809.         </tr>

  810.         <tr>

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

  812.           <td></td>

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

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

  815.         </tr>

  816.         <tr>

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

  818.           <td></td>

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

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

  821.         </tr>

  822.         <tr>

  823.           <td></td>

  824.           <td>)</td>

  825.           <td></td><td></td>

  826.         </tr>

  827.       </table>

  828.   </td>

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

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

  831.   </tr>

  832. </table>

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

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

  835.   <table class="params">

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

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

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

  839.   </table>

  840.   </dd>

  841. </dl>

  842. 

  843. </div>

  844. </div>

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

  846. <div class="memitem">

  847. <div class="memproto">

  848. <table class="mlabels">

  849.   <tr>

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

  851.       <table class="memname">

  852.         <tr>

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

  854.           <td>(</td>

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

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

  857.           <td></td>

  858.         </tr>

  859.       </table>

  860.   </td>

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

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

  863.   </tr>

  864. </table>

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

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

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

  868.   <table class="params">

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

  870.   </table>

  871.   </dd>

  872. </dl>

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

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

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

  876. 

  877. </div>

  878. </div>

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

  880. <div class="memitem">

  881. <div class="memproto">

  882. <table class="mlabels">

  883.   <tr>

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

  885.       <table class="memname">

  886.         <tr>

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

  888.           <td>(</td>

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

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

  891.         </tr>

  892.         <tr>

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

  894.           <td></td>

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

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

  897.         </tr>

  898.         <tr>

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

  900.           <td></td>

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

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

  903.         </tr>

  904.         <tr>

  905.           <td></td>

  906.           <td>)</td>

  907.           <td></td><td></td>

  908.         </tr>

  909.       </table>

  910.   </td>

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

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

  913.   </tr>

  914. </table>

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

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

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

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

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

  920.   <table class="params">

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

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

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

  924.   </table>

  925.   </dd>

  926. </dl>

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

  928. 

  929. </div>

  930. </div>

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

  932. <div class="memitem">

  933. <div class="memproto">

  934. <table class="mlabels">

  935.   <tr>

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

  937.       <table class="memname">

  938.         <tr>

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

  940.           <td>(</td>

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

  942.           <td> const</td>

  943.         </tr>

  944.       </table>

  945.   </td>

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

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

  948.   </tr>

  949. </table>

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

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

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

  953. 

  954. </div>

  955. </div>

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

  957. <div class="memitem">

  958. <div class="memproto">

  959. <table class="mlabels">

  960.   <tr>

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

  962.       <table class="memname">

  963.         <tr>

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

  965.           <td>(</td>

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

  967.           <td> const</td>

  968.         </tr>

  969.       </table>

  970.   </td>

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

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

  973.   </tr>

  974. </table>

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

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

  977. 

  978. </div>

  979. </div>

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

  981. <div class="memitem">

  982. <div class="memproto">

  983. <table class="mlabels">

  984.   <tr>

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

  986.       <table class="memname">

  987.         <tr>

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

  989.           <td>(</td>

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

  991.           <td> const</td>

  992.         </tr>

  993.       </table>

  994.   </td>

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

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

  997.   </tr>

  998. </table>

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

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

  1001. 

  1002. </div>

  1003. </div>

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

  1005. <div class="memitem">

  1006. <div class="memproto">

  1007. <table class="mlabels">

  1008.   <tr>

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

  1010.       <table class="memname">

  1011.         <tr>

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

  1013.           <td>(</td>

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

  1015.           <td></td>

  1016.         </tr>

  1017.       </table>

  1018.   </td>

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

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

  1021.   </tr>

  1022. </table>

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

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

  1025. 

  1026. </div>

  1027. </div>

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

  1029. <div class="memitem">

  1030. <div class="memproto">

  1031. <table class="mlabels">

  1032.   <tr>

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

  1034.       <table class="memname">

  1035.         <tr>

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

  1037.           <td>(</td>

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

  1039.           <td></td>

  1040.         </tr>

  1041.       </table>

  1042.   </td>

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

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

  1045.   </tr>

  1046. </table>

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

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

  1049. 

  1050. </div>

  1051. </div>

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

  1053. <div class="memitem">

  1054. <div class="memproto">

  1055. <table class="mlabels">

  1056.   <tr>

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

  1058.       <table class="memname">

  1059.         <tr>

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

  1061.           <td>(</td>

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

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

  1064.         </tr>

  1065.         <tr>

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

  1067.           <td></td>

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

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

  1070.         </tr>

  1071.         <tr>

  1072.           <td></td>

  1073.           <td>)</td>

  1074.           <td></td><td></td>

  1075.         </tr>

  1076.       </table>

  1077.   </td>

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

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

  1080.   </tr>

  1081. </table>

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

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

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

  1085.   <table class="params">

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

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

  1088.   </table>

  1089.   </dd>

  1090. </dl>

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

  1092. 

  1093. </div>

  1094. </div>

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

  1096. <div class="memitem">

  1097. <div class="memproto">

  1098. <table class="mlabels">

  1099.   <tr>

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

  1101.       <table class="memname">

  1102.         <tr>

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

  1104.           <td>(</td>

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

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

  1107.           <td></td>

  1108.         </tr>

  1109.       </table>

  1110.   </td>

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

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

  1113.   </tr>

  1114. </table>

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

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

  1117.   <table class="params">

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

  1119.   </table>

  1120.   </dd>

  1121. </dl>

  1122. 

  1123. </div>

  1124. </div>

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

  1126. <div class="memitem">

  1127. <div class="memproto">

  1128. <table class="mlabels">

  1129.   <tr>

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

  1131.       <table class="memname">

  1132.         <tr>

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

  1134.           <td>(</td>

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

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

  1137.           <td></td>

  1138.         </tr>

  1139.       </table>

  1140.   </td>

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

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

  1143.   </tr>

  1144. </table>

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

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

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

  1148.   <table class="params">

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

  1150.   </table>

  1151.   </dd>

  1152. </dl>

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

  1154. 

  1155. </div>

  1156. </div>

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

  1158. <div class="memitem">

  1159. <div class="memproto">

  1160. <table class="mlabels">

  1161.   <tr>

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

  1163.       <table class="memname">

  1164.         <tr>

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

  1166.           <td>(</td>

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

  1168.           <td></td>

  1169.         </tr>

  1170.       </table>

  1171.   </td>

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

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

  1174.   </tr>

  1175. </table>

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

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

  1178. 

  1179. </div>

  1180. </div>

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

  1182. <div class="memitem">

  1183. <div class="memproto">

  1184. <table class="mlabels">

  1185.   <tr>

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

  1187.       <table class="memname">

  1188.         <tr>

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

  1190.           <td>(</td>

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

  1192.           <td> const</td>

  1193.         </tr>

  1194.       </table>

  1195.   </td>

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

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

  1198.   </tr>

  1199. </table>

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

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

  1202. 

  1203. </div>

  1204. </div>

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

  1206. <div class="memitem">

  1207. <div class="memproto">

  1208. <table class="mlabels">

  1209.   <tr>

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

  1211.       <table class="memname">

  1212.         <tr>

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

  1214.           <td>(</td>

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

  1216.           <td> const</td>

  1217.         </tr>

  1218.       </table>

  1219.   </td>

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

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

  1222.   </tr>

  1223. </table>

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

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

  1226. 

  1227. </div>

  1228. </div>

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

  1230. <div class="memitem">

  1231. <div class="memproto">

  1232. <table class="mlabels">

  1233.   <tr>

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

  1235.       <table class="memname">

  1236.         <tr>

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

  1238.           <td>(</td>

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

  1240.           <td> const</td>

  1241.         </tr>

  1242.       </table>

  1243.   </td>

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

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

  1246.   </tr>

  1247. </table>

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

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

  1250. 

  1251. </div>

  1252. </div>

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

  1254. <div class="memitem">

  1255. <div class="memproto">

  1256. <table class="mlabels">

  1257.   <tr>

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

  1259.       <table class="memname">

  1260.         <tr>

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

  1262.           <td>(</td>

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

  1264.           <td> const</td>

  1265.         </tr>

  1266.       </table>

  1267.   </td>

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

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

  1270.   </tr>

  1271. </table>

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

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

  1274. 

  1275. </div>

  1276. </div>

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

  1278. <div class="memitem">

  1279. <div class="memproto">

  1280. <table class="mlabels">

  1281.   <tr>

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

  1283.       <table class="memname">

  1284.         <tr>

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

  1286.           <td>(</td>

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

  1288.           <td> const</td>

  1289.         </tr>

  1290.       </table>

  1291.   </td>

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

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

  1294.   </tr>

  1295. </table>

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

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

  1298. 

  1299. </div>

  1300. </div>

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

  1302. <div class="memitem">

  1303. <div class="memproto">

  1304. <table class="mlabels">

  1305.   <tr>

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

  1307.       <table class="memname">

  1308.         <tr>

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

  1310.           <td>(</td>

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

  1312.           <td> const</td>

  1313.         </tr>

  1314.       </table>

  1315.   </td>

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

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

  1318.   </tr>

  1319. </table>

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

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

  1322. 

  1323. </div>

  1324. </div>

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

  1326. <div class="memitem">

  1327. <div class="memproto">

  1328. <table class="mlabels">

  1329.   <tr>

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

  1331.       <table class="memname">

  1332.         <tr>

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

  1334.           <td>(</td>

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

  1336.           <td> const</td>

  1337.         </tr>

  1338.       </table>

  1339.   </td>

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

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

  1342.   </tr>

  1343. </table>

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

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

  1346. 

  1347. </div>

  1348. </div>

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

  1350. <div class="memitem">

  1351. <div class="memproto">

  1352. <table class="mlabels">

  1353.   <tr>

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

  1355.       <table class="memname">

  1356.         <tr>

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

  1358.           <td>(</td>

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

  1360.           <td> const</td>

  1361.         </tr>

  1362.       </table>

  1363.   </td>

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

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

  1366.   </tr>

  1367. </table>

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

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

  1370. 

  1371. </div>

  1372. </div>

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

  1374. <div class="memitem">

  1375. <div class="memproto">

  1376. <table class="mlabels">

  1377.   <tr>

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

  1379.       <table class="memname">

  1380.         <tr>

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

  1382.           <td>(</td>

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

  1384.           <td> const</td>

  1385.         </tr>

  1386.       </table>

  1387.   </td>

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

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

  1390.   </tr>

  1391. </table>

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

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

  1394. 

  1395. </div>

  1396. </div>

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

  1398. <div class="memitem">

  1399. <div class="memproto">

  1400. <table class="mlabels">

  1401.   <tr>

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

  1403.       <table class="memname">

  1404.         <tr>

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

  1406.           <td>(</td>

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

  1408.           <td> const</td>

  1409.         </tr>

  1410.       </table>

  1411.   </td>

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

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

  1414.   </tr>

  1415. </table>

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

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

  1418. 

  1419. </div>

  1420. </div>

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

  1422. <div class="memitem">

  1423. <div class="memproto">

  1424. <table class="mlabels">

  1425.   <tr>

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

  1427.       <table class="memname">

  1428.         <tr>

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

  1430.           <td>(</td>

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

  1432.           <td> const</td>

  1433.         </tr>

  1434.       </table>

  1435.   </td>

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

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

  1438.   </tr>

  1439. </table>

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

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

  1442. 

  1443. </div>

  1444. </div>

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

  1446. <div class="memitem">

  1447. <div class="memproto">

  1448. <table class="mlabels">

  1449.   <tr>

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

  1451.       <table class="memname">

  1452.         <tr>

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

  1454.           <td>(</td>

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

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

  1457.           <td></td>

  1458.         </tr>

  1459.       </table>

  1460.   </td>

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

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

  1463.   </tr>

  1464. </table>

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

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

  1467.   <table class="params">

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

  1469.   </table>

  1470.   </dd>

  1471. </dl>

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

  1473. 

  1474. </div>

  1475. </div>

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

  1477. <div class="memitem">

  1478. <div class="memproto">

  1479. <table class="mlabels">

  1480.   <tr>

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

  1482.       <table class="memname">

  1483.         <tr>

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

  1485.           <td>(</td>

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

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

  1488.           <td></td>

  1489.         </tr>

  1490.       </table>

  1491.   </td>

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

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

  1494.   </tr>

  1495. </table>

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

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

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

  1499.   <table class="params">

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

  1501.   </table>

  1502.   </dd>

  1503. </dl>

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

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

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

  1507. 

  1508. </div>

  1509. </div>

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

  1511. <div class="memitem">

  1512. <div class="memproto">

  1513. <table class="mlabels">

  1514.   <tr>

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

  1516.       <table class="memname">

  1517.         <tr>

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

  1519.           <td>(</td>

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

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

  1522.         </tr>

  1523.         <tr>

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

  1525.           <td></td>

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

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

  1528.         </tr>

  1529.         <tr>

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

  1531.           <td></td>

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

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

  1534.         </tr>

  1535.         <tr>

  1536.           <td></td>

  1537.           <td>)</td>

  1538.           <td></td><td></td>

  1539.         </tr>

  1540.       </table>

  1541.   </td>

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

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

  1544.   </tr>

  1545. </table>

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

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

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

  1549.   <table class="params">

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

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

  1552.   </table>

  1553.   </dd>

  1554. </dl>

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

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

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

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

  1559.   <table class="params">

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

  1561.   </table>

  1562.   </dd>

  1563. </dl>

  1564. 

  1565. </div>

  1566. </div>

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

  1568. <div class="memitem">

  1569. <div class="memproto">

  1570. <table class="mlabels">

  1571.   <tr>

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

  1573.       <table class="memname">

  1574.         <tr>

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

  1576.           <td>(</td>

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

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

  1579.         </tr>

  1580.         <tr>

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

  1582.           <td></td>

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

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

  1585.         </tr>

  1586.         <tr>

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

  1588.           <td></td>

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

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

  1591.         </tr>

  1592.         <tr>

  1593.           <td></td>

  1594.           <td>)</td>

  1595.           <td></td><td></td>

  1596.         </tr>

  1597.       </table>

  1598.   </td>

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

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

  1601.   </tr>

  1602. </table>

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

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

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

  1606.   <table class="params">

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

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

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

  1610.   </table>

  1611.   </dd>

  1612. </dl>

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

  1614. 

  1615. </div>

  1616. </div>

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

  1618. <div class="memitem">

  1619. <div class="memproto">

  1620. <table class="mlabels">

  1621.   <tr>

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

  1623.       <table class="memname">

  1624.         <tr>

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

  1626.           <td>(</td>

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

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

  1629.         </tr>

  1630.         <tr>

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

  1632.           <td></td>

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

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

  1635.         </tr>

  1636.         <tr>

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

  1638.           <td></td>

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

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

  1641.         </tr>

  1642.         <tr>

  1643.           <td></td>

  1644.           <td>)</td>

  1645.           <td></td><td></td>

  1646.         </tr>

  1647.       </table>

  1648.   </td>

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

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

  1651.   </tr>

  1652. </table>

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

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

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

  1656.   <table class="params">

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

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

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

  1660.   </table>

  1661.   </dd>

  1662. </dl>

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

  1664. 

  1665. </div>

  1666. </div>

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

  1668. <div class="memitem">

  1669. <div class="memproto">

  1670. <table class="mlabels">

  1671.   <tr>

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

  1673.       <table class="memname">

  1674.         <tr>

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

  1676.           <td>(</td>

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

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

  1679.         </tr>

  1680.         <tr>

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

  1682.           <td></td>

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

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

  1685.         </tr>

  1686.         <tr>

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

  1688.           <td></td>

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

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

  1691.         </tr>

  1692.         <tr>

  1693.           <td></td>

  1694.           <td>)</td>

  1695.           <td></td><td></td>

  1696.         </tr>

  1697.       </table>

  1698.   </td>

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

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

  1701.   </tr>

  1702. </table>

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

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

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

  1706.   <table class="params">

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

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

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

  1710.   </table>

  1711.   </dd>

  1712. </dl>

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

  1714. 

  1715. </div>

  1716. </div>

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

  1718. <div class="memitem">

  1719. <div class="memproto">

  1720. <table class="mlabels">

  1721.   <tr>

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

  1723.       <table class="memname">

  1724.         <tr>

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

  1726.           <td>(</td>

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

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

  1729.         </tr>

  1730.         <tr>

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

  1732.           <td></td>

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

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

  1735.         </tr>

  1736.         <tr>

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

  1738.           <td></td>

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

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

  1741.         </tr>

  1742.         <tr>

  1743.           <td></td>

  1744.           <td>)</td>

  1745.           <td></td><td></td>

  1746.         </tr>

  1747.       </table>

  1748.   </td>

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

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

  1751.   </tr>

  1752. </table>

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

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

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

  1756.   <table class="params">

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

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

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

  1760.   </table>

  1761.   </dd>

  1762. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1777. 

  1778. </div>

  1779. </div>

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

  1781. <div class="memitem">

  1782. <div class="memproto">

  1783. <table class="mlabels">

  1784.   <tr>

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

  1786.       <table class="memname">

  1787.         <tr>

  1788.           <td class="memname">bool FatFile::open </td>

  1789.           <td>(</td>

  1790.           <td class="paramtype">const char *&#160;</td>

  1791.           <td class="paramname"><em>path</em>, </td>

  1792.         </tr>

  1793.         <tr>

  1794.           <td class="paramkey"></td>

  1795.           <td></td>

  1796.           <td class="paramtype">uint8_t&#160;</td>

  1797.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1798.         </tr>

  1799.         <tr>

  1800.           <td></td>

  1801.           <td>)</td>

  1802.           <td></td><td></td>

  1803.         </tr>

  1804.       </table>

  1805.   </td>

  1806.   <td class="mlabels-right">

  1807. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1808.   </tr>

  1809. </table>

  1810. </div><div class="memdoc">

  1811. <p>Open a file in the current working directory.</p>

  1812. <dl class="params"><dt>Parameters</dt><dd>

  1813.   <table class="params">

  1814.     <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>

  1815.     <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>

  1816.   </table>

  1817.   </dd>

  1818. </dl>

  1819. <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>

  1820. 

  1821. </div>

  1822. </div>

  1823. <a class="anchor" id="a8034c4649eb0d26715b1a8a69e73d9d0"></a>

  1824. <div class="memitem">

  1825. <div class="memproto">

  1826. <table class="mlabels">

  1827.   <tr>

  1828.   <td class="mlabels-left">

  1829.       <table class="memname">

  1830.         <tr>

  1831.           <td class="memname">bool FatFile::openNext </td>

  1832.           <td>(</td>

  1833.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1834.           <td class="paramname"><em>dirFile</em>, </td>

  1835.         </tr>

  1836.         <tr>

  1837.           <td class="paramkey"></td>

  1838.           <td></td>

  1839.           <td class="paramtype">uint8_t&#160;</td>

  1840.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1841.         </tr>

  1842.         <tr>

  1843.           <td></td>

  1844.           <td>)</td>

  1845.           <td></td><td></td>

  1846.         </tr>

  1847.       </table>

  1848.   </td>

  1849.   <td class="mlabels-right">

  1850. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1851.   </tr>

  1852. </table>

  1853. </div><div class="memdoc">

  1854. <p>Open the next file or subdirectory in a directory.</p>

  1855. <dl class="params"><dt>Parameters</dt><dd>

  1856.   <table class="params">

  1857.     <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>

  1858.     <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>

  1859.   </table>

  1860.   </dd>

  1861. </dl>

  1862. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1863. 

  1864. </div>

  1865. </div>

  1866. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1867. <div class="memitem">

  1868. <div class="memproto">

  1869. <table class="mlabels">

  1870.   <tr>

  1871.   <td class="mlabels-left">

  1872.       <table class="memname">

  1873.         <tr>

  1874.           <td class="memname">bool FatFile::openRoot </td>

  1875.           <td>(</td>

  1876.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1877.           <td class="paramname"><em>vol</em></td><td>)</td>

  1878.           <td></td>

  1879.         </tr>

  1880.       </table>

  1881.   </td>

  1882.   <td class="mlabels-right">

  1883. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1884.   </tr>

  1885. </table>

  1886. </div><div class="memdoc">

  1887. <p>Open a volume's root directory.</p>

  1888. <dl class="params"><dt>Parameters</dt><dd>

  1889.   <table class="params">

  1890.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1891.   </table>

  1892.   </dd>

  1893. </dl>

  1894. <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>

  1895. 

  1896. </div>

  1897. </div>

  1898. <a class="anchor" id="a3a2a66f4a0cb69ab4edc66d39997fda7"></a>

  1899. <div class="memitem">

  1900. <div class="memproto">

  1901. <table class="mlabels">

  1902.   <tr>

  1903.   <td class="mlabels-left">

  1904.       <table class="memname">

  1905.         <tr>

  1906.           <td class="memname">int PrintFile::peek </td>

  1907.           <td>(</td>

  1908.           <td class="paramname"></td><td>)</td>

  1909.           <td></td>

  1910.         </tr>

  1911.       </table>

  1912.   </td>

  1913.   <td class="mlabels-right">

  1914. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1915.   </tr>

  1916. </table>

  1917. </div><div class="memdoc">

  1918. <p>Return the next available byte without consuming it.</p>

  1919. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1920. 

  1921. </div>

  1922. </div>

  1923. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1924. <div class="memitem">

  1925. <div class="memproto">

  1926. <table class="mlabels">

  1927.   <tr>

  1928.   <td class="mlabels-left">

  1929.       <table class="memname">

  1930.         <tr>

  1931.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1932.           <td>(</td>

  1933.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1934.           <td class="paramname"><em>pr</em></td><td>)</td>

  1935.           <td></td>

  1936.         </tr>

  1937.       </table>

  1938.   </td>

  1939.   <td class="mlabels-right">

  1940. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1941.   </tr>

  1942. </table>

  1943. </div><div class="memdoc">

  1944. <p>Print a file's creation date and time</p>

  1945. <dl class="params"><dt>Parameters</dt><dd>

  1946.   <table class="params">

  1947.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1948.   </table>

  1949.   </dd>

  1950. </dl>

  1951. <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>

  1952. 

  1953. </div>

  1954. </div>

  1955. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1956. <div class="memitem">

  1957. <div class="memproto">

  1958. <table class="mlabels">

  1959.   <tr>

  1960.   <td class="mlabels-left">

  1961.       <table class="memname">

  1962.         <tr>

  1963.           <td class="memname">static void FatFile::printFatDate </td>

  1964.           <td>(</td>

  1965.           <td class="paramtype">uint16_t&#160;</td>

  1966.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1967.           <td></td>

  1968.         </tr>

  1969.       </table>

  1970.   </td>

  1971.   <td class="mlabels-right">

  1972. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1973.   </tr>

  1974. </table>

  1975. </div><div class="memdoc">

  1976. <p>Print a directory date field.</p>

  1977. <p>Format is yyyy-mm-dd.</p>

  1978. <dl class="params"><dt>Parameters</dt><dd>

  1979.   <table class="params">

  1980.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1981.   </table>

  1982.   </dd>

  1983. </dl>

  1984. 

  1985. </div>

  1986. </div>

  1987. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1988. <div class="memitem">

  1989. <div class="memproto">

  1990. <table class="mlabels">

  1991.   <tr>

  1992.   <td class="mlabels-left">

  1993.       <table class="memname">

  1994.         <tr>

  1995.           <td class="memname">void FatFile::printFatDate </td>

  1996.           <td>(</td>

  1997.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1998.           <td class="paramname"><em>pr</em>, </td>

  1999.         </tr>

  2000.         <tr>

  2001.           <td class="paramkey"></td>

  2002.           <td></td>

  2003.           <td class="paramtype">uint16_t&#160;</td>

  2004.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2005.         </tr>

  2006.         <tr>

  2007.           <td></td>

  2008.           <td>)</td>

  2009.           <td></td><td></td>

  2010.         </tr>

  2011.       </table>

  2012.   </td>

  2013.   <td class="mlabels-right">

  2014. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2015.   </tr>

  2016. </table>

  2017. </div><div class="memdoc">

  2018. <p>Print a directory date field.</p>

  2019. <p>Format is yyyy-mm-dd.</p>

  2020. <dl class="params"><dt>Parameters</dt><dd>

  2021.   <table class="params">

  2022.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2023.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2024.   </table>

  2025.   </dd>

  2026. </dl>

  2027. 

  2028. </div>

  2029. </div>

  2030. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2031. <div class="memitem">

  2032. <div class="memproto">

  2033. <table class="mlabels">

  2034.   <tr>

  2035.   <td class="mlabels-left">

  2036.       <table class="memname">

  2037.         <tr>

  2038.           <td class="memname">static void FatFile::printFatTime </td>

  2039.           <td>(</td>

  2040.           <td class="paramtype">uint16_t&#160;</td>

  2041.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2042.           <td></td>

  2043.         </tr>

  2044.       </table>

  2045.   </td>

  2046.   <td class="mlabels-right">

  2047. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2048.   </tr>

  2049. </table>

  2050. </div><div class="memdoc">

  2051. <p>Print a directory time field.</p>

  2052. <p>Format is hh:mm:ss.</p>

  2053. <dl class="params"><dt>Parameters</dt><dd>

  2054.   <table class="params">

  2055.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2056.   </table>

  2057.   </dd>

  2058. </dl>

  2059. 

  2060. </div>

  2061. </div>

  2062. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2063. <div class="memitem">

  2064. <div class="memproto">

  2065. <table class="mlabels">

  2066.   <tr>

  2067.   <td class="mlabels-left">

  2068.       <table class="memname">

  2069.         <tr>

  2070.           <td class="memname">void FatFile::printFatTime </td>

  2071.           <td>(</td>

  2072.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2073.           <td class="paramname"><em>pr</em>, </td>

  2074.         </tr>

  2075.         <tr>

  2076.           <td class="paramkey"></td>

  2077.           <td></td>

  2078.           <td class="paramtype">uint16_t&#160;</td>

  2079.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2080.         </tr>

  2081.         <tr>

  2082.           <td></td>

  2083.           <td>)</td>

  2084.           <td></td><td></td>

  2085.         </tr>

  2086.       </table>

  2087.   </td>

  2088.   <td class="mlabels-right">

  2089. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2090.   </tr>

  2091. </table>

  2092. </div><div class="memdoc">

  2093. <p>Print a directory time field.</p>

  2094. <p>Format is hh:mm:ss.</p>

  2095. <dl class="params"><dt>Parameters</dt><dd>

  2096.   <table class="params">

  2097.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2098.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2099.   </table>

  2100.   </dd>

  2101. </dl>

  2102. 

  2103. </div>

  2104. </div>

  2105. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2106. <div class="memitem">

  2107. <div class="memproto">

  2108. <table class="mlabels">

  2109.   <tr>

  2110.   <td class="mlabels-left">

  2111.       <table class="memname">

  2112.         <tr>

  2113.           <td class="memname">int FatFile::printField </td>

  2114.           <td>(</td>

  2115.           <td class="paramtype">float&#160;</td>

  2116.           <td class="paramname"><em>value</em>, </td>

  2117.         </tr>

  2118.         <tr>

  2119.           <td class="paramkey"></td>

  2120.           <td></td>

  2121.           <td class="paramtype">char&#160;</td>

  2122.           <td class="paramname"><em>term</em>, </td>

  2123.         </tr>

  2124.         <tr>

  2125.           <td class="paramkey"></td>

  2126.           <td></td>

  2127.           <td class="paramtype">uint8_t&#160;</td>

  2128.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2129.         </tr>

  2130.         <tr>

  2131.           <td></td>

  2132.           <td>)</td>

  2133.           <td></td><td></td>

  2134.         </tr>

  2135.       </table>

  2136.   </td>

  2137.   <td class="mlabels-right">

  2138. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2139.   </tr>

  2140. </table>

  2141. </div><div class="memdoc">

  2142. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2143.   <table class="params">

  2144.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2145.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2146.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2147.   </table>

  2148.   </dd>

  2149. </dl>

  2150. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2151. 

  2152. </div>

  2153. </div>

  2154. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2155. <div class="memitem">

  2156. <div class="memproto">

  2157. <table class="mlabels">

  2158.   <tr>

  2159.   <td class="mlabels-left">

  2160.       <table class="memname">

  2161.         <tr>

  2162.           <td class="memname">int FatFile::printField </td>

  2163.           <td>(</td>

  2164.           <td class="paramtype">int16_t&#160;</td>

  2165.           <td class="paramname"><em>value</em>, </td>

  2166.         </tr>

  2167.         <tr>

  2168.           <td class="paramkey"></td>

  2169.           <td></td>

  2170.           <td class="paramtype">char&#160;</td>

  2171.           <td class="paramname"><em>term</em>&#160;</td>

  2172.         </tr>

  2173.         <tr>

  2174.           <td></td>

  2175.           <td>)</td>

  2176.           <td></td><td></td>

  2177.         </tr>

  2178.       </table>

  2179.   </td>

  2180.   <td class="mlabels-right">

  2181. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2182.   </tr>

  2183. </table>

  2184. </div><div class="memdoc">

  2185. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2186.   <table class="params">

  2187.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2188.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2189.   </table>

  2190.   </dd>

  2191. </dl>

  2192. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2193. 

  2194. </div>

  2195. </div>

  2196. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2197. <div class="memitem">

  2198. <div class="memproto">

  2199. <table class="mlabels">

  2200.   <tr>

  2201.   <td class="mlabels-left">

  2202.       <table class="memname">

  2203.         <tr>

  2204.           <td class="memname">int FatFile::printField </td>

  2205.           <td>(</td>

  2206.           <td class="paramtype">uint16_t&#160;</td>

  2207.           <td class="paramname"><em>value</em>, </td>

  2208.         </tr>

  2209.         <tr>

  2210.           <td class="paramkey"></td>

  2211.           <td></td>

  2212.           <td class="paramtype">char&#160;</td>

  2213.           <td class="paramname"><em>term</em>&#160;</td>

  2214.         </tr>

  2215.         <tr>

  2216.           <td></td>

  2217.           <td>)</td>

  2218.           <td></td><td></td>

  2219.         </tr>

  2220.       </table>

  2221.   </td>

  2222.   <td class="mlabels-right">

  2223. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2224.   </tr>

  2225. </table>

  2226. </div><div class="memdoc">

  2227. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2228.   <table class="params">

  2229.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2230.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2231.   </table>

  2232.   </dd>

  2233. </dl>

  2234. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2235. 

  2236. </div>

  2237. </div>

  2238. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2239. <div class="memitem">

  2240. <div class="memproto">

  2241. <table class="mlabels">

  2242.   <tr>

  2243.   <td class="mlabels-left">

  2244.       <table class="memname">

  2245.         <tr>

  2246.           <td class="memname">int FatFile::printField </td>

  2247.           <td>(</td>

  2248.           <td class="paramtype">int32_t&#160;</td>

  2249.           <td class="paramname"><em>value</em>, </td>

  2250.         </tr>

  2251.         <tr>

  2252.           <td class="paramkey"></td>

  2253.           <td></td>

  2254.           <td class="paramtype">char&#160;</td>

  2255.           <td class="paramname"><em>term</em>&#160;</td>

  2256.         </tr>

  2257.         <tr>

  2258.           <td></td>

  2259.           <td>)</td>

  2260.           <td></td><td></td>

  2261.         </tr>

  2262.       </table>

  2263.   </td>

  2264.   <td class="mlabels-right">

  2265. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2266.   </tr>

  2267. </table>

  2268. </div><div class="memdoc">

  2269. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2270.   <table class="params">

  2271.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2272.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2273.   </table>

  2274.   </dd>

  2275. </dl>

  2276. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2277. 

  2278. </div>

  2279. </div>

  2280. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2281. <div class="memitem">

  2282. <div class="memproto">

  2283. <table class="mlabels">

  2284.   <tr>

  2285.   <td class="mlabels-left">

  2286.       <table class="memname">

  2287.         <tr>

  2288.           <td class="memname">int FatFile::printField </td>

  2289.           <td>(</td>

  2290.           <td class="paramtype">uint32_t&#160;</td>

  2291.           <td class="paramname"><em>value</em>, </td>

  2292.         </tr>

  2293.         <tr>

  2294.           <td class="paramkey"></td>

  2295.           <td></td>

  2296.           <td class="paramtype">char&#160;</td>

  2297.           <td class="paramname"><em>term</em>&#160;</td>

  2298.         </tr>

  2299.         <tr>

  2300.           <td></td>

  2301.           <td>)</td>

  2302.           <td></td><td></td>

  2303.         </tr>

  2304.       </table>

  2305.   </td>

  2306.   <td class="mlabels-right">

  2307. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2308.   </tr>

  2309. </table>

  2310. </div><div class="memdoc">

  2311. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2312.   <table class="params">

  2313.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2314.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2315.   </table>

  2316.   </dd>

  2317. </dl>

  2318. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2319. 

  2320. </div>

  2321. </div>

  2322. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2323. <div class="memitem">

  2324. <div class="memproto">

  2325. <table class="mlabels">

  2326.   <tr>

  2327.   <td class="mlabels-left">

  2328.       <table class="memname">

  2329.         <tr>

  2330.           <td class="memname">size_t FatFile::printFileSize </td>

  2331.           <td>(</td>

  2332.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2333.           <td class="paramname"><em>pr</em></td><td>)</td>

  2334.           <td></td>

  2335.         </tr>

  2336.       </table>

  2337.   </td>

  2338.   <td class="mlabels-right">

  2339. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2340.   </tr>

  2341. </table>

  2342. </div><div class="memdoc">

  2343. <p>Print a file's size.</p>

  2344. <dl class="params"><dt>Parameters</dt><dd>

  2345.   <table class="params">

  2346.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2347.   </table>

  2348.   </dd>

  2349. </dl>

  2350. <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>

  2351. 

  2352. </div>

  2353. </div>

  2354. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2355. <div class="memitem">

  2356. <div class="memproto">

  2357. <table class="mlabels">

  2358.   <tr>

  2359.   <td class="mlabels-left">

  2360.       <table class="memname">

  2361.         <tr>

  2362.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2363.           <td>(</td>

  2364.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2365.           <td class="paramname"><em>pr</em></td><td>)</td>

  2366.           <td></td>

  2367.         </tr>

  2368.       </table>

  2369.   </td>

  2370.   <td class="mlabels-right">

  2371. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2372.   </tr>

  2373. </table>

  2374. </div><div class="memdoc">

  2375. <p>Print a file's modify date and time</p>

  2376. <dl class="params"><dt>Parameters</dt><dd>

  2377.   <table class="params">

  2378.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2379.   </table>

  2380.   </dd>

  2381. </dl>

  2382. <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>

  2383. 

  2384. </div>

  2385. </div>

  2386. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2387. <div class="memitem">

  2388. <div class="memproto">

  2389. <table class="mlabels">

  2390.   <tr>

  2391.   <td class="mlabels-left">

  2392.       <table class="memname">

  2393.         <tr>

  2394.           <td class="memname">size_t FatFile::printName </td>

  2395.           <td>(</td>

  2396.           <td class="paramname"></td><td>)</td>

  2397.           <td></td>

  2398.         </tr>

  2399.       </table>

  2400.   </td>

  2401.   <td class="mlabels-right">

  2402. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2403.   </tr>

  2404. </table>

  2405. </div><div class="memdoc">

  2406. <p>Print a file's name.</p>

  2407. <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>

  2408. 

  2409. </div>

  2410. </div>

  2411. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2412. <div class="memitem">

  2413. <div class="memproto">

  2414. <table class="mlabels">

  2415.   <tr>

  2416.   <td class="mlabels-left">

  2417.       <table class="memname">

  2418.         <tr>

  2419.           <td class="memname">size_t FatFile::printName </td>

  2420.           <td>(</td>

  2421.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2422.           <td class="paramname"><em>pr</em></td><td>)</td>

  2423.           <td></td>

  2424.         </tr>

  2425.       </table>

  2426.   </td>

  2427.   <td class="mlabels-right">

  2428. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2429.   </tr>

  2430. </table>

  2431. </div><div class="memdoc">

  2432. <p>Print a file's name</p>

  2433. <dl class="params"><dt>Parameters</dt><dd>

  2434.   <table class="params">

  2435.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2436.   </table>

  2437.   </dd>

  2438. </dl>

  2439. <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>

  2440. 

  2441. </div>

  2442. </div>

  2443. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2444. <div class="memitem">

  2445. <div class="memproto">

  2446. <table class="mlabels">

  2447.   <tr>

  2448.   <td class="mlabels-left">

  2449.       <table class="memname">

  2450.         <tr>

  2451.           <td class="memname">size_t FatFile::printSFN </td>

  2452.           <td>(</td>

  2453.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2454.           <td class="paramname"><em>pr</em></td><td>)</td>

  2455.           <td></td>

  2456.         </tr>

  2457.       </table>

  2458.   </td>

  2459.   <td class="mlabels-right">

  2460. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2461.   </tr>

  2462. </table>

  2463. </div><div class="memdoc">

  2464. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2465. <dl class="params"><dt>Parameters</dt><dd>

  2466.   <table class="params">

  2467.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2468.   </table>

  2469.   </dd>

  2470. </dl>

  2471. <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>

  2472. 

  2473. </div>

  2474. </div>

  2475. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2476. <div class="memitem">

  2477. <div class="memproto">

  2478. <table class="mlabels">

  2479.   <tr>

  2480.   <td class="mlabels-left">

  2481.       <table class="memname">

  2482.         <tr>

  2483.           <td class="memname">int FatFile::read </td>

  2484.           <td>(</td>

  2485.           <td class="paramname"></td><td>)</td>

  2486.           <td></td>

  2487.         </tr>

  2488.       </table>

  2489.   </td>

  2490.   <td class="mlabels-right">

  2491. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2492.   </tr>

  2493. </table>

  2494. </div><div class="memdoc">

  2495. <p>Read the next byte from a file.</p>

  2496. <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>

  2497. 

  2498. </div>

  2499. </div>

  2500. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2501. <div class="memitem">

  2502. <div class="memproto">

  2503. <table class="mlabels">

  2504.   <tr>

  2505.   <td class="mlabels-left">

  2506.       <table class="memname">

  2507.         <tr>

  2508.           <td class="memname">int FatFile::read </td>

  2509.           <td>(</td>

  2510.           <td class="paramtype">void *&#160;</td>

  2511.           <td class="paramname"><em>buf</em>, </td>

  2512.         </tr>

  2513.         <tr>

  2514.           <td class="paramkey"></td>

  2515.           <td></td>

  2516.           <td class="paramtype">size_t&#160;</td>

  2517.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2518.         </tr>

  2519.         <tr>

  2520.           <td></td>

  2521.           <td>)</td>

  2522.           <td></td><td></td>

  2523.         </tr>

  2524.       </table>

  2525.   </td>

  2526.   <td class="mlabels-right">

  2527. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2528.   </tr>

  2529. </table>

  2530. </div><div class="memdoc">

  2531. <p>Read data from a file starting at the current position.</p>

  2532. <dl class="params"><dt>Parameters</dt><dd>

  2533.   <table class="params">

  2534.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2535.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2536.   </table>

  2537.   </dd>

  2538. </dl>

  2539. <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>

  2540. 

  2541. </div>

  2542. </div>

  2543. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2544. <div class="memitem">

  2545. <div class="memproto">

  2546. <table class="mlabels">

  2547.   <tr>

  2548.   <td class="mlabels-left">

  2549.       <table class="memname">

  2550.         <tr>

  2551.           <td class="memname">int8_t FatFile::readDir </td>

  2552.           <td>(</td>

  2553.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2554.           <td class="paramname"><em>dir</em></td><td>)</td>

  2555.           <td></td>

  2556.         </tr>

  2557.       </table>

  2558.   </td>

  2559.   <td class="mlabels-right">

  2560. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2561.   </tr>

  2562. </table>

  2563. </div><div class="memdoc">

  2564. <p>Read the next directory entry from a directory file.</p>

  2565. <dl class="params"><dt>Parameters</dt><dd>

  2566.   <table class="params">

  2567.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2568.   </table>

  2569.   </dd>

  2570. </dl>

  2571. <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>

  2572. 

  2573. </div>

  2574. </div>

  2575. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2576. <div class="memitem">

  2577. <div class="memproto">

  2578. <table class="mlabels">

  2579.   <tr>

  2580.   <td class="mlabels-left">

  2581.       <table class="memname">

  2582.         <tr>

  2583.           <td class="memname">bool FatFile::remove </td>

  2584.           <td>(</td>

  2585.           <td class="paramname"></td><td>)</td>

  2586.           <td></td>

  2587.         </tr>

  2588.       </table>

  2589.   </td>

  2590.   <td class="mlabels-right">

  2591. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2592.   </tr>

  2593. </table>

  2594. </div><div class="memdoc">

  2595. <p>Remove a file.</p>

  2596. <p>The directory entry and all data for the file are deleted.</p>

  2597. <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>

  2598. <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>

  2599. 

  2600. </div>

  2601. </div>

  2602. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2603. <div class="memitem">

  2604. <div class="memproto">

  2605. <table class="mlabels">

  2606.   <tr>

  2607.   <td class="mlabels-left">

  2608.       <table class="memname">

  2609.         <tr>

  2610.           <td class="memname">bool FatFile::remove </td>

  2611.           <td>(</td>

  2612.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2613.           <td class="paramname"><em>dirFile</em>, </td>

  2614.         </tr>

  2615.         <tr>

  2616.           <td class="paramkey"></td>

  2617.           <td></td>

  2618.           <td class="paramtype">const char *&#160;</td>

  2619.           <td class="paramname"><em>path</em>&#160;</td>

  2620.         </tr>

  2621.         <tr>

  2622.           <td></td>

  2623.           <td>)</td>

  2624.           <td></td><td></td>

  2625.         </tr>

  2626.       </table>

  2627.   </td>

  2628.   <td class="mlabels-right">

  2629. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2630.   </tr>

  2631. </table>

  2632. </div><div class="memdoc">

  2633. <p>Remove a file.</p>

  2634. <p>The directory entry and all data for the file are deleted.</p>

  2635. <dl class="params"><dt>Parameters</dt><dd>

  2636.   <table class="params">

  2637.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2638.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2639.   </table>

  2640.   </dd>

  2641. </dl>

  2642. <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>

  2643. <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>

  2644. 

  2645. </div>

  2646. </div>

  2647. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2648. <div class="memitem">

  2649. <div class="memproto">

  2650. <table class="mlabels">

  2651.   <tr>

  2652.   <td class="mlabels-left">

  2653.       <table class="memname">

  2654.         <tr>

  2655.           <td class="memname">bool FatFile::rename </td>

  2656.           <td>(</td>

  2657.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2658.           <td class="paramname"><em>dirFile</em>, </td>

  2659.         </tr>

  2660.         <tr>

  2661.           <td class="paramkey"></td>

  2662.           <td></td>

  2663.           <td class="paramtype">const char *&#160;</td>

  2664.           <td class="paramname"><em>newPath</em>&#160;</td>

  2665.         </tr>

  2666.         <tr>

  2667.           <td></td>

  2668.           <td>)</td>

  2669.           <td></td><td></td>

  2670.         </tr>

  2671.       </table>

  2672.   </td>

  2673.   <td class="mlabels-right">

  2674. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2675.   </tr>

  2676. </table>

  2677. </div><div class="memdoc">

  2678. <p>Rename a file or subdirectory.</p>

  2679. <dl class="params"><dt>Parameters</dt><dd>

  2680.   <table class="params">

  2681.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2682.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2683.   </table>

  2684.   </dd>

  2685. </dl>

  2686. <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>

  2687. 

  2688. </div>

  2689. </div>

  2690. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2691. <div class="memitem">

  2692. <div class="memproto">

  2693. <table class="mlabels">

  2694.   <tr>

  2695.   <td class="mlabels-left">

  2696.       <table class="memname">

  2697.         <tr>

  2698.           <td class="memname">void FatFile::rewind </td>

  2699.           <td>(</td>

  2700.           <td class="paramname"></td><td>)</td>

  2701.           <td></td>

  2702.         </tr>

  2703.       </table>

  2704.   </td>

  2705.   <td class="mlabels-right">

  2706. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2707.   </tr>

  2708. </table>

  2709. </div><div class="memdoc">

  2710. <p>Set the file's current position to zero. </p>

  2711. 

  2712. </div>

  2713. </div>

  2714. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2715. <div class="memitem">

  2716. <div class="memproto">

  2717. <table class="mlabels">

  2718.   <tr>

  2719.   <td class="mlabels-left">

  2720.       <table class="memname">

  2721.         <tr>

  2722.           <td class="memname">bool FatFile::rmdir </td>

  2723.           <td>(</td>

  2724.           <td class="paramname"></td><td>)</td>

  2725.           <td></td>

  2726.         </tr>

  2727.       </table>

  2728.   </td>

  2729.   <td class="mlabels-right">

  2730. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2731.   </tr>

  2732. </table>

  2733. </div><div class="memdoc">

  2734. <p>Remove a directory file.</p>

  2735. <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>

  2736. <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>

  2737. <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>

  2738. 

  2739. </div>

  2740. </div>

  2741. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2742. <div class="memitem">

  2743. <div class="memproto">

  2744. <table class="mlabels">

  2745.   <tr>

  2746.   <td class="mlabels-left">

  2747.       <table class="memname">

  2748.         <tr>

  2749.           <td class="memname">bool FatFile::rmRfStar </td>

  2750.           <td>(</td>

  2751.           <td class="paramname"></td><td>)</td>

  2752.           <td></td>

  2753.         </tr>

  2754.       </table>

  2755.   </td>

  2756.   <td class="mlabels-right">

  2757. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2758.   </tr>

  2759. </table>

  2760. </div><div class="memdoc">

  2761. <p>Recursively delete a directory and all contained files.</p>

  2762. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2763. <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>

  2764. <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>

  2765. <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>

  2766. 

  2767. </div>

  2768. </div>

  2769. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2770. <div class="memitem">

  2771. <div class="memproto">

  2772. <table class="mlabels">

  2773.   <tr>

  2774.   <td class="mlabels-left">

  2775.       <table class="memname">

  2776.         <tr>

  2777.           <td class="memname">bool FatFile::seekCur </td>

  2778.           <td>(</td>

  2779.           <td class="paramtype">int32_t&#160;</td>

  2780.           <td class="paramname"><em>offset</em></td><td>)</td>

  2781.           <td></td>

  2782.         </tr>

  2783.       </table>

  2784.   </td>

  2785.   <td class="mlabels-right">

  2786. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2787.   </tr>

  2788. </table>

  2789. </div><div class="memdoc">

  2790. <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>

  2791.   <table class="params">

  2792.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2793.   </table>

  2794.   </dd>

  2795. </dl>

  2796. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2797. 

  2798. </div>

  2799. </div>

  2800. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2801. <div class="memitem">

  2802. <div class="memproto">

  2803. <table class="mlabels">

  2804.   <tr>

  2805.   <td class="mlabels-left">

  2806.       <table class="memname">

  2807.         <tr>

  2808.           <td class="memname">bool FatFile::seekEnd </td>

  2809.           <td>(</td>

  2810.           <td class="paramtype">int32_t&#160;</td>

  2811.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2812.           <td></td>

  2813.         </tr>

  2814.       </table>

  2815.   </td>

  2816.   <td class="mlabels-right">

  2817. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2818.   </tr>

  2819. </table>

  2820. </div><div class="memdoc">

  2821. <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>

  2822.   <table class="params">

  2823.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2824.   </table>

  2825.   </dd>

  2826. </dl>

  2827. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2828. 

  2829. </div>

  2830. </div>

  2831. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2832. <div class="memitem">

  2833. <div class="memproto">

  2834. <table class="mlabels">

  2835.   <tr>

  2836.   <td class="mlabels-left">

  2837.       <table class="memname">

  2838.         <tr>

  2839.           <td class="memname">bool FatFile::seekSet </td>

  2840.           <td>(</td>

  2841.           <td class="paramtype">uint32_t&#160;</td>

  2842.           <td class="paramname"><em>pos</em></td><td>)</td>

  2843.           <td></td>

  2844.         </tr>

  2845.       </table>

  2846.   </td>

  2847.   <td class="mlabels-right">

  2848. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2849.   </tr>

  2850. </table>

  2851. </div><div class="memdoc">

  2852. <p>Sets a file's position.</p>

  2853. <dl class="params"><dt>Parameters</dt><dd>

  2854.   <table class="params">

  2855.     <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>

  2856.   </table>

  2857.   </dd>

  2858. </dl>

  2859. <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>

  2860. 

  2861. </div>

  2862. </div>

  2863. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2864. <div class="memitem">

  2865. <div class="memproto">

  2866. <table class="mlabels">

  2867.   <tr>

  2868.   <td class="mlabels-left">

  2869.       <table class="memname">

  2870.         <tr>

  2871.           <td class="memname">static bool FatFile::setCwd </td>

  2872.           <td>(</td>

  2873.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2874.           <td class="paramname"><em>dir</em></td><td>)</td>

  2875.           <td></td>

  2876.         </tr>

  2877.       </table>

  2878.   </td>

  2879.   <td class="mlabels-right">

  2880. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2881.   </tr>

  2882. </table>

  2883. </div><div class="memdoc">

  2884. <p>Set the current working directory.</p>

  2885. <dl class="params"><dt>Parameters</dt><dd>

  2886.   <table class="params">

  2887.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2888.   </table>

  2889.   </dd>

  2890. </dl>

  2891. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2892. 

  2893. </div>

  2894. </div>

  2895. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2896. <div class="memitem">

  2897. <div class="memproto">

  2898. <table class="mlabels">

  2899.   <tr>

  2900.   <td class="mlabels-left">

  2901.       <table class="memname">

  2902.         <tr>

  2903.           <td class="memname">void FatFile::setpos </td>

  2904.           <td>(</td>

  2905.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2906.           <td class="paramname"><em>pos</em></td><td>)</td>

  2907.           <td></td>

  2908.         </tr>

  2909.       </table>

  2910.   </td>

  2911.   <td class="mlabels-right">

  2912. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2913.   </tr>

  2914. </table>

  2915. </div><div class="memdoc">

  2916. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2917.   <table class="params">

  2918.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2919.   </table>

  2920.   </dd>

  2921. </dl>

  2922. 

  2923. </div>

  2924. </div>

  2925. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2926. <div class="memitem">

  2927. <div class="memproto">

  2928. <table class="mlabels">

  2929.   <tr>

  2930.   <td class="mlabels-left">

  2931.       <table class="memname">

  2932.         <tr>

  2933.           <td class="memname">bool FatFile::sync </td>

  2934.           <td>(</td>

  2935.           <td class="paramname"></td><td>)</td>

  2936.           <td></td>

  2937.         </tr>

  2938.       </table>

  2939.   </td>

  2940.   <td class="mlabels-right">

  2941. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2942.   </tr>

  2943. </table>

  2944. </div><div class="memdoc">

  2945. <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>

  2946. <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>

  2947. 

  2948. </div>

  2949. </div>

  2950. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2951. <div class="memitem">

  2952. <div class="memproto">

  2953. <table class="mlabels">

  2954.   <tr>

  2955.   <td class="mlabels-left">

  2956.       <table class="memname">

  2957.         <tr>

  2958.           <td class="memname">bool FatFile::timestamp </td>

  2959.           <td>(</td>

  2960.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2961.           <td class="paramname"><em>file</em></td><td>)</td>

  2962.           <td></td>

  2963.         </tr>

  2964.       </table>

  2965.   </td>

  2966.   <td class="mlabels-right">

  2967. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2968.   </tr>

  2969. </table>

  2970. </div><div class="memdoc">

  2971. <p>Copy a file's timestamps</p>

  2972. <dl class="params"><dt>Parameters</dt><dd>

  2973.   <table class="params">

  2974.     <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>

  2975.   </table>

  2976.   </dd>

  2977. </dl>

  2978. <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>

  2979. <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>

  2980. 

  2981. </div>

  2982. </div>

  2983. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2984. <div class="memitem">

  2985. <div class="memproto">

  2986. <table class="mlabels">

  2987.   <tr>

  2988.   <td class="mlabels-left">

  2989.       <table class="memname">

  2990.         <tr>

  2991.           <td class="memname">bool FatFile::timestamp </td>

  2992.           <td>(</td>

  2993.           <td class="paramtype">uint8_t&#160;</td>

  2994.           <td class="paramname"><em>flags</em>, </td>

  2995.         </tr>

  2996.         <tr>

  2997.           <td class="paramkey"></td>

  2998.           <td></td>

  2999.           <td class="paramtype">uint16_t&#160;</td>

  3000.           <td class="paramname"><em>year</em>, </td>

  3001.         </tr>

  3002.         <tr>

  3003.           <td class="paramkey"></td>

  3004.           <td></td>

  3005.           <td class="paramtype">uint8_t&#160;</td>

  3006.           <td class="paramname"><em>month</em>, </td>

  3007.         </tr>

  3008.         <tr>

  3009.           <td class="paramkey"></td>

  3010.           <td></td>

  3011.           <td class="paramtype">uint8_t&#160;</td>

  3012.           <td class="paramname"><em>day</em>, </td>

  3013.         </tr>

  3014.         <tr>

  3015.           <td class="paramkey"></td>

  3016.           <td></td>

  3017.           <td class="paramtype">uint8_t&#160;</td>

  3018.           <td class="paramname"><em>hour</em>, </td>

  3019.         </tr>

  3020.         <tr>

  3021.           <td class="paramkey"></td>

  3022.           <td></td>

  3023.           <td class="paramtype">uint8_t&#160;</td>

  3024.           <td class="paramname"><em>minute</em>, </td>

  3025.         </tr>

  3026.         <tr>

  3027.           <td class="paramkey"></td>

  3028.           <td></td>

  3029.           <td class="paramtype">uint8_t&#160;</td>

  3030.           <td class="paramname"><em>second</em>&#160;</td>

  3031.         </tr>

  3032.         <tr>

  3033.           <td></td>

  3034.           <td>)</td>

  3035.           <td></td><td></td>

  3036.         </tr>

  3037.       </table>

  3038.   </td>

  3039.   <td class="mlabels-right">

  3040. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3041.   </tr>

  3042. </table>

  3043. </div><div class="memdoc">

  3044. <p>Set a file's timestamps in its directory entry.</p>

  3045. <dl class="params"><dt>Parameters</dt><dd>

  3046.   <table class="params">

  3047.     <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>

  3048.   </table>

  3049.   </dd>

  3050. </dl>

  3051. <p>T_ACCESS - Set the file's last access date.</p>

  3052. <p>T_CREATE - Set the file's creation date and time.</p>

  3053. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3054. <dl class="params"><dt>Parameters</dt><dd>

  3055.   <table class="params">

  3056.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3057.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3058.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3059.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3060.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3061.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3062.   </table>

  3063.   </dd>

  3064. </dl>

  3065. <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>

  3066. <dd>

  3067. 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>

  3068. <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>

  3069. 

  3070. </div>

  3071. </div>

  3072. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3073. <div class="memitem">

  3074. <div class="memproto">

  3075. <table class="mlabels">

  3076.   <tr>

  3077.   <td class="mlabels-left">

  3078.       <table class="memname">

  3079.         <tr>

  3080.           <td class="memname">bool FatFile::truncate </td>

  3081.           <td>(</td>

  3082.           <td class="paramtype">uint32_t&#160;</td>

  3083.           <td class="paramname"><em>length</em></td><td>)</td>

  3084.           <td></td>

  3085.         </tr>

  3086.       </table>

  3087.   </td>

  3088.   <td class="mlabels-right">

  3089. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3090.   </tr>

  3091. </table>

  3092. </div><div class="memdoc">

  3093. <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>

  3094. <dl class="params"><dt>Parameters</dt><dd>

  3095.   <table class="params">

  3096.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3097.   </table>

  3098.   </dd>

  3099. </dl>

  3100. <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>

  3101. 

  3102. </div>

  3103. </div>

  3104. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3105. <div class="memitem">

  3106. <div class="memproto">

  3107. <table class="mlabels">

  3108.   <tr>

  3109.   <td class="mlabels-left">

  3110.       <table class="memname">

  3111.         <tr>

  3112.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3113.           <td>(</td>

  3114.           <td class="paramname"></td><td>)</td>

  3115.           <td> const</td>

  3116.         </tr>

  3117.       </table>

  3118.   </td>

  3119.   <td class="mlabels-right">

  3120. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3121.   </tr>

  3122. </table>

  3123. </div><div class="memdoc">

  3124. <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>

  3125. 

  3126. </div>

  3127. </div>

  3128. <a class="anchor" id="a460b033ff85e85f684f8d9b615645db1"></a>

  3129. <div class="memitem">

  3130. <div class="memproto">

  3131. <table class="mlabels">

  3132.   <tr>

  3133.   <td class="mlabels-left">

  3134.       <table class="memname">

  3135.         <tr>

  3136.           <td class="memname">size_t PrintFile::write </td>

  3137.           <td>(</td>

  3138.           <td class="paramtype">uint8_t&#160;</td>

  3139.           <td class="paramname"><em>b</em></td><td>)</td>

  3140.           <td></td>

  3141.         </tr>

  3142.       </table>

  3143.   </td>

  3144.   <td class="mlabels-right">

  3145. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3146.   </tr>

  3147. </table>

  3148. </div><div class="memdoc">

  3149. <p>Read the next byte from a file.</p>

  3150. <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>

  3151. <dl class="params"><dt>Parameters</dt><dd>

  3152.   <table class="params">

  3153.     <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>

  3154.   </table>

  3155.   </dd>

  3156. </dl>

  3157. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3158. 

  3159. </div>

  3160. </div>

  3161. <a class="anchor" id="a29c1d534d21c3a82ad04232d37119a57"></a>

  3162. <div class="memitem">

  3163. <div class="memproto">

  3164. <table class="mlabels">

  3165.   <tr>

  3166.   <td class="mlabels-left">

  3167.       <table class="memname">

  3168.         <tr>

  3169.           <td class="memname">size_t PrintFile::write </td>

  3170.           <td>(</td>

  3171.           <td class="paramtype">const uint8_t *&#160;</td>

  3172.           <td class="paramname"><em>buf</em>, </td>

  3173.         </tr>

  3174.         <tr>

  3175.           <td class="paramkey"></td>

  3176.           <td></td>

  3177.           <td class="paramtype">size_t&#160;</td>

  3178.           <td class="paramname"><em>size</em>&#160;</td>

  3179.         </tr>

  3180.         <tr>

  3181.           <td></td>

  3182.           <td>)</td>

  3183.           <td></td><td></td>

  3184.         </tr>

  3185.       </table>

  3186.   </td>

  3187.   <td class="mlabels-right">

  3188. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3189.   </tr>

  3190. </table>

  3191. </div><div class="memdoc">

  3192. <p>Write data to an open file. Form required by Print.</p>

  3193. <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>

  3194. <dl class="params"><dt>Parameters</dt><dd>

  3195.   <table class="params">

  3196.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3197.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3198.   </table>

  3199.   </dd>

  3200. </dl>

  3201. <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>

  3202. 

  3203. </div>

  3204. </div>

  3205. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3206. <div class="memitem">

  3207. <div class="memproto">

  3208. <table class="mlabels">

  3209.   <tr>

  3210.   <td class="mlabels-left">

  3211.       <table class="memname">

  3212.         <tr>

  3213.           <td class="memname">int FatFile::write </td>

  3214.           <td>(</td>

  3215.           <td class="paramtype">const char *&#160;</td>

  3216.           <td class="paramname"><em>str</em></td><td>)</td>

  3217.           <td></td>

  3218.         </tr>

  3219.       </table>

  3220.   </td>

  3221.   <td class="mlabels-right">

  3222. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3223.   </tr>

  3224. </table>

  3225. </div><div class="memdoc">

  3226. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3227.   <table class="params">

  3228.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3229.   </table>

  3230.   </dd>

  3231. </dl>

  3232. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3233. 

  3234. </div>

  3235. </div>

  3236. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3237. <div class="memitem">

  3238. <div class="memproto">

  3239. <table class="mlabels">

  3240.   <tr>

  3241.   <td class="mlabels-left">

  3242.       <table class="memname">

  3243.         <tr>

  3244.           <td class="memname">int FatFile::write </td>

  3245.           <td>(</td>

  3246.           <td class="paramtype">const void *&#160;</td>

  3247.           <td class="paramname"><em>buf</em>, </td>

  3248.         </tr>

  3249.         <tr>

  3250.           <td class="paramkey"></td>

  3251.           <td></td>

  3252.           <td class="paramtype">size_t&#160;</td>

  3253.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3254.         </tr>

  3255.         <tr>

  3256.           <td></td>

  3257.           <td>)</td>

  3258.           <td></td><td></td>

  3259.         </tr>

  3260.       </table>

  3261.   </td>

  3262.   <td class="mlabels-right">

  3263. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3264.   </tr>

  3265. </table>

  3266. </div><div class="memdoc">

  3267. <p>Write data to an open file.</p>

  3268. <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>

  3269. <dl class="params"><dt>Parameters</dt><dd>

  3270.   <table class="params">

  3271.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3272.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3273.   </table>

  3274.   </dd>

  3275. </dl>

  3276. <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>

  3277. 

  3278. </div>

  3279. </div>

  3280. <hr/>The documentation for this class was generated from the following file:<ul>

  3281. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_arduino_files_8h.html">ArduinoFiles.h</a></li>

  3282. </ul>

  3283. </div><!-- contents -->

  3284. <!-- start footer part -->

  3285. <hr class="footer"/><address class="footer"><small>

  3286. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3287. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3288. </a> 1.8.10

  3289. </small></address>

  3290. </body>

  3291. </html>