visus
/
teensy-sdfat
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
42 коммитов
1 ветка
Дерево: 7871875f5c
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/class_print_file.html

3363 lines
148KB
Исходник Blame История 

  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 class="current"><a href="annotated.html"><span>Classes</span></a></li>

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

  73. </div>

  74. 

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

  76. <div id="MSearchResultsWindow">

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

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

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for PrintFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node4" href="class_sd_file.html" title="Class for backward compatibility. " alt="" coords="47,155,106,181"/>

  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:a0853fbd44aee2798d14d8e3aed78f8bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0853fbd44aee2798d14d8e3aed78f8bf">createContiguous</a> (const char *path, uint32_t size)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  300. </table>

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

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

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

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

  305. <div class="memitem">

  306. <div class="memproto">

  307. <table class="mlabels">

  308.   <tr>

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

  310.       <table class="memname">

  311.         <tr>

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

  313.           <td>(</td>

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

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

  316.         </tr>

  317.         <tr>

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

  319.           <td></td>

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

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

  322.         </tr>

  323.         <tr>

  324.           <td></td>

  325.           <td>)</td>

  326.           <td></td><td></td>

  327.         </tr>

  328.       </table>

  329.   </td>

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

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

  332.   </tr>

  333. </table>

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

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

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

  337.   <table class="params">

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

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

  340.   </table>

  341.   </dd>

  342. </dl>

  343. 

  344. </div>

  345. </div>

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

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

  348. <div class="memitem">

  349. <div class="memproto">

  350. <table class="mlabels">

  351.   <tr>

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

  353.       <table class="memname">

  354.         <tr>

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

  356.           <td>(</td>

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

  358.           <td></td>

  359.         </tr>

  360.       </table>

  361.   </td>

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

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

  364.   </tr>

  365. </table>

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

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

  368. 

  369. </div>

  370. </div>

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

  372. <div class="memitem">

  373. <div class="memproto">

  374. <table class="mlabels">

  375.   <tr>

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

  377.       <table class="memname">

  378.         <tr>

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

  380.           <td>(</td>

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

  382.           <td></td>

  383.         </tr>

  384.       </table>

  385.   </td>

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

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

  388.   </tr>

  389. </table>

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

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

  392. 

  393. </div>

  394. </div>

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

  396. <div class="memitem">

  397. <div class="memproto">

  398. <table class="mlabels">

  399.   <tr>

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

  401.       <table class="memname">

  402.         <tr>

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

  404.           <td>(</td>

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

  406.           <td></td>

  407.         </tr>

  408.       </table>

  409.   </td>

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

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

  412.   </tr>

  413. </table>

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

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

  416. 

  417. </div>

  418. </div>

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

  420. <div class="memitem">

  421. <div class="memproto">

  422. <table class="mlabels">

  423.   <tr>

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

  425.       <table class="memname">

  426.         <tr>

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

  428.           <td>(</td>

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

  430.           <td></td>

  431.         </tr>

  432.       </table>

  433.   </td>

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

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

  436.   </tr>

  437. </table>

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

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

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

  441. 

  442. </div>

  443. </div>

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

  445. <div class="memitem">

  446. <div class="memproto">

  447. <table class="mlabels">

  448.   <tr>

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

  450.       <table class="memname">

  451.         <tr>

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

  453.           <td>(</td>

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

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

  456.         </tr>

  457.         <tr>

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

  459.           <td></td>

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

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

  462.         </tr>

  463.         <tr>

  464.           <td></td>

  465.           <td>)</td>

  466.           <td></td><td></td>

  467.         </tr>

  468.       </table>

  469.   </td>

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

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

  472.   </tr>

  473. </table>

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

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

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

  477.   <table class="params">

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

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

  480.   </table>

  481.   </dd>

  482. </dl>

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

  484. 

  485. </div>

  486. </div>

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

  488. <div class="memitem">

  489. <div class="memproto">

  490. <table class="mlabels">

  491.   <tr>

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

  493.       <table class="memname">

  494.         <tr>

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

  496.           <td>(</td>

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

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

  499.         </tr>

  500.         <tr>

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

  502.           <td></td>

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

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

  505.         </tr>

  506.         <tr>

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

  508.           <td></td>

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

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

  511.         </tr>

  512.         <tr>

  513.           <td></td>

  514.           <td>)</td>

  515.           <td></td><td></td>

  516.         </tr>

  517.       </table>

  518.   </td>

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

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

  521.   </tr>

  522. </table>

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

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

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

  526.   <table class="params">

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

  528.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>

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

  530.   </table>

  531.   </dd>

  532. </dl>

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

  534. 

  535. </div>

  536. </div>

  537. <a class="anchor" id="a0853fbd44aee2798d14d8e3aed78f8bf"></a>

  538. <div class="memitem">

  539. <div class="memproto">

  540. <table class="mlabels">

  541.   <tr>

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

  543.       <table class="memname">

  544.         <tr>

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

  546.           <td>(</td>

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

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

  549.         </tr>

  550.         <tr>

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

  552.           <td></td>

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

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

  555.         </tr>

  556.         <tr>

  557.           <td></td>

  558.           <td>)</td>

  559.           <td></td><td></td>

  560.         </tr>

  561.       </table>

  562.   </td>

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

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

  565.   </tr>

  566. </table>

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

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

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

  570.   <table class="params">

  571.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>

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

  573.   </table>

  574.   </dd>

  575. </dl>

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

  577. 

  578. </div>

  579. </div>

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

  581. <div class="memitem">

  582. <div class="memproto">

  583. <table class="mlabels">

  584.   <tr>

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

  586.       <table class="memname">

  587.         <tr>

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

  589.           <td>(</td>

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

  591.           <td> const</td>

  592.         </tr>

  593.       </table>

  594.   </td>

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

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

  597.   </tr>

  598. </table>

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

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

  601. 

  602. </div>

  603. </div>

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

  605. <div class="memitem">

  606. <div class="memproto">

  607. <table class="mlabels">

  608.   <tr>

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

  610.       <table class="memname">

  611.         <tr>

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

  613.           <td>(</td>

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

  615.           <td> const</td>

  616.         </tr>

  617.       </table>

  618.   </td>

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

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

  621.   </tr>

  622. </table>

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

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

  625. 

  626. </div>

  627. </div>

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

  629. <div class="memitem">

  630. <div class="memproto">

  631. <table class="mlabels">

  632.   <tr>

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

  634.       <table class="memname">

  635.         <tr>

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

  637.           <td>(</td>

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

  639.           <td></td>

  640.         </tr>

  641.       </table>

  642.   </td>

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

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

  645.   </tr>

  646. </table>

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

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

  649. 

  650. </div>

  651. </div>

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

  653. <div class="memitem">

  654. <div class="memproto">

  655. <table class="mlabels">

  656.   <tr>

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

  658.       <table class="memname">

  659.         <tr>

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

  661.           <td>(</td>

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

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

  664.           <td></td>

  665.         </tr>

  666.       </table>

  667.   </td>

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

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

  670.   </tr>

  671. </table>

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

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

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

  675.   <table class="params">

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

  677.   </table>

  678.   </dd>

  679. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  694. 

  695. </div>

  696. </div>

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

  698. <div class="memitem">

  699. <div class="memproto">

  700. <table class="mlabels">

  701.   <tr>

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

  703.       <table class="memname">

  704.         <tr>

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

  706.           <td>(</td>

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

  708.           <td></td>

  709.         </tr>

  710.       </table>

  711.   </td>

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

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

  714.   </tr>

  715. </table>

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

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

  718. 

  719. </div>

  720. </div>

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

  722. <div class="memitem">

  723. <div class="memproto">

  724. <table class="mlabels">

  725.   <tr>

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

  727.       <table class="memname">

  728.         <tr>

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

  730.           <td>(</td>

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

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

  733.           <td></td>

  734.         </tr>

  735.       </table>

  736.   </td>

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

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

  739.   </tr>

  740. </table>

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

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

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

  744.   <table class="params">

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

  746.   </table>

  747.   </dd>

  748. </dl>

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

  750. 

  751. </div>

  752. </div>

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

  754. <div class="memitem">

  755. <div class="memproto">

  756. <table class="mlabels">

  757.   <tr>

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

  759.       <table class="memname">

  760.         <tr>

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

  762.           <td>(</td>

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

  764.           <td></td>

  765.         </tr>

  766.       </table>

  767.   </td>

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

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

  770.   </tr>

  771. </table>

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

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

  774. 

  775. </div>

  776. </div>

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

  778. <div class="memitem">

  779. <div class="memproto">

  780. <table class="mlabels">

  781.   <tr>

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

  783.       <table class="memname">

  784.         <tr>

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

  786.           <td>(</td>

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

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

  789.         </tr>

  790.         <tr>

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

  792.           <td></td>

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

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

  795.         </tr>

  796.         <tr>

  797.           <td></td>

  798.           <td>)</td>

  799.           <td></td><td></td>

  800.         </tr>

  801.       </table>

  802.   </td>

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

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

  805.   </tr>

  806. </table>

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

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

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

  810.   <table class="params">

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

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

  813.   </table>

  814.   </dd>

  815. </dl>

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

  817. 

  818. </div>

  819. </div>

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

  821. <div class="memitem">

  822. <div class="memproto">

  823. <table class="mlabels">

  824.   <tr>

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

  826.       <table class="memname">

  827.         <tr>

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

  829.           <td>(</td>

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

  831.           <td></td>

  832.         </tr>

  833.       </table>

  834.   </td>

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

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

  837.   </tr>

  838. </table>

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

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

  841. 

  842. </div>

  843. </div>

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

  845. <div class="memitem">

  846. <div class="memproto">

  847. <table class="mlabels">

  848.   <tr>

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

  850.       <table class="memname">

  851.         <tr>

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

  853.           <td>(</td>

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

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

  856.         </tr>

  857.         <tr>

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

  859.           <td></td>

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

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

  862.         </tr>

  863.         <tr>

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

  865.           <td></td>

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

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

  868.         </tr>

  869.         <tr>

  870.           <td></td>

  871.           <td>)</td>

  872.           <td></td><td></td>

  873.         </tr>

  874.       </table>

  875.   </td>

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

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

  878.   </tr>

  879. </table>

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

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

  882.   <table class="params">

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

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

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

  886.   </table>

  887.   </dd>

  888. </dl>

  889. 

  890. </div>

  891. </div>

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

  893. <div class="memitem">

  894. <div class="memproto">

  895. <table class="mlabels">

  896.   <tr>

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

  898.       <table class="memname">

  899.         <tr>

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

  901.           <td>(</td>

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

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

  904.           <td></td>

  905.         </tr>

  906.       </table>

  907.   </td>

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

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

  910.   </tr>

  911. </table>

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

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

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

  915.   <table class="params">

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

  917.   </table>

  918.   </dd>

  919. </dl>

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

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

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

  923. 

  924. </div>

  925. </div>

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

  927. <div class="memitem">

  928. <div class="memproto">

  929. <table class="mlabels">

  930.   <tr>

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

  932.       <table class="memname">

  933.         <tr>

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

  935.           <td>(</td>

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

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

  938.         </tr>

  939.         <tr>

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

  941.           <td></td>

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

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

  944.         </tr>

  945.         <tr>

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

  947.           <td></td>

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

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

  950.         </tr>

  951.         <tr>

  952.           <td></td>

  953.           <td>)</td>

  954.           <td></td><td></td>

  955.         </tr>

  956.       </table>

  957.   </td>

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

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

  960.   </tr>

  961. </table>

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

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

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

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

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

  967.   <table class="params">

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

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

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

  971.   </table>

  972.   </dd>

  973. </dl>

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

  975. 

  976. </div>

  977. </div>

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

  979. <div class="memitem">

  980. <div class="memproto">

  981. <table class="mlabels">

  982.   <tr>

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

  984.       <table class="memname">

  985.         <tr>

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

  987.           <td>(</td>

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

  989.           <td> const</td>

  990.         </tr>

  991.       </table>

  992.   </td>

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

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

  995.   </tr>

  996. </table>

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

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

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

  1000. 

  1001. </div>

  1002. </div>

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

  1004. <div class="memitem">

  1005. <div class="memproto">

  1006. <table class="mlabels">

  1007.   <tr>

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

  1009.       <table class="memname">

  1010.         <tr>

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

  1012.           <td>(</td>

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

  1014.           <td> const</td>

  1015.         </tr>

  1016.       </table>

  1017.   </td>

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

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

  1020.   </tr>

  1021. </table>

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

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

  1024. 

  1025. </div>

  1026. </div>

  1027. <a class="anchor" id="ac87b753811e540c7b799da56fa89724b"></a>

  1028. <div class="memitem">

  1029. <div class="memproto">

  1030. <table class="mlabels">

  1031.   <tr>

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

  1033.       <table class="memname">

  1034.         <tr>

  1035.           <td class="memname">uint32_t FatFile::firstBlock </td>

  1036.           <td>(</td>

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

  1038.           <td></td>

  1039.         </tr>

  1040.       </table>

  1041.   </td>

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

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

  1044.   </tr>

  1045. </table>

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

  1047. <dl class="section return"><dt>Returns</dt><dd>first block of file or zero for empty file. </dd></dl>

  1048. 

  1049. </div>

  1050. </div>

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

  1052. <div class="memitem">

  1053. <div class="memproto">

  1054. <table class="mlabels">

  1055.   <tr>

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

  1057.       <table class="memname">

  1058.         <tr>

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

  1060.           <td>(</td>

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

  1062.           <td> const</td>

  1063.         </tr>

  1064.       </table>

  1065.   </td>

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

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

  1068.   </tr>

  1069. </table>

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

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

  1072. 

  1073. </div>

  1074. </div>

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

  1076. <div class="memitem">

  1077. <div class="memproto">

  1078. <table class="mlabels">

  1079.   <tr>

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

  1081.       <table class="memname">

  1082.         <tr>

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

  1084.           <td>(</td>

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

  1086.           <td></td>

  1087.         </tr>

  1088.       </table>

  1089.   </td>

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

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

  1092.   </tr>

  1093. </table>

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

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

  1096. 

  1097. </div>

  1098. </div>

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

  1100. <div class="memitem">

  1101. <div class="memproto">

  1102. <table class="mlabels">

  1103.   <tr>

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

  1105.       <table class="memname">

  1106.         <tr>

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

  1108.           <td>(</td>

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

  1110.           <td></td>

  1111.         </tr>

  1112.       </table>

  1113.   </td>

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

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

  1116.   </tr>

  1117. </table>

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

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

  1120. 

  1121. </div>

  1122. </div>

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

  1124. <div class="memitem">

  1125. <div class="memproto">

  1126. <table class="mlabels">

  1127.   <tr>

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

  1129.       <table class="memname">

  1130.         <tr>

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

  1132.           <td>(</td>

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

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

  1135.         </tr>

  1136.         <tr>

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

  1138.           <td></td>

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

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

  1141.         </tr>

  1142.         <tr>

  1143.           <td></td>

  1144.           <td>)</td>

  1145.           <td></td><td></td>

  1146.         </tr>

  1147.       </table>

  1148.   </td>

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

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

  1151.   </tr>

  1152. </table>

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

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

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

  1156.   <table class="params">

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

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

  1159.   </table>

  1160.   </dd>

  1161. </dl>

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

  1163. 

  1164. </div>

  1165. </div>

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

  1167. <div class="memitem">

  1168. <div class="memproto">

  1169. <table class="mlabels">

  1170.   <tr>

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

  1172.       <table class="memname">

  1173.         <tr>

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

  1175.           <td>(</td>

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

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

  1178.           <td></td>

  1179.         </tr>

  1180.       </table>

  1181.   </td>

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

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

  1184.   </tr>

  1185. </table>

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

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

  1188.   <table class="params">

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

  1190.   </table>

  1191.   </dd>

  1192. </dl>

  1193. 

  1194. </div>

  1195. </div>

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

  1197. <div class="memitem">

  1198. <div class="memproto">

  1199. <table class="mlabels">

  1200.   <tr>

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

  1202.       <table class="memname">

  1203.         <tr>

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

  1205.           <td>(</td>

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

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

  1208.           <td></td>

  1209.         </tr>

  1210.       </table>

  1211.   </td>

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

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

  1214.   </tr>

  1215. </table>

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

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

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

  1219.   <table class="params">

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

  1221.   </table>

  1222.   </dd>

  1223. </dl>

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

  1225. 

  1226. </div>

  1227. </div>

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

  1229. <div class="memitem">

  1230. <div class="memproto">

  1231. <table class="mlabels">

  1232.   <tr>

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

  1234.       <table class="memname">

  1235.         <tr>

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

  1237.           <td>(</td>

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

  1239.           <td></td>

  1240.         </tr>

  1241.       </table>

  1242.   </td>

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

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

  1245.   </tr>

  1246. </table>

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

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

  1249. 

  1250. </div>

  1251. </div>

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

  1253. <div class="memitem">

  1254. <div class="memproto">

  1255. <table class="mlabels">

  1256.   <tr>

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

  1258.       <table class="memname">

  1259.         <tr>

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

  1261.           <td>(</td>

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

  1263.           <td> const</td>

  1264.         </tr>

  1265.       </table>

  1266.   </td>

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

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

  1269.   </tr>

  1270. </table>

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

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

  1273. 

  1274. </div>

  1275. </div>

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

  1277. <div class="memitem">

  1278. <div class="memproto">

  1279. <table class="mlabels">

  1280.   <tr>

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

  1282.       <table class="memname">

  1283.         <tr>

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

  1285.           <td>(</td>

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

  1287.           <td> const</td>

  1288.         </tr>

  1289.       </table>

  1290.   </td>

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

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

  1293.   </tr>

  1294. </table>

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

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

  1297. 

  1298. </div>

  1299. </div>

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

  1301. <div class="memitem">

  1302. <div class="memproto">

  1303. <table class="mlabels">

  1304.   <tr>

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

  1306.       <table class="memname">

  1307.         <tr>

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

  1309.           <td>(</td>

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

  1311.           <td> const</td>

  1312.         </tr>

  1313.       </table>

  1314.   </td>

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

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

  1317.   </tr>

  1318. </table>

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

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

  1321. 

  1322. </div>

  1323. </div>

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

  1325. <div class="memitem">

  1326. <div class="memproto">

  1327. <table class="mlabels">

  1328.   <tr>

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

  1330.       <table class="memname">

  1331.         <tr>

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

  1333.           <td>(</td>

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

  1335.           <td> const</td>

  1336.         </tr>

  1337.       </table>

  1338.   </td>

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

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

  1341.   </tr>

  1342. </table>

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

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

  1345. 

  1346. </div>

  1347. </div>

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

  1349. <div class="memitem">

  1350. <div class="memproto">

  1351. <table class="mlabels">

  1352.   <tr>

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

  1354.       <table class="memname">

  1355.         <tr>

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

  1357.           <td>(</td>

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

  1359.           <td> const</td>

  1360.         </tr>

  1361.       </table>

  1362.   </td>

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

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

  1365.   </tr>

  1366. </table>

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

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

  1369. 

  1370. </div>

  1371. </div>

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

  1373. <div class="memitem">

  1374. <div class="memproto">

  1375. <table class="mlabels">

  1376.   <tr>

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

  1378.       <table class="memname">

  1379.         <tr>

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

  1381.           <td>(</td>

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

  1383.           <td> const</td>

  1384.         </tr>

  1385.       </table>

  1386.   </td>

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

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

  1389.   </tr>

  1390. </table>

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

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

  1393. 

  1394. </div>

  1395. </div>

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

  1397. <div class="memitem">

  1398. <div class="memproto">

  1399. <table class="mlabels">

  1400.   <tr>

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

  1402.       <table class="memname">

  1403.         <tr>

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

  1405.           <td>(</td>

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

  1407.           <td> const</td>

  1408.         </tr>

  1409.       </table>

  1410.   </td>

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

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

  1413.   </tr>

  1414. </table>

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

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

  1417. 

  1418. </div>

  1419. </div>

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

  1421. <div class="memitem">

  1422. <div class="memproto">

  1423. <table class="mlabels">

  1424.   <tr>

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

  1426.       <table class="memname">

  1427.         <tr>

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

  1429.           <td>(</td>

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

  1431.           <td> const</td>

  1432.         </tr>

  1433.       </table>

  1434.   </td>

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

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

  1437.   </tr>

  1438. </table>

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

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

  1441. 

  1442. </div>

  1443. </div>

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

  1445. <div class="memitem">

  1446. <div class="memproto">

  1447. <table class="mlabels">

  1448.   <tr>

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

  1450.       <table class="memname">

  1451.         <tr>

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

  1453.           <td>(</td>

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

  1455.           <td> const</td>

  1456.         </tr>

  1457.       </table>

  1458.   </td>

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

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

  1461.   </tr>

  1462. </table>

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

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

  1465. 

  1466. </div>

  1467. </div>

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

  1469. <div class="memitem">

  1470. <div class="memproto">

  1471. <table class="mlabels">

  1472.   <tr>

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

  1474.       <table class="memname">

  1475.         <tr>

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

  1477.           <td>(</td>

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

  1479.           <td> const</td>

  1480.         </tr>

  1481.       </table>

  1482.   </td>

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

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

  1485.   </tr>

  1486. </table>

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

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

  1489. 

  1490. </div>

  1491. </div>

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

  1493. <div class="memitem">

  1494. <div class="memproto">

  1495. <table class="mlabels">

  1496.   <tr>

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

  1498.       <table class="memname">

  1499.         <tr>

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

  1501.           <td>(</td>

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

  1503.           <td> const</td>

  1504.         </tr>

  1505.       </table>

  1506.   </td>

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

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

  1509.   </tr>

  1510. </table>

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

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

  1513. 

  1514. </div>

  1515. </div>

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

  1517. <div class="memitem">

  1518. <div class="memproto">

  1519. <table class="mlabels">

  1520.   <tr>

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

  1522.       <table class="memname">

  1523.         <tr>

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

  1525.           <td>(</td>

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

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

  1528.           <td></td>

  1529.         </tr>

  1530.       </table>

  1531.   </td>

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

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

  1534.   </tr>

  1535. </table>

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

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

  1538.   <table class="params">

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

  1540.   </table>

  1541.   </dd>

  1542. </dl>

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

  1544. 

  1545. </div>

  1546. </div>

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

  1548. <div class="memitem">

  1549. <div class="memproto">

  1550. <table class="mlabels">

  1551.   <tr>

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

  1553.       <table class="memname">

  1554.         <tr>

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

  1556.           <td>(</td>

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

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

  1559.           <td></td>

  1560.         </tr>

  1561.       </table>

  1562.   </td>

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

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

  1565.   </tr>

  1566. </table>

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

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

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

  1570.   <table class="params">

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

  1572.   </table>

  1573.   </dd>

  1574. </dl>

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

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

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

  1578. 

  1579. </div>

  1580. </div>

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

  1582. <div class="memitem">

  1583. <div class="memproto">

  1584. <table class="mlabels">

  1585.   <tr>

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

  1587.       <table class="memname">

  1588.         <tr>

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

  1590.           <td>(</td>

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

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

  1593.         </tr>

  1594.         <tr>

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

  1596.           <td></td>

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

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

  1599.         </tr>

  1600.         <tr>

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

  1602.           <td></td>

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

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

  1605.         </tr>

  1606.         <tr>

  1607.           <td></td>

  1608.           <td>)</td>

  1609.           <td></td><td></td>

  1610.         </tr>

  1611.       </table>

  1612.   </td>

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

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

  1615.   </tr>

  1616. </table>

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

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

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

  1620.   <table class="params">

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

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

  1623.   </table>

  1624.   </dd>

  1625. </dl>

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

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

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

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

  1630.   <table class="params">

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

  1632.   </table>

  1633.   </dd>

  1634. </dl>

  1635. 

  1636. </div>

  1637. </div>

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

  1639. <div class="memitem">

  1640. <div class="memproto">

  1641. <table class="mlabels">

  1642.   <tr>

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

  1644.       <table class="memname">

  1645.         <tr>

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

  1647.           <td>(</td>

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

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

  1650.         </tr>

  1651.         <tr>

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

  1653.           <td></td>

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

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

  1656.         </tr>

  1657.         <tr>

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

  1659.           <td></td>

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

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

  1662.         </tr>

  1663.         <tr>

  1664.           <td></td>

  1665.           <td>)</td>

  1666.           <td></td><td></td>

  1667.         </tr>

  1668.       </table>

  1669.   </td>

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

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

  1672.   </tr>

  1673. </table>

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

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

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

  1677.   <table class="params">

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

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

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

  1681.   </table>

  1682.   </dd>

  1683. </dl>

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

  1685. 

  1686. </div>

  1687. </div>

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

  1689. <div class="memitem">

  1690. <div class="memproto">

  1691. <table class="mlabels">

  1692.   <tr>

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

  1694.       <table class="memname">

  1695.         <tr>

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

  1697.           <td>(</td>

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

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

  1700.         </tr>

  1701.         <tr>

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

  1703.           <td></td>

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

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

  1706.         </tr>

  1707.         <tr>

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

  1709.           <td></td>

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

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

  1712.         </tr>

  1713.         <tr>

  1714.           <td></td>

  1715.           <td>)</td>

  1716.           <td></td><td></td>

  1717.         </tr>

  1718.       </table>

  1719.   </td>

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

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

  1722.   </tr>

  1723. </table>

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

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

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

  1727.   <table class="params">

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

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

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

  1731.   </table>

  1732.   </dd>

  1733. </dl>

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

  1735. 

  1736. </div>

  1737. </div>

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

  1739. <div class="memitem">

  1740. <div class="memproto">

  1741. <table class="mlabels">

  1742.   <tr>

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

  1744.       <table class="memname">

  1745.         <tr>

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

  1747.           <td>(</td>

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

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

  1750.         </tr>

  1751.         <tr>

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

  1753.           <td></td>

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

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

  1756.         </tr>

  1757.         <tr>

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

  1759.           <td></td>

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

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

  1762.         </tr>

  1763.         <tr>

  1764.           <td></td>

  1765.           <td>)</td>

  1766.           <td></td><td></td>

  1767.         </tr>

  1768.       </table>

  1769.   </td>

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

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

  1772.   </tr>

  1773. </table>

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

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

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

  1777.   <table class="params">

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

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

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

  1781.   </table>

  1782.   </dd>

  1783. </dl>

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

  1785. 

  1786. </div>

  1787. </div>

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

  1789. <div class="memitem">

  1790. <div class="memproto">

  1791. <table class="mlabels">

  1792.   <tr>

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

  1794.       <table class="memname">

  1795.         <tr>

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

  1797.           <td>(</td>

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

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

  1800.         </tr>

  1801.         <tr>

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

  1803.           <td></td>

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

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

  1806.         </tr>

  1807.         <tr>

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

  1809.           <td></td>

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

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

  1812.         </tr>

  1813.         <tr>

  1814.           <td></td>

  1815.           <td>)</td>

  1816.           <td></td><td></td>

  1817.         </tr>

  1818.       </table>

  1819.   </td>

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

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

  1822.   </tr>

  1823. </table>

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

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

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

  1827.   <table class="params">

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

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

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

  1831.   </table>

  1832.   </dd>

  1833. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1848. 

  1849. </div>

  1850. </div>

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

  1852. <div class="memitem">

  1853. <div class="memproto">

  1854. <table class="mlabels">

  1855.   <tr>

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

  1857.       <table class="memname">

  1858.         <tr>

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

  1860.           <td>(</td>

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

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

  1863.         </tr>

  1864.         <tr>

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

  1866.           <td></td>

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

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

  1869.         </tr>

  1870.         <tr>

  1871.           <td></td>

  1872.           <td>)</td>

  1873.           <td></td><td></td>

  1874.         </tr>

  1875.       </table>

  1876.   </td>

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

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

  1879.   </tr>

  1880. </table>

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

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

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

  1884.   <table class="params">

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

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

  1887.   </table>

  1888.   </dd>

  1889. </dl>

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

  1891. 

  1892. </div>

  1893. </div>

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

  1895. <div class="memitem">

  1896. <div class="memproto">

  1897. <table class="mlabels">

  1898.   <tr>

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

  1900.       <table class="memname">

  1901.         <tr>

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

  1903.           <td>(</td>

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

  1905.           <td class="paramname"><em>dirFile</em>, </td>

  1906.         </tr>

  1907.         <tr>

  1908.           <td class="paramkey"></td>

  1909.           <td></td>

  1910.           <td class="paramtype">uint8_t&#160;</td>

  1911.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1912.         </tr>

  1913.         <tr>

  1914.           <td></td>

  1915.           <td>)</td>

  1916.           <td></td><td></td>

  1917.         </tr>

  1918.       </table>

  1919.   </td>

  1920.   <td class="mlabels-right">

  1921. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1922.   </tr>

  1923. </table>

  1924. </div><div class="memdoc">

  1925. <p>Open the next file or subdirectory in a directory.</p>

  1926. <dl class="params"><dt>Parameters</dt><dd>

  1927.   <table class="params">

  1928.     <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>

  1929.     <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>

  1930.   </table>

  1931.   </dd>

  1932. </dl>

  1933. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1934. 

  1935. </div>

  1936. </div>

  1937. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1938. <div class="memitem">

  1939. <div class="memproto">

  1940. <table class="mlabels">

  1941.   <tr>

  1942.   <td class="mlabels-left">

  1943.       <table class="memname">

  1944.         <tr>

  1945.           <td class="memname">bool FatFile::openRoot </td>

  1946.           <td>(</td>

  1947.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1948.           <td class="paramname"><em>vol</em></td><td>)</td>

  1949.           <td></td>

  1950.         </tr>

  1951.       </table>

  1952.   </td>

  1953.   <td class="mlabels-right">

  1954. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1955.   </tr>

  1956. </table>

  1957. </div><div class="memdoc">

  1958. <p>Open a volume's root directory.</p>

  1959. <dl class="params"><dt>Parameters</dt><dd>

  1960.   <table class="params">

  1961.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1962.   </table>

  1963.   </dd>

  1964. </dl>

  1965. <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>

  1966. 

  1967. </div>

  1968. </div>

  1969. <a class="anchor" id="a3a2a66f4a0cb69ab4edc66d39997fda7"></a>

  1970. <div class="memitem">

  1971. <div class="memproto">

  1972. <table class="mlabels">

  1973.   <tr>

  1974.   <td class="mlabels-left">

  1975.       <table class="memname">

  1976.         <tr>

  1977.           <td class="memname">int PrintFile::peek </td>

  1978.           <td>(</td>

  1979.           <td class="paramname"></td><td>)</td>

  1980.           <td></td>

  1981.         </tr>

  1982.       </table>

  1983.   </td>

  1984.   <td class="mlabels-right">

  1985. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1986.   </tr>

  1987. </table>

  1988. </div><div class="memdoc">

  1989. <p>Return the next available byte without consuming it.</p>

  1990. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1991. 

  1992. </div>

  1993. </div>

  1994. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1995. <div class="memitem">

  1996. <div class="memproto">

  1997. <table class="mlabels">

  1998.   <tr>

  1999.   <td class="mlabels-left">

  2000.       <table class="memname">

  2001.         <tr>

  2002.           <td class="memname">bool FatFile::printCreateDateTime </td>

  2003.           <td>(</td>

  2004.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2005.           <td class="paramname"><em>pr</em></td><td>)</td>

  2006.           <td></td>

  2007.         </tr>

  2008.       </table>

  2009.   </td>

  2010.   <td class="mlabels-right">

  2011. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2012.   </tr>

  2013. </table>

  2014. </div><div class="memdoc">

  2015. <p>Print a file's creation date and time</p>

  2016. <dl class="params"><dt>Parameters</dt><dd>

  2017.   <table class="params">

  2018.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2019.   </table>

  2020.   </dd>

  2021. </dl>

  2022. <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>

  2023. 

  2024. </div>

  2025. </div>

  2026. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  2027. <div class="memitem">

  2028. <div class="memproto">

  2029. <table class="mlabels">

  2030.   <tr>

  2031.   <td class="mlabels-left">

  2032.       <table class="memname">

  2033.         <tr>

  2034.           <td class="memname">static void FatFile::printFatDate </td>

  2035.           <td>(</td>

  2036.           <td class="paramtype">uint16_t&#160;</td>

  2037.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  2038.           <td></td>

  2039.         </tr>

  2040.       </table>

  2041.   </td>

  2042.   <td class="mlabels-right">

  2043. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2044.   </tr>

  2045. </table>

  2046. </div><div class="memdoc">

  2047. <p>Print a directory date field.</p>

  2048. <p>Format is yyyy-mm-dd.</p>

  2049. <dl class="params"><dt>Parameters</dt><dd>

  2050.   <table class="params">

  2051.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2052.   </table>

  2053.   </dd>

  2054. </dl>

  2055. 

  2056. </div>

  2057. </div>

  2058. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  2059. <div class="memitem">

  2060. <div class="memproto">

  2061. <table class="mlabels">

  2062.   <tr>

  2063.   <td class="mlabels-left">

  2064.       <table class="memname">

  2065.         <tr>

  2066.           <td class="memname">void FatFile::printFatDate </td>

  2067.           <td>(</td>

  2068.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2069.           <td class="paramname"><em>pr</em>, </td>

  2070.         </tr>

  2071.         <tr>

  2072.           <td class="paramkey"></td>

  2073.           <td></td>

  2074.           <td class="paramtype">uint16_t&#160;</td>

  2075.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2076.         </tr>

  2077.         <tr>

  2078.           <td></td>

  2079.           <td>)</td>

  2080.           <td></td><td></td>

  2081.         </tr>

  2082.       </table>

  2083.   </td>

  2084.   <td class="mlabels-right">

  2085. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2086.   </tr>

  2087. </table>

  2088. </div><div class="memdoc">

  2089. <p>Print a directory date field.</p>

  2090. <p>Format is yyyy-mm-dd.</p>

  2091. <dl class="params"><dt>Parameters</dt><dd>

  2092.   <table class="params">

  2093.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2094.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2095.   </table>

  2096.   </dd>

  2097. </dl>

  2098. 

  2099. </div>

  2100. </div>

  2101. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2102. <div class="memitem">

  2103. <div class="memproto">

  2104. <table class="mlabels">

  2105.   <tr>

  2106.   <td class="mlabels-left">

  2107.       <table class="memname">

  2108.         <tr>

  2109.           <td class="memname">static void FatFile::printFatTime </td>

  2110.           <td>(</td>

  2111.           <td class="paramtype">uint16_t&#160;</td>

  2112.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2113.           <td></td>

  2114.         </tr>

  2115.       </table>

  2116.   </td>

  2117.   <td class="mlabels-right">

  2118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2119.   </tr>

  2120. </table>

  2121. </div><div class="memdoc">

  2122. <p>Print a directory time field.</p>

  2123. <p>Format is hh:mm:ss.</p>

  2124. <dl class="params"><dt>Parameters</dt><dd>

  2125.   <table class="params">

  2126.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2127.   </table>

  2128.   </dd>

  2129. </dl>

  2130. 

  2131. </div>

  2132. </div>

  2133. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2134. <div class="memitem">

  2135. <div class="memproto">

  2136. <table class="mlabels">

  2137.   <tr>

  2138.   <td class="mlabels-left">

  2139.       <table class="memname">

  2140.         <tr>

  2141.           <td class="memname">void FatFile::printFatTime </td>

  2142.           <td>(</td>

  2143.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2144.           <td class="paramname"><em>pr</em>, </td>

  2145.         </tr>

  2146.         <tr>

  2147.           <td class="paramkey"></td>

  2148.           <td></td>

  2149.           <td class="paramtype">uint16_t&#160;</td>

  2150.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2151.         </tr>

  2152.         <tr>

  2153.           <td></td>

  2154.           <td>)</td>

  2155.           <td></td><td></td>

  2156.         </tr>

  2157.       </table>

  2158.   </td>

  2159.   <td class="mlabels-right">

  2160. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2161.   </tr>

  2162. </table>

  2163. </div><div class="memdoc">

  2164. <p>Print a directory time field.</p>

  2165. <p>Format is hh:mm:ss.</p>

  2166. <dl class="params"><dt>Parameters</dt><dd>

  2167.   <table class="params">

  2168.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2169.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2170.   </table>

  2171.   </dd>

  2172. </dl>

  2173. 

  2174. </div>

  2175. </div>

  2176. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2177. <div class="memitem">

  2178. <div class="memproto">

  2179. <table class="mlabels">

  2180.   <tr>

  2181.   <td class="mlabels-left">

  2182.       <table class="memname">

  2183.         <tr>

  2184.           <td class="memname">int FatFile::printField </td>

  2185.           <td>(</td>

  2186.           <td class="paramtype">float&#160;</td>

  2187.           <td class="paramname"><em>value</em>, </td>

  2188.         </tr>

  2189.         <tr>

  2190.           <td class="paramkey"></td>

  2191.           <td></td>

  2192.           <td class="paramtype">char&#160;</td>

  2193.           <td class="paramname"><em>term</em>, </td>

  2194.         </tr>

  2195.         <tr>

  2196.           <td class="paramkey"></td>

  2197.           <td></td>

  2198.           <td class="paramtype">uint8_t&#160;</td>

  2199.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2200.         </tr>

  2201.         <tr>

  2202.           <td></td>

  2203.           <td>)</td>

  2204.           <td></td><td></td>

  2205.         </tr>

  2206.       </table>

  2207.   </td>

  2208.   <td class="mlabels-right">

  2209. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2210.   </tr>

  2211. </table>

  2212. </div><div class="memdoc">

  2213. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2214.   <table class="params">

  2215.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2216.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2217.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2218.   </table>

  2219.   </dd>

  2220. </dl>

  2221. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2222. 

  2223. </div>

  2224. </div>

  2225. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2226. <div class="memitem">

  2227. <div class="memproto">

  2228. <table class="mlabels">

  2229.   <tr>

  2230.   <td class="mlabels-left">

  2231.       <table class="memname">

  2232.         <tr>

  2233.           <td class="memname">int FatFile::printField </td>

  2234.           <td>(</td>

  2235.           <td class="paramtype">int16_t&#160;</td>

  2236.           <td class="paramname"><em>value</em>, </td>

  2237.         </tr>

  2238.         <tr>

  2239.           <td class="paramkey"></td>

  2240.           <td></td>

  2241.           <td class="paramtype">char&#160;</td>

  2242.           <td class="paramname"><em>term</em>&#160;</td>

  2243.         </tr>

  2244.         <tr>

  2245.           <td></td>

  2246.           <td>)</td>

  2247.           <td></td><td></td>

  2248.         </tr>

  2249.       </table>

  2250.   </td>

  2251.   <td class="mlabels-right">

  2252. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2253.   </tr>

  2254. </table>

  2255. </div><div class="memdoc">

  2256. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2257.   <table class="params">

  2258.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2259.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2260.   </table>

  2261.   </dd>

  2262. </dl>

  2263. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2264. 

  2265. </div>

  2266. </div>

  2267. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2268. <div class="memitem">

  2269. <div class="memproto">

  2270. <table class="mlabels">

  2271.   <tr>

  2272.   <td class="mlabels-left">

  2273.       <table class="memname">

  2274.         <tr>

  2275.           <td class="memname">int FatFile::printField </td>

  2276.           <td>(</td>

  2277.           <td class="paramtype">uint16_t&#160;</td>

  2278.           <td class="paramname"><em>value</em>, </td>

  2279.         </tr>

  2280.         <tr>

  2281.           <td class="paramkey"></td>

  2282.           <td></td>

  2283.           <td class="paramtype">char&#160;</td>

  2284.           <td class="paramname"><em>term</em>&#160;</td>

  2285.         </tr>

  2286.         <tr>

  2287.           <td></td>

  2288.           <td>)</td>

  2289.           <td></td><td></td>

  2290.         </tr>

  2291.       </table>

  2292.   </td>

  2293.   <td class="mlabels-right">

  2294. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2295.   </tr>

  2296. </table>

  2297. </div><div class="memdoc">

  2298. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2299.   <table class="params">

  2300.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2301.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2302.   </table>

  2303.   </dd>

  2304. </dl>

  2305. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2306. 

  2307. </div>

  2308. </div>

  2309. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2310. <div class="memitem">

  2311. <div class="memproto">

  2312. <table class="mlabels">

  2313.   <tr>

  2314.   <td class="mlabels-left">

  2315.       <table class="memname">

  2316.         <tr>

  2317.           <td class="memname">int FatFile::printField </td>

  2318.           <td>(</td>

  2319.           <td class="paramtype">int32_t&#160;</td>

  2320.           <td class="paramname"><em>value</em>, </td>

  2321.         </tr>

  2322.         <tr>

  2323.           <td class="paramkey"></td>

  2324.           <td></td>

  2325.           <td class="paramtype">char&#160;</td>

  2326.           <td class="paramname"><em>term</em>&#160;</td>

  2327.         </tr>

  2328.         <tr>

  2329.           <td></td>

  2330.           <td>)</td>

  2331.           <td></td><td></td>

  2332.         </tr>

  2333.       </table>

  2334.   </td>

  2335.   <td class="mlabels-right">

  2336. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2337.   </tr>

  2338. </table>

  2339. </div><div class="memdoc">

  2340. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2341.   <table class="params">

  2342.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2343.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2344.   </table>

  2345.   </dd>

  2346. </dl>

  2347. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2348. 

  2349. </div>

  2350. </div>

  2351. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2352. <div class="memitem">

  2353. <div class="memproto">

  2354. <table class="mlabels">

  2355.   <tr>

  2356.   <td class="mlabels-left">

  2357.       <table class="memname">

  2358.         <tr>

  2359.           <td class="memname">int FatFile::printField </td>

  2360.           <td>(</td>

  2361.           <td class="paramtype">uint32_t&#160;</td>

  2362.           <td class="paramname"><em>value</em>, </td>

  2363.         </tr>

  2364.         <tr>

  2365.           <td class="paramkey"></td>

  2366.           <td></td>

  2367.           <td class="paramtype">char&#160;</td>

  2368.           <td class="paramname"><em>term</em>&#160;</td>

  2369.         </tr>

  2370.         <tr>

  2371.           <td></td>

  2372.           <td>)</td>

  2373.           <td></td><td></td>

  2374.         </tr>

  2375.       </table>

  2376.   </td>

  2377.   <td class="mlabels-right">

  2378. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2379.   </tr>

  2380. </table>

  2381. </div><div class="memdoc">

  2382. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2383.   <table class="params">

  2384.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2385.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2386.   </table>

  2387.   </dd>

  2388. </dl>

  2389. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2390. 

  2391. </div>

  2392. </div>

  2393. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2394. <div class="memitem">

  2395. <div class="memproto">

  2396. <table class="mlabels">

  2397.   <tr>

  2398.   <td class="mlabels-left">

  2399.       <table class="memname">

  2400.         <tr>

  2401.           <td class="memname">size_t FatFile::printFileSize </td>

  2402.           <td>(</td>

  2403.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2404.           <td class="paramname"><em>pr</em></td><td>)</td>

  2405.           <td></td>

  2406.         </tr>

  2407.       </table>

  2408.   </td>

  2409.   <td class="mlabels-right">

  2410. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2411.   </tr>

  2412. </table>

  2413. </div><div class="memdoc">

  2414. <p>Print a file's size.</p>

  2415. <dl class="params"><dt>Parameters</dt><dd>

  2416.   <table class="params">

  2417.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2418.   </table>

  2419.   </dd>

  2420. </dl>

  2421. <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>

  2422. 

  2423. </div>

  2424. </div>

  2425. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2426. <div class="memitem">

  2427. <div class="memproto">

  2428. <table class="mlabels">

  2429.   <tr>

  2430.   <td class="mlabels-left">

  2431.       <table class="memname">

  2432.         <tr>

  2433.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2434.           <td>(</td>

  2435.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2436.           <td class="paramname"><em>pr</em></td><td>)</td>

  2437.           <td></td>

  2438.         </tr>

  2439.       </table>

  2440.   </td>

  2441.   <td class="mlabels-right">

  2442. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2443.   </tr>

  2444. </table>

  2445. </div><div class="memdoc">

  2446. <p>Print a file's modify date and time</p>

  2447. <dl class="params"><dt>Parameters</dt><dd>

  2448.   <table class="params">

  2449.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2450.   </table>

  2451.   </dd>

  2452. </dl>

  2453. <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>

  2454. 

  2455. </div>

  2456. </div>

  2457. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2458. <div class="memitem">

  2459. <div class="memproto">

  2460. <table class="mlabels">

  2461.   <tr>

  2462.   <td class="mlabels-left">

  2463.       <table class="memname">

  2464.         <tr>

  2465.           <td class="memname">size_t FatFile::printName </td>

  2466.           <td>(</td>

  2467.           <td class="paramname"></td><td>)</td>

  2468.           <td></td>

  2469.         </tr>

  2470.       </table>

  2471.   </td>

  2472.   <td class="mlabels-right">

  2473. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2474.   </tr>

  2475. </table>

  2476. </div><div class="memdoc">

  2477. <p>Print a file's name.</p>

  2478. <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>

  2479. 

  2480. </div>

  2481. </div>

  2482. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2483. <div class="memitem">

  2484. <div class="memproto">

  2485. <table class="mlabels">

  2486.   <tr>

  2487.   <td class="mlabels-left">

  2488.       <table class="memname">

  2489.         <tr>

  2490.           <td class="memname">size_t FatFile::printName </td>

  2491.           <td>(</td>

  2492.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2493.           <td class="paramname"><em>pr</em></td><td>)</td>

  2494.           <td></td>

  2495.         </tr>

  2496.       </table>

  2497.   </td>

  2498.   <td class="mlabels-right">

  2499. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2500.   </tr>

  2501. </table>

  2502. </div><div class="memdoc">

  2503. <p>Print a file's name</p>

  2504. <dl class="params"><dt>Parameters</dt><dd>

  2505.   <table class="params">

  2506.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2507.   </table>

  2508.   </dd>

  2509. </dl>

  2510. <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>

  2511. 

  2512. </div>

  2513. </div>

  2514. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2515. <div class="memitem">

  2516. <div class="memproto">

  2517. <table class="mlabels">

  2518.   <tr>

  2519.   <td class="mlabels-left">

  2520.       <table class="memname">

  2521.         <tr>

  2522.           <td class="memname">size_t FatFile::printSFN </td>

  2523.           <td>(</td>

  2524.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2525.           <td class="paramname"><em>pr</em></td><td>)</td>

  2526.           <td></td>

  2527.         </tr>

  2528.       </table>

  2529.   </td>

  2530.   <td class="mlabels-right">

  2531. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2532.   </tr>

  2533. </table>

  2534. </div><div class="memdoc">

  2535. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2536. <dl class="params"><dt>Parameters</dt><dd>

  2537.   <table class="params">

  2538.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2539.   </table>

  2540.   </dd>

  2541. </dl>

  2542. <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>

  2543. 

  2544. </div>

  2545. </div>

  2546. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2547. <div class="memitem">

  2548. <div class="memproto">

  2549. <table class="mlabels">

  2550.   <tr>

  2551.   <td class="mlabels-left">

  2552.       <table class="memname">

  2553.         <tr>

  2554.           <td class="memname">int FatFile::read </td>

  2555.           <td>(</td>

  2556.           <td class="paramname"></td><td>)</td>

  2557.           <td></td>

  2558.         </tr>

  2559.       </table>

  2560.   </td>

  2561.   <td class="mlabels-right">

  2562. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2563.   </tr>

  2564. </table>

  2565. </div><div class="memdoc">

  2566. <p>Read the next byte from a file.</p>

  2567. <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>

  2568. 

  2569. </div>

  2570. </div>

  2571. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2572. <div class="memitem">

  2573. <div class="memproto">

  2574. <table class="mlabels">

  2575.   <tr>

  2576.   <td class="mlabels-left">

  2577.       <table class="memname">

  2578.         <tr>

  2579.           <td class="memname">int FatFile::read </td>

  2580.           <td>(</td>

  2581.           <td class="paramtype">void *&#160;</td>

  2582.           <td class="paramname"><em>buf</em>, </td>

  2583.         </tr>

  2584.         <tr>

  2585.           <td class="paramkey"></td>

  2586.           <td></td>

  2587.           <td class="paramtype">size_t&#160;</td>

  2588.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2589.         </tr>

  2590.         <tr>

  2591.           <td></td>

  2592.           <td>)</td>

  2593.           <td></td><td></td>

  2594.         </tr>

  2595.       </table>

  2596.   </td>

  2597.   <td class="mlabels-right">

  2598. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2599.   </tr>

  2600. </table>

  2601. </div><div class="memdoc">

  2602. <p>Read data from a file starting at the current position.</p>

  2603. <dl class="params"><dt>Parameters</dt><dd>

  2604.   <table class="params">

  2605.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2606.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2607.   </table>

  2608.   </dd>

  2609. </dl>

  2610. <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>

  2611. 

  2612. </div>

  2613. </div>

  2614. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2615. <div class="memitem">

  2616. <div class="memproto">

  2617. <table class="mlabels">

  2618.   <tr>

  2619.   <td class="mlabels-left">

  2620.       <table class="memname">

  2621.         <tr>

  2622.           <td class="memname">int8_t FatFile::readDir </td>

  2623.           <td>(</td>

  2624.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2625.           <td class="paramname"><em>dir</em></td><td>)</td>

  2626.           <td></td>

  2627.         </tr>

  2628.       </table>

  2629.   </td>

  2630.   <td class="mlabels-right">

  2631. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2632.   </tr>

  2633. </table>

  2634. </div><div class="memdoc">

  2635. <p>Read the next directory entry from a directory file.</p>

  2636. <dl class="params"><dt>Parameters</dt><dd>

  2637.   <table class="params">

  2638.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2639.   </table>

  2640.   </dd>

  2641. </dl>

  2642. <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>

  2643. 

  2644. </div>

  2645. </div>

  2646. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2647. <div class="memitem">

  2648. <div class="memproto">

  2649. <table class="mlabels">

  2650.   <tr>

  2651.   <td class="mlabels-left">

  2652.       <table class="memname">

  2653.         <tr>

  2654.           <td class="memname">bool FatFile::remove </td>

  2655.           <td>(</td>

  2656.           <td class="paramname"></td><td>)</td>

  2657.           <td></td>

  2658.         </tr>

  2659.       </table>

  2660.   </td>

  2661.   <td class="mlabels-right">

  2662. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2663.   </tr>

  2664. </table>

  2665. </div><div class="memdoc">

  2666. <p>Remove a file.</p>

  2667. <p>The directory entry and all data for the file are deleted.</p>

  2668. <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>

  2669. <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>

  2670. 

  2671. </div>

  2672. </div>

  2673. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2674. <div class="memitem">

  2675. <div class="memproto">

  2676. <table class="mlabels">

  2677.   <tr>

  2678.   <td class="mlabels-left">

  2679.       <table class="memname">

  2680.         <tr>

  2681.           <td class="memname">bool FatFile::remove </td>

  2682.           <td>(</td>

  2683.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2684.           <td class="paramname"><em>dirFile</em>, </td>

  2685.         </tr>

  2686.         <tr>

  2687.           <td class="paramkey"></td>

  2688.           <td></td>

  2689.           <td class="paramtype">const char *&#160;</td>

  2690.           <td class="paramname"><em>path</em>&#160;</td>

  2691.         </tr>

  2692.         <tr>

  2693.           <td></td>

  2694.           <td>)</td>

  2695.           <td></td><td></td>

  2696.         </tr>

  2697.       </table>

  2698.   </td>

  2699.   <td class="mlabels-right">

  2700. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2701.   </tr>

  2702. </table>

  2703. </div><div class="memdoc">

  2704. <p>Remove a file.</p>

  2705. <p>The directory entry and all data for the file are deleted.</p>

  2706. <dl class="params"><dt>Parameters</dt><dd>

  2707.   <table class="params">

  2708.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2709.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2710.   </table>

  2711.   </dd>

  2712. </dl>

  2713. <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>

  2714. <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>

  2715. 

  2716. </div>

  2717. </div>

  2718. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2719. <div class="memitem">

  2720. <div class="memproto">

  2721. <table class="mlabels">

  2722.   <tr>

  2723.   <td class="mlabels-left">

  2724.       <table class="memname">

  2725.         <tr>

  2726.           <td class="memname">bool FatFile::rename </td>

  2727.           <td>(</td>

  2728.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2729.           <td class="paramname"><em>dirFile</em>, </td>

  2730.         </tr>

  2731.         <tr>

  2732.           <td class="paramkey"></td>

  2733.           <td></td>

  2734.           <td class="paramtype">const char *&#160;</td>

  2735.           <td class="paramname"><em>newPath</em>&#160;</td>

  2736.         </tr>

  2737.         <tr>

  2738.           <td></td>

  2739.           <td>)</td>

  2740.           <td></td><td></td>

  2741.         </tr>

  2742.       </table>

  2743.   </td>

  2744.   <td class="mlabels-right">

  2745. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2746.   </tr>

  2747. </table>

  2748. </div><div class="memdoc">

  2749. <p>Rename a file or subdirectory.</p>

  2750. <dl class="params"><dt>Parameters</dt><dd>

  2751.   <table class="params">

  2752.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2753.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2754.   </table>

  2755.   </dd>

  2756. </dl>

  2757. <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>

  2758. 

  2759. </div>

  2760. </div>

  2761. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2762. <div class="memitem">

  2763. <div class="memproto">

  2764. <table class="mlabels">

  2765.   <tr>

  2766.   <td class="mlabels-left">

  2767.       <table class="memname">

  2768.         <tr>

  2769.           <td class="memname">void FatFile::rewind </td>

  2770.           <td>(</td>

  2771.           <td class="paramname"></td><td>)</td>

  2772.           <td></td>

  2773.         </tr>

  2774.       </table>

  2775.   </td>

  2776.   <td class="mlabels-right">

  2777. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2778.   </tr>

  2779. </table>

  2780. </div><div class="memdoc">

  2781. <p>Set the file's current position to zero. </p>

  2782. 

  2783. </div>

  2784. </div>

  2785. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2786. <div class="memitem">

  2787. <div class="memproto">

  2788. <table class="mlabels">

  2789.   <tr>

  2790.   <td class="mlabels-left">

  2791.       <table class="memname">

  2792.         <tr>

  2793.           <td class="memname">bool FatFile::rmdir </td>

  2794.           <td>(</td>

  2795.           <td class="paramname"></td><td>)</td>

  2796.           <td></td>

  2797.         </tr>

  2798.       </table>

  2799.   </td>

  2800.   <td class="mlabels-right">

  2801. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2802.   </tr>

  2803. </table>

  2804. </div><div class="memdoc">

  2805. <p>Remove a directory file.</p>

  2806. <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>

  2807. <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>

  2808. <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>

  2809. 

  2810. </div>

  2811. </div>

  2812. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2813. <div class="memitem">

  2814. <div class="memproto">

  2815. <table class="mlabels">

  2816.   <tr>

  2817.   <td class="mlabels-left">

  2818.       <table class="memname">

  2819.         <tr>

  2820.           <td class="memname">bool FatFile::rmRfStar </td>

  2821.           <td>(</td>

  2822.           <td class="paramname"></td><td>)</td>

  2823.           <td></td>

  2824.         </tr>

  2825.       </table>

  2826.   </td>

  2827.   <td class="mlabels-right">

  2828. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2829.   </tr>

  2830. </table>

  2831. </div><div class="memdoc">

  2832. <p>Recursively delete a directory and all contained files.</p>

  2833. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2834. <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>

  2835. <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>

  2836. <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>

  2837. 

  2838. </div>

  2839. </div>

  2840. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2841. <div class="memitem">

  2842. <div class="memproto">

  2843. <table class="mlabels">

  2844.   <tr>

  2845.   <td class="mlabels-left">

  2846.       <table class="memname">

  2847.         <tr>

  2848.           <td class="memname">bool FatFile::seekCur </td>

  2849.           <td>(</td>

  2850.           <td class="paramtype">int32_t&#160;</td>

  2851.           <td class="paramname"><em>offset</em></td><td>)</td>

  2852.           <td></td>

  2853.         </tr>

  2854.       </table>

  2855.   </td>

  2856.   <td class="mlabels-right">

  2857. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2858.   </tr>

  2859. </table>

  2860. </div><div class="memdoc">

  2861. <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>

  2862.   <table class="params">

  2863.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2864.   </table>

  2865.   </dd>

  2866. </dl>

  2867. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2868. 

  2869. </div>

  2870. </div>

  2871. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2872. <div class="memitem">

  2873. <div class="memproto">

  2874. <table class="mlabels">

  2875.   <tr>

  2876.   <td class="mlabels-left">

  2877.       <table class="memname">

  2878.         <tr>

  2879.           <td class="memname">bool FatFile::seekEnd </td>

  2880.           <td>(</td>

  2881.           <td class="paramtype">int32_t&#160;</td>

  2882.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2883.           <td></td>

  2884.         </tr>

  2885.       </table>

  2886.   </td>

  2887.   <td class="mlabels-right">

  2888. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2889.   </tr>

  2890. </table>

  2891. </div><div class="memdoc">

  2892. <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>

  2893.   <table class="params">

  2894.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2895.   </table>

  2896.   </dd>

  2897. </dl>

  2898. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2899. 

  2900. </div>

  2901. </div>

  2902. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2903. <div class="memitem">

  2904. <div class="memproto">

  2905. <table class="mlabels">

  2906.   <tr>

  2907.   <td class="mlabels-left">

  2908.       <table class="memname">

  2909.         <tr>

  2910.           <td class="memname">bool FatFile::seekSet </td>

  2911.           <td>(</td>

  2912.           <td class="paramtype">uint32_t&#160;</td>

  2913.           <td class="paramname"><em>pos</em></td><td>)</td>

  2914.           <td></td>

  2915.         </tr>

  2916.       </table>

  2917.   </td>

  2918.   <td class="mlabels-right">

  2919. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2920.   </tr>

  2921. </table>

  2922. </div><div class="memdoc">

  2923. <p>Sets a file's position.</p>

  2924. <dl class="params"><dt>Parameters</dt><dd>

  2925.   <table class="params">

  2926.     <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>

  2927.   </table>

  2928.   </dd>

  2929. </dl>

  2930. <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>

  2931. 

  2932. </div>

  2933. </div>

  2934. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2935. <div class="memitem">

  2936. <div class="memproto">

  2937. <table class="mlabels">

  2938.   <tr>

  2939.   <td class="mlabels-left">

  2940.       <table class="memname">

  2941.         <tr>

  2942.           <td class="memname">static bool FatFile::setCwd </td>

  2943.           <td>(</td>

  2944.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2945.           <td class="paramname"><em>dir</em></td><td>)</td>

  2946.           <td></td>

  2947.         </tr>

  2948.       </table>

  2949.   </td>

  2950.   <td class="mlabels-right">

  2951. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2952.   </tr>

  2953. </table>

  2954. </div><div class="memdoc">

  2955. <p>Set the current working directory.</p>

  2956. <dl class="params"><dt>Parameters</dt><dd>

  2957.   <table class="params">

  2958.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2959.   </table>

  2960.   </dd>

  2961. </dl>

  2962. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2963. 

  2964. </div>

  2965. </div>

  2966. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2967. <div class="memitem">

  2968. <div class="memproto">

  2969. <table class="mlabels">

  2970.   <tr>

  2971.   <td class="mlabels-left">

  2972.       <table class="memname">

  2973.         <tr>

  2974.           <td class="memname">void FatFile::setpos </td>

  2975.           <td>(</td>

  2976.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2977.           <td class="paramname"><em>pos</em></td><td>)</td>

  2978.           <td></td>

  2979.         </tr>

  2980.       </table>

  2981.   </td>

  2982.   <td class="mlabels-right">

  2983. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2984.   </tr>

  2985. </table>

  2986. </div><div class="memdoc">

  2987. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2988.   <table class="params">

  2989.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2990.   </table>

  2991.   </dd>

  2992. </dl>

  2993. 

  2994. </div>

  2995. </div>

  2996. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2997. <div class="memitem">

  2998. <div class="memproto">

  2999. <table class="mlabels">

  3000.   <tr>

  3001.   <td class="mlabels-left">

  3002.       <table class="memname">

  3003.         <tr>

  3004.           <td class="memname">bool FatFile::sync </td>

  3005.           <td>(</td>

  3006.           <td class="paramname"></td><td>)</td>

  3007.           <td></td>

  3008.         </tr>

  3009.       </table>

  3010.   </td>

  3011.   <td class="mlabels-right">

  3012. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3013.   </tr>

  3014. </table>

  3015. </div><div class="memdoc">

  3016. <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>

  3017. <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>

  3018. 

  3019. </div>

  3020. </div>

  3021. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  3022. <div class="memitem">

  3023. <div class="memproto">

  3024. <table class="mlabels">

  3025.   <tr>

  3026.   <td class="mlabels-left">

  3027.       <table class="memname">

  3028.         <tr>

  3029.           <td class="memname">bool FatFile::timestamp </td>

  3030.           <td>(</td>

  3031.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3032.           <td class="paramname"><em>file</em></td><td>)</td>

  3033.           <td></td>

  3034.         </tr>

  3035.       </table>

  3036.   </td>

  3037.   <td class="mlabels-right">

  3038. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3039.   </tr>

  3040. </table>

  3041. </div><div class="memdoc">

  3042. <p>Copy a file's timestamps</p>

  3043. <dl class="params"><dt>Parameters</dt><dd>

  3044.   <table class="params">

  3045.     <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>

  3046.   </table>

  3047.   </dd>

  3048. </dl>

  3049. <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>

  3050. <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>

  3051. 

  3052. </div>

  3053. </div>

  3054. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3055. <div class="memitem">

  3056. <div class="memproto">

  3057. <table class="mlabels">

  3058.   <tr>

  3059.   <td class="mlabels-left">

  3060.       <table class="memname">

  3061.         <tr>

  3062.           <td class="memname">bool FatFile::timestamp </td>

  3063.           <td>(</td>

  3064.           <td class="paramtype">uint8_t&#160;</td>

  3065.           <td class="paramname"><em>flags</em>, </td>

  3066.         </tr>

  3067.         <tr>

  3068.           <td class="paramkey"></td>

  3069.           <td></td>

  3070.           <td class="paramtype">uint16_t&#160;</td>

  3071.           <td class="paramname"><em>year</em>, </td>

  3072.         </tr>

  3073.         <tr>

  3074.           <td class="paramkey"></td>

  3075.           <td></td>

  3076.           <td class="paramtype">uint8_t&#160;</td>

  3077.           <td class="paramname"><em>month</em>, </td>

  3078.         </tr>

  3079.         <tr>

  3080.           <td class="paramkey"></td>

  3081.           <td></td>

  3082.           <td class="paramtype">uint8_t&#160;</td>

  3083.           <td class="paramname"><em>day</em>, </td>

  3084.         </tr>

  3085.         <tr>

  3086.           <td class="paramkey"></td>

  3087.           <td></td>

  3088.           <td class="paramtype">uint8_t&#160;</td>

  3089.           <td class="paramname"><em>hour</em>, </td>

  3090.         </tr>

  3091.         <tr>

  3092.           <td class="paramkey"></td>

  3093.           <td></td>

  3094.           <td class="paramtype">uint8_t&#160;</td>

  3095.           <td class="paramname"><em>minute</em>, </td>

  3096.         </tr>

  3097.         <tr>

  3098.           <td class="paramkey"></td>

  3099.           <td></td>

  3100.           <td class="paramtype">uint8_t&#160;</td>

  3101.           <td class="paramname"><em>second</em>&#160;</td>

  3102.         </tr>

  3103.         <tr>

  3104.           <td></td>

  3105.           <td>)</td>

  3106.           <td></td><td></td>

  3107.         </tr>

  3108.       </table>

  3109.   </td>

  3110.   <td class="mlabels-right">

  3111. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3112.   </tr>

  3113. </table>

  3114. </div><div class="memdoc">

  3115. <p>Set a file's timestamps in its directory entry.</p>

  3116. <dl class="params"><dt>Parameters</dt><dd>

  3117.   <table class="params">

  3118.     <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>

  3119.   </table>

  3120.   </dd>

  3121. </dl>

  3122. <p>T_ACCESS - Set the file's last access date.</p>

  3123. <p>T_CREATE - Set the file's creation date and time.</p>

  3124. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3125. <dl class="params"><dt>Parameters</dt><dd>

  3126.   <table class="params">

  3127.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3128.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3129.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3130.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3131.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3132.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3133.   </table>

  3134.   </dd>

  3135. </dl>

  3136. <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>

  3137. <dd>

  3138. 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>

  3139. <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>

  3140. 

  3141. </div>

  3142. </div>

  3143. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3144. <div class="memitem">

  3145. <div class="memproto">

  3146. <table class="mlabels">

  3147.   <tr>

  3148.   <td class="mlabels-left">

  3149.       <table class="memname">

  3150.         <tr>

  3151.           <td class="memname">bool FatFile::truncate </td>

  3152.           <td>(</td>

  3153.           <td class="paramtype">uint32_t&#160;</td>

  3154.           <td class="paramname"><em>length</em></td><td>)</td>

  3155.           <td></td>

  3156.         </tr>

  3157.       </table>

  3158.   </td>

  3159.   <td class="mlabels-right">

  3160. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3161.   </tr>

  3162. </table>

  3163. </div><div class="memdoc">

  3164. <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>

  3165. <dl class="params"><dt>Parameters</dt><dd>

  3166.   <table class="params">

  3167.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3168.   </table>

  3169.   </dd>

  3170. </dl>

  3171. <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>

  3172. 

  3173. </div>

  3174. </div>

  3175. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3176. <div class="memitem">

  3177. <div class="memproto">

  3178. <table class="mlabels">

  3179.   <tr>

  3180.   <td class="mlabels-left">

  3181.       <table class="memname">

  3182.         <tr>

  3183.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3184.           <td>(</td>

  3185.           <td class="paramname"></td><td>)</td>

  3186.           <td> const</td>

  3187.         </tr>

  3188.       </table>

  3189.   </td>

  3190.   <td class="mlabels-right">

  3191. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3192.   </tr>

  3193. </table>

  3194. </div><div class="memdoc">

  3195. <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>

  3196. 

  3197. </div>

  3198. </div>

  3199. <a class="anchor" id="a460b033ff85e85f684f8d9b615645db1"></a>

  3200. <div class="memitem">

  3201. <div class="memproto">

  3202. <table class="mlabels">

  3203.   <tr>

  3204.   <td class="mlabels-left">

  3205.       <table class="memname">

  3206.         <tr>

  3207.           <td class="memname">size_t PrintFile::write </td>

  3208.           <td>(</td>

  3209.           <td class="paramtype">uint8_t&#160;</td>

  3210.           <td class="paramname"><em>b</em></td><td>)</td>

  3211.           <td></td>

  3212.         </tr>

  3213.       </table>

  3214.   </td>

  3215.   <td class="mlabels-right">

  3216. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3217.   </tr>

  3218. </table>

  3219. </div><div class="memdoc">

  3220. <p>Read the next byte from a file.</p>

  3221. <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>

  3222. <dl class="params"><dt>Parameters</dt><dd>

  3223.   <table class="params">

  3224.     <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>

  3225.   </table>

  3226.   </dd>

  3227. </dl>

  3228. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3229. 

  3230. </div>

  3231. </div>

  3232. <a class="anchor" id="a29c1d534d21c3a82ad04232d37119a57"></a>

  3233. <div class="memitem">

  3234. <div class="memproto">

  3235. <table class="mlabels">

  3236.   <tr>

  3237.   <td class="mlabels-left">

  3238.       <table class="memname">

  3239.         <tr>

  3240.           <td class="memname">size_t PrintFile::write </td>

  3241.           <td>(</td>

  3242.           <td class="paramtype">const uint8_t *&#160;</td>

  3243.           <td class="paramname"><em>buf</em>, </td>

  3244.         </tr>

  3245.         <tr>

  3246.           <td class="paramkey"></td>

  3247.           <td></td>

  3248.           <td class="paramtype">size_t&#160;</td>

  3249.           <td class="paramname"><em>size</em>&#160;</td>

  3250.         </tr>

  3251.         <tr>

  3252.           <td></td>

  3253.           <td>)</td>

  3254.           <td></td><td></td>

  3255.         </tr>

  3256.       </table>

  3257.   </td>

  3258.   <td class="mlabels-right">

  3259. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3260.   </tr>

  3261. </table>

  3262. </div><div class="memdoc">

  3263. <p>Write data to an open file. Form required by Print.</p>

  3264. <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>

  3265. <dl class="params"><dt>Parameters</dt><dd>

  3266.   <table class="params">

  3267.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3268.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3269.   </table>

  3270.   </dd>

  3271. </dl>

  3272. <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>

  3273. 

  3274. </div>

  3275. </div>

  3276. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3277. <div class="memitem">

  3278. <div class="memproto">

  3279. <table class="mlabels">

  3280.   <tr>

  3281.   <td class="mlabels-left">

  3282.       <table class="memname">

  3283.         <tr>

  3284.           <td class="memname">int FatFile::write </td>

  3285.           <td>(</td>

  3286.           <td class="paramtype">const char *&#160;</td>

  3287.           <td class="paramname"><em>str</em></td><td>)</td>

  3288.           <td></td>

  3289.         </tr>

  3290.       </table>

  3291.   </td>

  3292.   <td class="mlabels-right">

  3293. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3294.   </tr>

  3295. </table>

  3296. </div><div class="memdoc">

  3297. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3298.   <table class="params">

  3299.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3300.   </table>

  3301.   </dd>

  3302. </dl>

  3303. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3304. 

  3305. </div>

  3306. </div>

  3307. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3308. <div class="memitem">

  3309. <div class="memproto">

  3310. <table class="mlabels">

  3311.   <tr>

  3312.   <td class="mlabels-left">

  3313.       <table class="memname">

  3314.         <tr>

  3315.           <td class="memname">int FatFile::write </td>

  3316.           <td>(</td>

  3317.           <td class="paramtype">const void *&#160;</td>

  3318.           <td class="paramname"><em>buf</em>, </td>

  3319.         </tr>

  3320.         <tr>

  3321.           <td class="paramkey"></td>

  3322.           <td></td>

  3323.           <td class="paramtype">size_t&#160;</td>

  3324.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3325.         </tr>

  3326.         <tr>

  3327.           <td></td>

  3328.           <td>)</td>

  3329.           <td></td><td></td>

  3330.         </tr>

  3331.       </table>

  3332.   </td>

  3333.   <td class="mlabels-right">

  3334. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3335.   </tr>

  3336. </table>

  3337. </div><div class="memdoc">

  3338. <p>Write data to an open file.</p>

  3339. <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>

  3340. <dl class="params"><dt>Parameters</dt><dd>

  3341.   <table class="params">

  3342.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3343.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3344.   </table>

  3345.   </dd>

  3346. </dl>

  3347. <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>

  3348. 

  3349. </div>

  3350. </div>

  3351. <hr/>The documentation for this class was generated from the following file:<ul>

  3352. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_arduino_files_8h.html">ArduinoFiles.h</a></li>

  3353. </ul>

  3354. </div><!-- contents -->

  3355. <!-- start footer part -->

  3356. <hr class="footer"/><address class="footer"><small>

  3357. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3358. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3359. </a> 1.8.10

  3360. </small></address>

  3361. </body>

  3362. </html>