visus
/
teensy-sdfat
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Tickets 0 Demandes d'ajout 0 Versions 0 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
32 Révisions
1 Branche
Aborescence: 9c407b3e9f
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '9c407b3e9f'
${ noResults }
teensy-sdfat/html/class_sd_file.html

3364 lines
148KB
Brut Annotations Historique 

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Class for backward compatibility.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for SdFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_print_file.html" title="FatFile with Print. " alt="" coords="41,80,112,107"/>

  103. <area shape="rect" id="node3" 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 SdFile:</div>

  108. <div class="dyncontent">

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

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

  111. <area shape="rect" id="node2" href="class_print_file.html" title="FatFile with Print. " alt="" coords="41,80,112,107"/>

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

  113. </map>

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

  115. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  301. </table>

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

  303. <div class="textblock"><p>Class for backward compatibility. </p>

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

  305. <a class="anchor" id="aca7da9858a5e53e10f3c2fa9aeca8485"></a>

  306. <div class="memitem">

  307. <div class="memproto">

  308. <table class="mlabels">

  309.   <tr>

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

  311.       <table class="memname">

  312.         <tr>

  313.           <td class="memname">SdFile::SdFile </td>

  314.           <td>(</td>

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

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

  317.         </tr>

  318.         <tr>

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

  320.           <td></td>

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

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

  323.         </tr>

  324.         <tr>

  325.           <td></td>

  326.           <td>)</td>

  327.           <td></td><td></td>

  328.         </tr>

  329.       </table>

  330.   </td>

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

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

  333.   </tr>

  334. </table>

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

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

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

  338.   <table class="params">

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

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

  341.   </table>

  342.   </dd>

  343. </dl>

  344. 

  345. </div>

  346. </div>

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

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

  349. <div class="memitem">

  350. <div class="memproto">

  351. <table class="mlabels">

  352.   <tr>

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

  354.       <table class="memname">

  355.         <tr>

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

  357.           <td>(</td>

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

  359.           <td></td>

  360.         </tr>

  361.       </table>

  362.   </td>

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

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

  365.   </tr>

  366. </table>

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

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

  369. 

  370. </div>

  371. </div>

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

  373. <div class="memitem">

  374. <div class="memproto">

  375. <table class="mlabels">

  376.   <tr>

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

  378.       <table class="memname">

  379.         <tr>

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

  381.           <td>(</td>

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

  383.           <td></td>

  384.         </tr>

  385.       </table>

  386.   </td>

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

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

  389.   </tr>

  390. </table>

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

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

  393. 

  394. </div>

  395. </div>

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

  397. <div class="memitem">

  398. <div class="memproto">

  399. <table class="mlabels">

  400.   <tr>

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

  402.       <table class="memname">

  403.         <tr>

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

  405.           <td>(</td>

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

  407.           <td></td>

  408.         </tr>

  409.       </table>

  410.   </td>

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

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

  413.   </tr>

  414. </table>

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

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

  417. 

  418. </div>

  419. </div>

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

  421. <div class="memitem">

  422. <div class="memproto">

  423. <table class="mlabels">

  424.   <tr>

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

  426.       <table class="memname">

  427.         <tr>

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

  429.           <td>(</td>

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

  431.           <td></td>

  432.         </tr>

  433.       </table>

  434.   </td>

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

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

  437.   </tr>

  438. </table>

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

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

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

  442. 

  443. </div>

  444. </div>

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

  446. <div class="memitem">

  447. <div class="memproto">

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

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

  454.           <td>(</td>

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

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

  457.         </tr>

  458.         <tr>

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

  460.           <td></td>

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

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

  463.         </tr>

  464.         <tr>

  465.           <td></td>

  466.           <td>)</td>

  467.           <td></td><td></td>

  468.         </tr>

  469.       </table>

  470.   </td>

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

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

  473.   </tr>

  474. </table>

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

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

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

  478.   <table class="params">

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

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

  481.   </table>

  482.   </dd>

  483. </dl>

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

  485. 

  486. </div>

  487. </div>

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

  489. <div class="memitem">

  490. <div class="memproto">

  491. <table class="mlabels">

  492.   <tr>

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

  494.       <table class="memname">

  495.         <tr>

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

  497.           <td>(</td>

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

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

  500.         </tr>

  501.         <tr>

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

  503.           <td></td>

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

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

  506.         </tr>

  507.         <tr>

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

  509.           <td></td>

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

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

  512.         </tr>

  513.         <tr>

  514.           <td></td>

  515.           <td>)</td>

  516.           <td></td><td></td>

  517.         </tr>

  518.       </table>

  519.   </td>

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

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

  522.   </tr>

  523. </table>

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

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

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

  527.   <table class="params">

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

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

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

  531.   </table>

  532.   </dd>

  533. </dl>

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

  535. 

  536. </div>

  537. </div>

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

  539. <div class="memitem">

  540. <div class="memproto">

  541. <table class="mlabels">

  542.   <tr>

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

  544.       <table class="memname">

  545.         <tr>

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

  547.           <td>(</td>

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

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

  550.         </tr>

  551.         <tr>

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

  553.           <td></td>

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

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

  556.         </tr>

  557.         <tr>

  558.           <td></td>

  559.           <td>)</td>

  560.           <td></td><td></td>

  561.         </tr>

  562.       </table>

  563.   </td>

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

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

  566.   </tr>

  567. </table>

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

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

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

  571.   <table class="params">

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

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

  574.   </table>

  575.   </dd>

  576. </dl>

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

  578. 

  579. </div>

  580. </div>

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

  582. <div class="memitem">

  583. <div class="memproto">

  584. <table class="mlabels">

  585.   <tr>

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

  587.       <table class="memname">

  588.         <tr>

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

  590.           <td>(</td>

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

  592.           <td> const</td>

  593.         </tr>

  594.       </table>

  595.   </td>

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

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

  598.   </tr>

  599. </table>

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

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

  602. 

  603. </div>

  604. </div>

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

  606. <div class="memitem">

  607. <div class="memproto">

  608. <table class="mlabels">

  609.   <tr>

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

  611.       <table class="memname">

  612.         <tr>

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

  614.           <td>(</td>

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

  616.           <td> const</td>

  617.         </tr>

  618.       </table>

  619.   </td>

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

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

  622.   </tr>

  623. </table>

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

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

  626. 

  627. </div>

  628. </div>

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

  630. <div class="memitem">

  631. <div class="memproto">

  632. <table class="mlabels">

  633.   <tr>

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

  635.       <table class="memname">

  636.         <tr>

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

  638.           <td>(</td>

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

  640.           <td></td>

  641.         </tr>

  642.       </table>

  643.   </td>

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

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

  646.   </tr>

  647. </table>

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

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

  650. 

  651. </div>

  652. </div>

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

  654. <div class="memitem">

  655. <div class="memproto">

  656. <table class="mlabels">

  657.   <tr>

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

  659.       <table class="memname">

  660.         <tr>

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

  662.           <td>(</td>

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

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

  665.           <td></td>

  666.         </tr>

  667.       </table>

  668.   </td>

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

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

  671.   </tr>

  672. </table>

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

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

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

  676.   <table class="params">

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

  678.   </table>

  679.   </dd>

  680. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  695. 

  696. </div>

  697. </div>

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

  699. <div class="memitem">

  700. <div class="memproto">

  701. <table class="mlabels">

  702.   <tr>

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

  704.       <table class="memname">

  705.         <tr>

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

  707.           <td>(</td>

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

  709.           <td></td>

  710.         </tr>

  711.       </table>

  712.   </td>

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

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

  715.   </tr>

  716. </table>

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

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

  719. 

  720. </div>

  721. </div>

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

  723. <div class="memitem">

  724. <div class="memproto">

  725. <table class="mlabels">

  726.   <tr>

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

  728.       <table class="memname">

  729.         <tr>

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

  731.           <td>(</td>

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

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

  734.           <td></td>

  735.         </tr>

  736.       </table>

  737.   </td>

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

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

  740.   </tr>

  741. </table>

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

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

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

  745.   <table class="params">

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

  747.   </table>

  748.   </dd>

  749. </dl>

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

  751. 

  752. </div>

  753. </div>

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

  755. <div class="memitem">

  756. <div class="memproto">

  757. <table class="mlabels">

  758.   <tr>

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

  760.       <table class="memname">

  761.         <tr>

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

  763.           <td>(</td>

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

  765.           <td></td>

  766.         </tr>

  767.       </table>

  768.   </td>

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

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

  771.   </tr>

  772. </table>

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

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

  775. 

  776. </div>

  777. </div>

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

  779. <div class="memitem">

  780. <div class="memproto">

  781. <table class="mlabels">

  782.   <tr>

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

  784.       <table class="memname">

  785.         <tr>

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

  787.           <td>(</td>

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

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

  790.         </tr>

  791.         <tr>

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

  793.           <td></td>

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

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

  796.         </tr>

  797.         <tr>

  798.           <td></td>

  799.           <td>)</td>

  800.           <td></td><td></td>

  801.         </tr>

  802.       </table>

  803.   </td>

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

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

  806.   </tr>

  807. </table>

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

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

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

  811.   <table class="params">

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

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

  814.   </table>

  815.   </dd>

  816. </dl>

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

  818. 

  819. </div>

  820. </div>

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

  822. <div class="memitem">

  823. <div class="memproto">

  824. <table class="mlabels">

  825.   <tr>

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

  827.       <table class="memname">

  828.         <tr>

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

  830.           <td>(</td>

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

  832.           <td></td>

  833.         </tr>

  834.       </table>

  835.   </td>

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

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

  838.   </tr>

  839. </table>

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

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

  842. 

  843. </div>

  844. </div>

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

  846. <div class="memitem">

  847. <div class="memproto">

  848. <table class="mlabels">

  849.   <tr>

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

  851.       <table class="memname">

  852.         <tr>

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

  854.           <td>(</td>

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

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

  857.         </tr>

  858.         <tr>

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

  860.           <td></td>

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

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

  863.         </tr>

  864.         <tr>

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

  866.           <td></td>

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

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

  869.         </tr>

  870.         <tr>

  871.           <td></td>

  872.           <td>)</td>

  873.           <td></td><td></td>

  874.         </tr>

  875.       </table>

  876.   </td>

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

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

  879.   </tr>

  880. </table>

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

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

  883.   <table class="params">

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

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

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

  887.   </table>

  888.   </dd>

  889. </dl>

  890. 

  891. </div>

  892. </div>

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

  894. <div class="memitem">

  895. <div class="memproto">

  896. <table class="mlabels">

  897.   <tr>

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

  899.       <table class="memname">

  900.         <tr>

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

  902.           <td>(</td>

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

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

  905.           <td></td>

  906.         </tr>

  907.       </table>

  908.   </td>

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

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

  911.   </tr>

  912. </table>

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

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

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

  916.   <table class="params">

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

  918.   </table>

  919.   </dd>

  920. </dl>

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

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

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

  924. 

  925. </div>

  926. </div>

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

  928. <div class="memitem">

  929. <div class="memproto">

  930. <table class="mlabels">

  931.   <tr>

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

  933.       <table class="memname">

  934.         <tr>

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

  936.           <td>(</td>

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

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

  939.         </tr>

  940.         <tr>

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

  942.           <td></td>

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

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

  945.         </tr>

  946.         <tr>

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

  948.           <td></td>

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

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

  951.         </tr>

  952.         <tr>

  953.           <td></td>

  954.           <td>)</td>

  955.           <td></td><td></td>

  956.         </tr>

  957.       </table>

  958.   </td>

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

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

  961.   </tr>

  962. </table>

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

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

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

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

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

  968.   <table class="params">

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

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

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

  972.   </table>

  973.   </dd>

  974. </dl>

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

  976. 

  977. </div>

  978. </div>

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

  980. <div class="memitem">

  981. <div class="memproto">

  982. <table class="mlabels">

  983.   <tr>

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

  985.       <table class="memname">

  986.         <tr>

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

  988.           <td>(</td>

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

  990.           <td> const</td>

  991.         </tr>

  992.       </table>

  993.   </td>

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

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

  996.   </tr>

  997. </table>

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

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

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

  1001. 

  1002. </div>

  1003. </div>

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

  1005. <div class="memitem">

  1006. <div class="memproto">

  1007. <table class="mlabels">

  1008.   <tr>

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

  1010.       <table class="memname">

  1011.         <tr>

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

  1013.           <td>(</td>

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

  1015.           <td> const</td>

  1016.         </tr>

  1017.       </table>

  1018.   </td>

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

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

  1021.   </tr>

  1022. </table>

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

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

  1025. 

  1026. </div>

  1027. </div>

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

  1029. <div class="memitem">

  1030. <div class="memproto">

  1031. <table class="mlabels">

  1032.   <tr>

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

  1034.       <table class="memname">

  1035.         <tr>

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

  1037.           <td>(</td>

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

  1039.           <td></td>

  1040.         </tr>

  1041.       </table>

  1042.   </td>

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

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

  1045.   </tr>

  1046. </table>

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

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

  1049. 

  1050. </div>

  1051. </div>

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

  1053. <div class="memitem">

  1054. <div class="memproto">

  1055. <table class="mlabels">

  1056.   <tr>

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

  1058.       <table class="memname">

  1059.         <tr>

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

  1061.           <td>(</td>

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

  1063.           <td> const</td>

  1064.         </tr>

  1065.       </table>

  1066.   </td>

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

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

  1069.   </tr>

  1070. </table>

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

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

  1073. 

  1074. </div>

  1075. </div>

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

  1077. <div class="memitem">

  1078. <div class="memproto">

  1079. <table class="mlabels">

  1080.   <tr>

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

  1082.       <table class="memname">

  1083.         <tr>

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

  1085.           <td>(</td>

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

  1087.           <td></td>

  1088.         </tr>

  1089.       </table>

  1090.   </td>

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

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

  1093.   </tr>

  1094. </table>

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

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

  1097. 

  1098. </div>

  1099. </div>

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

  1101. <div class="memitem">

  1102. <div class="memproto">

  1103. <table class="mlabels">

  1104.   <tr>

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

  1106.       <table class="memname">

  1107.         <tr>

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

  1109.           <td>(</td>

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

  1111.           <td></td>

  1112.         </tr>

  1113.       </table>

  1114.   </td>

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

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

  1117.   </tr>

  1118. </table>

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

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

  1121. 

  1122. </div>

  1123. </div>

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

  1125. <div class="memitem">

  1126. <div class="memproto">

  1127. <table class="mlabels">

  1128.   <tr>

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

  1130.       <table class="memname">

  1131.         <tr>

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

  1133.           <td>(</td>

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

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

  1136.         </tr>

  1137.         <tr>

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

  1139.           <td></td>

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

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

  1142.         </tr>

  1143.         <tr>

  1144.           <td></td>

  1145.           <td>)</td>

  1146.           <td></td><td></td>

  1147.         </tr>

  1148.       </table>

  1149.   </td>

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

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

  1152.   </tr>

  1153. </table>

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

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

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

  1157.   <table class="params">

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

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

  1160.   </table>

  1161.   </dd>

  1162. </dl>

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

  1164. 

  1165. </div>

  1166. </div>

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

  1168. <div class="memitem">

  1169. <div class="memproto">

  1170. <table class="mlabels">

  1171.   <tr>

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

  1173.       <table class="memname">

  1174.         <tr>

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

  1176.           <td>(</td>

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

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

  1179.           <td></td>

  1180.         </tr>

  1181.       </table>

  1182.   </td>

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

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

  1185.   </tr>

  1186. </table>

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

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

  1189.   <table class="params">

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

  1191.   </table>

  1192.   </dd>

  1193. </dl>

  1194. 

  1195. </div>

  1196. </div>

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

  1198. <div class="memitem">

  1199. <div class="memproto">

  1200. <table class="mlabels">

  1201.   <tr>

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

  1203.       <table class="memname">

  1204.         <tr>

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

  1206.           <td>(</td>

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

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

  1209.           <td></td>

  1210.         </tr>

  1211.       </table>

  1212.   </td>

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

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

  1215.   </tr>

  1216. </table>

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

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

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

  1220.   <table class="params">

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

  1222.   </table>

  1223.   </dd>

  1224. </dl>

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

  1226. 

  1227. </div>

  1228. </div>

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

  1230. <div class="memitem">

  1231. <div class="memproto">

  1232. <table class="mlabels">

  1233.   <tr>

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

  1235.       <table class="memname">

  1236.         <tr>

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

  1238.           <td>(</td>

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

  1240.           <td></td>

  1241.         </tr>

  1242.       </table>

  1243.   </td>

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

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

  1246.   </tr>

  1247. </table>

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

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

  1250. 

  1251. </div>

  1252. </div>

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

  1254. <div class="memitem">

  1255. <div class="memproto">

  1256. <table class="mlabels">

  1257.   <tr>

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

  1259.       <table class="memname">

  1260.         <tr>

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

  1262.           <td>(</td>

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

  1264.           <td> const</td>

  1265.         </tr>

  1266.       </table>

  1267.   </td>

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

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

  1270.   </tr>

  1271. </table>

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

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

  1274. 

  1275. </div>

  1276. </div>

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

  1278. <div class="memitem">

  1279. <div class="memproto">

  1280. <table class="mlabels">

  1281.   <tr>

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

  1283.       <table class="memname">

  1284.         <tr>

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

  1286.           <td>(</td>

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

  1288.           <td> const</td>

  1289.         </tr>

  1290.       </table>

  1291.   </td>

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

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

  1294.   </tr>

  1295. </table>

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

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

  1298. 

  1299. </div>

  1300. </div>

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

  1302. <div class="memitem">

  1303. <div class="memproto">

  1304. <table class="mlabels">

  1305.   <tr>

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

  1307.       <table class="memname">

  1308.         <tr>

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

  1310.           <td>(</td>

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

  1312.           <td> const</td>

  1313.         </tr>

  1314.       </table>

  1315.   </td>

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

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

  1318.   </tr>

  1319. </table>

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

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

  1322. 

  1323. </div>

  1324. </div>

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

  1326. <div class="memitem">

  1327. <div class="memproto">

  1328. <table class="mlabels">

  1329.   <tr>

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

  1331.       <table class="memname">

  1332.         <tr>

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

  1334.           <td>(</td>

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

  1336.           <td> const</td>

  1337.         </tr>

  1338.       </table>

  1339.   </td>

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

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

  1342.   </tr>

  1343. </table>

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

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

  1346. 

  1347. </div>

  1348. </div>

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

  1350. <div class="memitem">

  1351. <div class="memproto">

  1352. <table class="mlabels">

  1353.   <tr>

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

  1355.       <table class="memname">

  1356.         <tr>

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

  1358.           <td>(</td>

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

  1360.           <td> const</td>

  1361.         </tr>

  1362.       </table>

  1363.   </td>

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

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

  1366.   </tr>

  1367. </table>

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

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

  1370. 

  1371. </div>

  1372. </div>

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

  1374. <div class="memitem">

  1375. <div class="memproto">

  1376. <table class="mlabels">

  1377.   <tr>

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

  1379.       <table class="memname">

  1380.         <tr>

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

  1382.           <td>(</td>

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

  1384.           <td> const</td>

  1385.         </tr>

  1386.       </table>

  1387.   </td>

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

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

  1390.   </tr>

  1391. </table>

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

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

  1394. 

  1395. </div>

  1396. </div>

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

  1398. <div class="memitem">

  1399. <div class="memproto">

  1400. <table class="mlabels">

  1401.   <tr>

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

  1403.       <table class="memname">

  1404.         <tr>

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

  1406.           <td>(</td>

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

  1408.           <td> const</td>

  1409.         </tr>

  1410.       </table>

  1411.   </td>

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

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

  1414.   </tr>

  1415. </table>

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

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

  1418. 

  1419. </div>

  1420. </div>

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

  1422. <div class="memitem">

  1423. <div class="memproto">

  1424. <table class="mlabels">

  1425.   <tr>

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

  1427.       <table class="memname">

  1428.         <tr>

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

  1430.           <td>(</td>

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

  1432.           <td> const</td>

  1433.         </tr>

  1434.       </table>

  1435.   </td>

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

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

  1438.   </tr>

  1439. </table>

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

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

  1442. 

  1443. </div>

  1444. </div>

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

  1446. <div class="memitem">

  1447. <div class="memproto">

  1448. <table class="mlabels">

  1449.   <tr>

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

  1451.       <table class="memname">

  1452.         <tr>

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

  1454.           <td>(</td>

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

  1456.           <td> const</td>

  1457.         </tr>

  1458.       </table>

  1459.   </td>

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

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

  1462.   </tr>

  1463. </table>

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

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

  1466. 

  1467. </div>

  1468. </div>

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

  1470. <div class="memitem">

  1471. <div class="memproto">

  1472. <table class="mlabels">

  1473.   <tr>

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

  1475.       <table class="memname">

  1476.         <tr>

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

  1478.           <td>(</td>

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

  1480.           <td> const</td>

  1481.         </tr>

  1482.       </table>

  1483.   </td>

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

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

  1486.   </tr>

  1487. </table>

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

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

  1490. 

  1491. </div>

  1492. </div>

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

  1494. <div class="memitem">

  1495. <div class="memproto">

  1496. <table class="mlabels">

  1497.   <tr>

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

  1499.       <table class="memname">

  1500.         <tr>

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

  1502.           <td>(</td>

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

  1504.           <td> const</td>

  1505.         </tr>

  1506.       </table>

  1507.   </td>

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

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

  1510.   </tr>

  1511. </table>

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

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

  1514. 

  1515. </div>

  1516. </div>

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

  1518. <div class="memitem">

  1519. <div class="memproto">

  1520. <table class="mlabels">

  1521.   <tr>

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

  1523.       <table class="memname">

  1524.         <tr>

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

  1526.           <td>(</td>

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

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

  1529.           <td></td>

  1530.         </tr>

  1531.       </table>

  1532.   </td>

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

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

  1535.   </tr>

  1536. </table>

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

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

  1539.   <table class="params">

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

  1541.   </table>

  1542.   </dd>

  1543. </dl>

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

  1545. 

  1546. </div>

  1547. </div>

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

  1549. <div class="memitem">

  1550. <div class="memproto">

  1551. <table class="mlabels">

  1552.   <tr>

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

  1554.       <table class="memname">

  1555.         <tr>

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

  1557.           <td>(</td>

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

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

  1560.           <td></td>

  1561.         </tr>

  1562.       </table>

  1563.   </td>

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

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

  1566.   </tr>

  1567. </table>

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

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

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

  1571.   <table class="params">

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

  1573.   </table>

  1574.   </dd>

  1575. </dl>

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

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

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

  1579. 

  1580. </div>

  1581. </div>

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

  1583. <div class="memitem">

  1584. <div class="memproto">

  1585. <table class="mlabels">

  1586.   <tr>

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

  1588.       <table class="memname">

  1589.         <tr>

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

  1591.           <td>(</td>

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

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

  1594.         </tr>

  1595.         <tr>

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

  1597.           <td></td>

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

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

  1600.         </tr>

  1601.         <tr>

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

  1603.           <td></td>

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

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

  1606.         </tr>

  1607.         <tr>

  1608.           <td></td>

  1609.           <td>)</td>

  1610.           <td></td><td></td>

  1611.         </tr>

  1612.       </table>

  1613.   </td>

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

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

  1616.   </tr>

  1617. </table>

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

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

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

  1621.   <table class="params">

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

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

  1624.   </table>

  1625.   </dd>

  1626. </dl>

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

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

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

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

  1631.   <table class="params">

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

  1633.   </table>

  1634.   </dd>

  1635. </dl>

  1636. 

  1637. </div>

  1638. </div>

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

  1640. <div class="memitem">

  1641. <div class="memproto">

  1642. <table class="mlabels">

  1643.   <tr>

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

  1645.       <table class="memname">

  1646.         <tr>

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

  1648.           <td>(</td>

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

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

  1651.         </tr>

  1652.         <tr>

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

  1654.           <td></td>

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

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

  1657.         </tr>

  1658.         <tr>

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

  1660.           <td></td>

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

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

  1663.         </tr>

  1664.         <tr>

  1665.           <td></td>

  1666.           <td>)</td>

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

  1668.         </tr>

  1669.       </table>

  1670.   </td>

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

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

  1673.   </tr>

  1674. </table>

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

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

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

  1678.   <table class="params">

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

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

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

  1682.   </table>

  1683.   </dd>

  1684. </dl>

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

  1686. 

  1687. </div>

  1688. </div>

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

  1690. <div class="memitem">

  1691. <div class="memproto">

  1692. <table class="mlabels">

  1693.   <tr>

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

  1695.       <table class="memname">

  1696.         <tr>

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

  1698.           <td>(</td>

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

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

  1701.         </tr>

  1702.         <tr>

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

  1704.           <td></td>

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

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

  1707.         </tr>

  1708.         <tr>

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

  1710.           <td></td>

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

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

  1713.         </tr>

  1714.         <tr>

  1715.           <td></td>

  1716.           <td>)</td>

  1717.           <td></td><td></td>

  1718.         </tr>

  1719.       </table>

  1720.   </td>

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

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

  1723.   </tr>

  1724. </table>

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

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

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

  1728.   <table class="params">

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

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

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

  1732.   </table>

  1733.   </dd>

  1734. </dl>

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

  1736. 

  1737. </div>

  1738. </div>

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

  1740. <div class="memitem">

  1741. <div class="memproto">

  1742. <table class="mlabels">

  1743.   <tr>

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

  1745.       <table class="memname">

  1746.         <tr>

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

  1748.           <td>(</td>

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

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

  1751.         </tr>

  1752.         <tr>

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

  1754.           <td></td>

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

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

  1757.         </tr>

  1758.         <tr>

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

  1760.           <td></td>

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

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

  1763.         </tr>

  1764.         <tr>

  1765.           <td></td>

  1766.           <td>)</td>

  1767.           <td></td><td></td>

  1768.         </tr>

  1769.       </table>

  1770.   </td>

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

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

  1773.   </tr>

  1774. </table>

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

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

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

  1778.   <table class="params">

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

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

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

  1782.   </table>

  1783.   </dd>

  1784. </dl>

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

  1786. 

  1787. </div>

  1788. </div>

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

  1790. <div class="memitem">

  1791. <div class="memproto">

  1792. <table class="mlabels">

  1793.   <tr>

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

  1795.       <table class="memname">

  1796.         <tr>

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

  1798.           <td>(</td>

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

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

  1801.         </tr>

  1802.         <tr>

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

  1804.           <td></td>

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

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

  1807.         </tr>

  1808.         <tr>

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

  1810.           <td></td>

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

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

  1813.         </tr>

  1814.         <tr>

  1815.           <td></td>

  1816.           <td>)</td>

  1817.           <td></td><td></td>

  1818.         </tr>

  1819.       </table>

  1820.   </td>

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

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

  1823.   </tr>

  1824. </table>

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

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

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

  1828.   <table class="params">

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

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

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

  1832.   </table>

  1833.   </dd>

  1834. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1849. 

  1850. </div>

  1851. </div>

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

  1853. <div class="memitem">

  1854. <div class="memproto">

  1855. <table class="mlabels">

  1856.   <tr>

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

  1858.       <table class="memname">

  1859.         <tr>

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

  1861.           <td>(</td>

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

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

  1864.         </tr>

  1865.         <tr>

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

  1867.           <td></td>

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

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

  1870.         </tr>

  1871.         <tr>

  1872.           <td></td>

  1873.           <td>)</td>

  1874.           <td></td><td></td>

  1875.         </tr>

  1876.       </table>

  1877.   </td>

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

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

  1880.   </tr>

  1881. </table>

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

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

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

  1885.   <table class="params">

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

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

  1888.   </table>

  1889.   </dd>

  1890. </dl>

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

  1892. 

  1893. </div>

  1894. </div>

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

  1896. <div class="memitem">

  1897. <div class="memproto">

  1898. <table class="mlabels">

  1899.   <tr>

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

  1901.       <table class="memname">

  1902.         <tr>

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

  1904.           <td>(</td>

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

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

  1907.         </tr>

  1908.         <tr>

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

  1910.           <td></td>

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

  1912.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1913.         </tr>

  1914.         <tr>

  1915.           <td></td>

  1916.           <td>)</td>

  1917.           <td></td><td></td>

  1918.         </tr>

  1919.       </table>

  1920.   </td>

  1921.   <td class="mlabels-right">

  1922. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1923.   </tr>

  1924. </table>

  1925. </div><div class="memdoc">

  1926. <p>Open the next file or subdirectory in a directory.</p>

  1927. <dl class="params"><dt>Parameters</dt><dd>

  1928.   <table class="params">

  1929.     <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>

  1930.     <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>

  1931.   </table>

  1932.   </dd>

  1933. </dl>

  1934. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1935. 

  1936. </div>

  1937. </div>

  1938. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1939. <div class="memitem">

  1940. <div class="memproto">

  1941. <table class="mlabels">

  1942.   <tr>

  1943.   <td class="mlabels-left">

  1944.       <table class="memname">

  1945.         <tr>

  1946.           <td class="memname">bool FatFile::openRoot </td>

  1947.           <td>(</td>

  1948.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1949.           <td class="paramname"><em>vol</em></td><td>)</td>

  1950.           <td></td>

  1951.         </tr>

  1952.       </table>

  1953.   </td>

  1954.   <td class="mlabels-right">

  1955. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1956.   </tr>

  1957. </table>

  1958. </div><div class="memdoc">

  1959. <p>Open a volume's root directory.</p>

  1960. <dl class="params"><dt>Parameters</dt><dd>

  1961.   <table class="params">

  1962.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1963.   </table>

  1964.   </dd>

  1965. </dl>

  1966. <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>

  1967. 

  1968. </div>

  1969. </div>

  1970. <a class="anchor" id="a3a2a66f4a0cb69ab4edc66d39997fda7"></a>

  1971. <div class="memitem">

  1972. <div class="memproto">

  1973. <table class="mlabels">

  1974.   <tr>

  1975.   <td class="mlabels-left">

  1976.       <table class="memname">

  1977.         <tr>

  1978.           <td class="memname">int PrintFile::peek </td>

  1979.           <td>(</td>

  1980.           <td class="paramname"></td><td>)</td>

  1981.           <td></td>

  1982.         </tr>

  1983.       </table>

  1984.   </td>

  1985.   <td class="mlabels-right">

  1986. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1987.   </tr>

  1988. </table>

  1989. </div><div class="memdoc">

  1990. <p>Return the next available byte without consuming it.</p>

  1991. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1992. 

  1993. </div>

  1994. </div>

  1995. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1996. <div class="memitem">

  1997. <div class="memproto">

  1998. <table class="mlabels">

  1999.   <tr>

  2000.   <td class="mlabels-left">

  2001.       <table class="memname">

  2002.         <tr>

  2003.           <td class="memname">bool FatFile::printCreateDateTime </td>

  2004.           <td>(</td>

  2005.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2006.           <td class="paramname"><em>pr</em></td><td>)</td>

  2007.           <td></td>

  2008.         </tr>

  2009.       </table>

  2010.   </td>

  2011.   <td class="mlabels-right">

  2012. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2013.   </tr>

  2014. </table>

  2015. </div><div class="memdoc">

  2016. <p>Print a file's creation date and time</p>

  2017. <dl class="params"><dt>Parameters</dt><dd>

  2018.   <table class="params">

  2019.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2020.   </table>

  2021.   </dd>

  2022. </dl>

  2023. <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>

  2024. 

  2025. </div>

  2026. </div>

  2027. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  2028. <div class="memitem">

  2029. <div class="memproto">

  2030. <table class="mlabels">

  2031.   <tr>

  2032.   <td class="mlabels-left">

  2033.       <table class="memname">

  2034.         <tr>

  2035.           <td class="memname">static void FatFile::printFatDate </td>

  2036.           <td>(</td>

  2037.           <td class="paramtype">uint16_t&#160;</td>

  2038.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  2039.           <td></td>

  2040.         </tr>

  2041.       </table>

  2042.   </td>

  2043.   <td class="mlabels-right">

  2044. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2045.   </tr>

  2046. </table>

  2047. </div><div class="memdoc">

  2048. <p>Print a directory date field.</p>

  2049. <p>Format is yyyy-mm-dd.</p>

  2050. <dl class="params"><dt>Parameters</dt><dd>

  2051.   <table class="params">

  2052.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2053.   </table>

  2054.   </dd>

  2055. </dl>

  2056. 

  2057. </div>

  2058. </div>

  2059. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  2060. <div class="memitem">

  2061. <div class="memproto">

  2062. <table class="mlabels">

  2063.   <tr>

  2064.   <td class="mlabels-left">

  2065.       <table class="memname">

  2066.         <tr>

  2067.           <td class="memname">void FatFile::printFatDate </td>

  2068.           <td>(</td>

  2069.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2070.           <td class="paramname"><em>pr</em>, </td>

  2071.         </tr>

  2072.         <tr>

  2073.           <td class="paramkey"></td>

  2074.           <td></td>

  2075.           <td class="paramtype">uint16_t&#160;</td>

  2076.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2077.         </tr>

  2078.         <tr>

  2079.           <td></td>

  2080.           <td>)</td>

  2081.           <td></td><td></td>

  2082.         </tr>

  2083.       </table>

  2084.   </td>

  2085.   <td class="mlabels-right">

  2086. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2087.   </tr>

  2088. </table>

  2089. </div><div class="memdoc">

  2090. <p>Print a directory date field.</p>

  2091. <p>Format is yyyy-mm-dd.</p>

  2092. <dl class="params"><dt>Parameters</dt><dd>

  2093.   <table class="params">

  2094.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2095.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2096.   </table>

  2097.   </dd>

  2098. </dl>

  2099. 

  2100. </div>

  2101. </div>

  2102. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2103. <div class="memitem">

  2104. <div class="memproto">

  2105. <table class="mlabels">

  2106.   <tr>

  2107.   <td class="mlabels-left">

  2108.       <table class="memname">

  2109.         <tr>

  2110.           <td class="memname">static void FatFile::printFatTime </td>

  2111.           <td>(</td>

  2112.           <td class="paramtype">uint16_t&#160;</td>

  2113.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2114.           <td></td>

  2115.         </tr>

  2116.       </table>

  2117.   </td>

  2118.   <td class="mlabels-right">

  2119. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2120.   </tr>

  2121. </table>

  2122. </div><div class="memdoc">

  2123. <p>Print a directory time field.</p>

  2124. <p>Format is hh:mm:ss.</p>

  2125. <dl class="params"><dt>Parameters</dt><dd>

  2126.   <table class="params">

  2127.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2128.   </table>

  2129.   </dd>

  2130. </dl>

  2131. 

  2132. </div>

  2133. </div>

  2134. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2135. <div class="memitem">

  2136. <div class="memproto">

  2137. <table class="mlabels">

  2138.   <tr>

  2139.   <td class="mlabels-left">

  2140.       <table class="memname">

  2141.         <tr>

  2142.           <td class="memname">void FatFile::printFatTime </td>

  2143.           <td>(</td>

  2144.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2145.           <td class="paramname"><em>pr</em>, </td>

  2146.         </tr>

  2147.         <tr>

  2148.           <td class="paramkey"></td>

  2149.           <td></td>

  2150.           <td class="paramtype">uint16_t&#160;</td>

  2151.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2152.         </tr>

  2153.         <tr>

  2154.           <td></td>

  2155.           <td>)</td>

  2156.           <td></td><td></td>

  2157.         </tr>

  2158.       </table>

  2159.   </td>

  2160.   <td class="mlabels-right">

  2161. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2162.   </tr>

  2163. </table>

  2164. </div><div class="memdoc">

  2165. <p>Print a directory time field.</p>

  2166. <p>Format is hh:mm:ss.</p>

  2167. <dl class="params"><dt>Parameters</dt><dd>

  2168.   <table class="params">

  2169.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2170.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2171.   </table>

  2172.   </dd>

  2173. </dl>

  2174. 

  2175. </div>

  2176. </div>

  2177. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2178. <div class="memitem">

  2179. <div class="memproto">

  2180. <table class="mlabels">

  2181.   <tr>

  2182.   <td class="mlabels-left">

  2183.       <table class="memname">

  2184.         <tr>

  2185.           <td class="memname">int FatFile::printField </td>

  2186.           <td>(</td>

  2187.           <td class="paramtype">float&#160;</td>

  2188.           <td class="paramname"><em>value</em>, </td>

  2189.         </tr>

  2190.         <tr>

  2191.           <td class="paramkey"></td>

  2192.           <td></td>

  2193.           <td class="paramtype">char&#160;</td>

  2194.           <td class="paramname"><em>term</em>, </td>

  2195.         </tr>

  2196.         <tr>

  2197.           <td class="paramkey"></td>

  2198.           <td></td>

  2199.           <td class="paramtype">uint8_t&#160;</td>

  2200.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2201.         </tr>

  2202.         <tr>

  2203.           <td></td>

  2204.           <td>)</td>

  2205.           <td></td><td></td>

  2206.         </tr>

  2207.       </table>

  2208.   </td>

  2209.   <td class="mlabels-right">

  2210. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2211.   </tr>

  2212. </table>

  2213. </div><div class="memdoc">

  2214. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2215.   <table class="params">

  2216.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2217.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2218.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2219.   </table>

  2220.   </dd>

  2221. </dl>

  2222. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2223. 

  2224. </div>

  2225. </div>

  2226. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2227. <div class="memitem">

  2228. <div class="memproto">

  2229. <table class="mlabels">

  2230.   <tr>

  2231.   <td class="mlabels-left">

  2232.       <table class="memname">

  2233.         <tr>

  2234.           <td class="memname">int FatFile::printField </td>

  2235.           <td>(</td>

  2236.           <td class="paramtype">int16_t&#160;</td>

  2237.           <td class="paramname"><em>value</em>, </td>

  2238.         </tr>

  2239.         <tr>

  2240.           <td class="paramkey"></td>

  2241.           <td></td>

  2242.           <td class="paramtype">char&#160;</td>

  2243.           <td class="paramname"><em>term</em>&#160;</td>

  2244.         </tr>

  2245.         <tr>

  2246.           <td></td>

  2247.           <td>)</td>

  2248.           <td></td><td></td>

  2249.         </tr>

  2250.       </table>

  2251.   </td>

  2252.   <td class="mlabels-right">

  2253. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2254.   </tr>

  2255. </table>

  2256. </div><div class="memdoc">

  2257. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2258.   <table class="params">

  2259.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2260.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2261.   </table>

  2262.   </dd>

  2263. </dl>

  2264. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2265. 

  2266. </div>

  2267. </div>

  2268. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2269. <div class="memitem">

  2270. <div class="memproto">

  2271. <table class="mlabels">

  2272.   <tr>

  2273.   <td class="mlabels-left">

  2274.       <table class="memname">

  2275.         <tr>

  2276.           <td class="memname">int FatFile::printField </td>

  2277.           <td>(</td>

  2278.           <td class="paramtype">uint16_t&#160;</td>

  2279.           <td class="paramname"><em>value</em>, </td>

  2280.         </tr>

  2281.         <tr>

  2282.           <td class="paramkey"></td>

  2283.           <td></td>

  2284.           <td class="paramtype">char&#160;</td>

  2285.           <td class="paramname"><em>term</em>&#160;</td>

  2286.         </tr>

  2287.         <tr>

  2288.           <td></td>

  2289.           <td>)</td>

  2290.           <td></td><td></td>

  2291.         </tr>

  2292.       </table>

  2293.   </td>

  2294.   <td class="mlabels-right">

  2295. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2296.   </tr>

  2297. </table>

  2298. </div><div class="memdoc">

  2299. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2300.   <table class="params">

  2301.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2302.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2303.   </table>

  2304.   </dd>

  2305. </dl>

  2306. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2307. 

  2308. </div>

  2309. </div>

  2310. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2311. <div class="memitem">

  2312. <div class="memproto">

  2313. <table class="mlabels">

  2314.   <tr>

  2315.   <td class="mlabels-left">

  2316.       <table class="memname">

  2317.         <tr>

  2318.           <td class="memname">int FatFile::printField </td>

  2319.           <td>(</td>

  2320.           <td class="paramtype">int32_t&#160;</td>

  2321.           <td class="paramname"><em>value</em>, </td>

  2322.         </tr>

  2323.         <tr>

  2324.           <td class="paramkey"></td>

  2325.           <td></td>

  2326.           <td class="paramtype">char&#160;</td>

  2327.           <td class="paramname"><em>term</em>&#160;</td>

  2328.         </tr>

  2329.         <tr>

  2330.           <td></td>

  2331.           <td>)</td>

  2332.           <td></td><td></td>

  2333.         </tr>

  2334.       </table>

  2335.   </td>

  2336.   <td class="mlabels-right">

  2337. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2338.   </tr>

  2339. </table>

  2340. </div><div class="memdoc">

  2341. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2342.   <table class="params">

  2343.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2344.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2345.   </table>

  2346.   </dd>

  2347. </dl>

  2348. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2349. 

  2350. </div>

  2351. </div>

  2352. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2353. <div class="memitem">

  2354. <div class="memproto">

  2355. <table class="mlabels">

  2356.   <tr>

  2357.   <td class="mlabels-left">

  2358.       <table class="memname">

  2359.         <tr>

  2360.           <td class="memname">int FatFile::printField </td>

  2361.           <td>(</td>

  2362.           <td class="paramtype">uint32_t&#160;</td>

  2363.           <td class="paramname"><em>value</em>, </td>

  2364.         </tr>

  2365.         <tr>

  2366.           <td class="paramkey"></td>

  2367.           <td></td>

  2368.           <td class="paramtype">char&#160;</td>

  2369.           <td class="paramname"><em>term</em>&#160;</td>

  2370.         </tr>

  2371.         <tr>

  2372.           <td></td>

  2373.           <td>)</td>

  2374.           <td></td><td></td>

  2375.         </tr>

  2376.       </table>

  2377.   </td>

  2378.   <td class="mlabels-right">

  2379. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2380.   </tr>

  2381. </table>

  2382. </div><div class="memdoc">

  2383. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2384.   <table class="params">

  2385.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2386.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2387.   </table>

  2388.   </dd>

  2389. </dl>

  2390. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2391. 

  2392. </div>

  2393. </div>

  2394. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2395. <div class="memitem">

  2396. <div class="memproto">

  2397. <table class="mlabels">

  2398.   <tr>

  2399.   <td class="mlabels-left">

  2400.       <table class="memname">

  2401.         <tr>

  2402.           <td class="memname">size_t FatFile::printFileSize </td>

  2403.           <td>(</td>

  2404.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2405.           <td class="paramname"><em>pr</em></td><td>)</td>

  2406.           <td></td>

  2407.         </tr>

  2408.       </table>

  2409.   </td>

  2410.   <td class="mlabels-right">

  2411. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2412.   </tr>

  2413. </table>

  2414. </div><div class="memdoc">

  2415. <p>Print a file's size.</p>

  2416. <dl class="params"><dt>Parameters</dt><dd>

  2417.   <table class="params">

  2418.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2419.   </table>

  2420.   </dd>

  2421. </dl>

  2422. <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>

  2423. 

  2424. </div>

  2425. </div>

  2426. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2427. <div class="memitem">

  2428. <div class="memproto">

  2429. <table class="mlabels">

  2430.   <tr>

  2431.   <td class="mlabels-left">

  2432.       <table class="memname">

  2433.         <tr>

  2434.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2435.           <td>(</td>

  2436.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2437.           <td class="paramname"><em>pr</em></td><td>)</td>

  2438.           <td></td>

  2439.         </tr>

  2440.       </table>

  2441.   </td>

  2442.   <td class="mlabels-right">

  2443. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2444.   </tr>

  2445. </table>

  2446. </div><div class="memdoc">

  2447. <p>Print a file's modify date and time</p>

  2448. <dl class="params"><dt>Parameters</dt><dd>

  2449.   <table class="params">

  2450.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2451.   </table>

  2452.   </dd>

  2453. </dl>

  2454. <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>

  2455. 

  2456. </div>

  2457. </div>

  2458. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2459. <div class="memitem">

  2460. <div class="memproto">

  2461. <table class="mlabels">

  2462.   <tr>

  2463.   <td class="mlabels-left">

  2464.       <table class="memname">

  2465.         <tr>

  2466.           <td class="memname">size_t FatFile::printName </td>

  2467.           <td>(</td>

  2468.           <td class="paramname"></td><td>)</td>

  2469.           <td></td>

  2470.         </tr>

  2471.       </table>

  2472.   </td>

  2473.   <td class="mlabels-right">

  2474. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2475.   </tr>

  2476. </table>

  2477. </div><div class="memdoc">

  2478. <p>Print a file's name.</p>

  2479. <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>

  2480. 

  2481. </div>

  2482. </div>

  2483. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2484. <div class="memitem">

  2485. <div class="memproto">

  2486. <table class="mlabels">

  2487.   <tr>

  2488.   <td class="mlabels-left">

  2489.       <table class="memname">

  2490.         <tr>

  2491.           <td class="memname">size_t FatFile::printName </td>

  2492.           <td>(</td>

  2493.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2494.           <td class="paramname"><em>pr</em></td><td>)</td>

  2495.           <td></td>

  2496.         </tr>

  2497.       </table>

  2498.   </td>

  2499.   <td class="mlabels-right">

  2500. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2501.   </tr>

  2502. </table>

  2503. </div><div class="memdoc">

  2504. <p>Print a file's name</p>

  2505. <dl class="params"><dt>Parameters</dt><dd>

  2506.   <table class="params">

  2507.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2508.   </table>

  2509.   </dd>

  2510. </dl>

  2511. <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>

  2512. 

  2513. </div>

  2514. </div>

  2515. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2516. <div class="memitem">

  2517. <div class="memproto">

  2518. <table class="mlabels">

  2519.   <tr>

  2520.   <td class="mlabels-left">

  2521.       <table class="memname">

  2522.         <tr>

  2523.           <td class="memname">size_t FatFile::printSFN </td>

  2524.           <td>(</td>

  2525.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2526.           <td class="paramname"><em>pr</em></td><td>)</td>

  2527.           <td></td>

  2528.         </tr>

  2529.       </table>

  2530.   </td>

  2531.   <td class="mlabels-right">

  2532. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2533.   </tr>

  2534. </table>

  2535. </div><div class="memdoc">

  2536. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2537. <dl class="params"><dt>Parameters</dt><dd>

  2538.   <table class="params">

  2539.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2540.   </table>

  2541.   </dd>

  2542. </dl>

  2543. <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>

  2544. 

  2545. </div>

  2546. </div>

  2547. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2548. <div class="memitem">

  2549. <div class="memproto">

  2550. <table class="mlabels">

  2551.   <tr>

  2552.   <td class="mlabels-left">

  2553.       <table class="memname">

  2554.         <tr>

  2555.           <td class="memname">int FatFile::read </td>

  2556.           <td>(</td>

  2557.           <td class="paramname"></td><td>)</td>

  2558.           <td></td>

  2559.         </tr>

  2560.       </table>

  2561.   </td>

  2562.   <td class="mlabels-right">

  2563. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2564.   </tr>

  2565. </table>

  2566. </div><div class="memdoc">

  2567. <p>Read the next byte from a file.</p>

  2568. <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>

  2569. 

  2570. </div>

  2571. </div>

  2572. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2573. <div class="memitem">

  2574. <div class="memproto">

  2575. <table class="mlabels">

  2576.   <tr>

  2577.   <td class="mlabels-left">

  2578.       <table class="memname">

  2579.         <tr>

  2580.           <td class="memname">int FatFile::read </td>

  2581.           <td>(</td>

  2582.           <td class="paramtype">void *&#160;</td>

  2583.           <td class="paramname"><em>buf</em>, </td>

  2584.         </tr>

  2585.         <tr>

  2586.           <td class="paramkey"></td>

  2587.           <td></td>

  2588.           <td class="paramtype">size_t&#160;</td>

  2589.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2590.         </tr>

  2591.         <tr>

  2592.           <td></td>

  2593.           <td>)</td>

  2594.           <td></td><td></td>

  2595.         </tr>

  2596.       </table>

  2597.   </td>

  2598.   <td class="mlabels-right">

  2599. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2600.   </tr>

  2601. </table>

  2602. </div><div class="memdoc">

  2603. <p>Read data from a file starting at the current position.</p>

  2604. <dl class="params"><dt>Parameters</dt><dd>

  2605.   <table class="params">

  2606.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2607.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2608.   </table>

  2609.   </dd>

  2610. </dl>

  2611. <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>

  2612. 

  2613. </div>

  2614. </div>

  2615. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2616. <div class="memitem">

  2617. <div class="memproto">

  2618. <table class="mlabels">

  2619.   <tr>

  2620.   <td class="mlabels-left">

  2621.       <table class="memname">

  2622.         <tr>

  2623.           <td class="memname">int8_t FatFile::readDir </td>

  2624.           <td>(</td>

  2625.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2626.           <td class="paramname"><em>dir</em></td><td>)</td>

  2627.           <td></td>

  2628.         </tr>

  2629.       </table>

  2630.   </td>

  2631.   <td class="mlabels-right">

  2632. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2633.   </tr>

  2634. </table>

  2635. </div><div class="memdoc">

  2636. <p>Read the next directory entry from a directory file.</p>

  2637. <dl class="params"><dt>Parameters</dt><dd>

  2638.   <table class="params">

  2639.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2640.   </table>

  2641.   </dd>

  2642. </dl>

  2643. <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>

  2644. 

  2645. </div>

  2646. </div>

  2647. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2648. <div class="memitem">

  2649. <div class="memproto">

  2650. <table class="mlabels">

  2651.   <tr>

  2652.   <td class="mlabels-left">

  2653.       <table class="memname">

  2654.         <tr>

  2655.           <td class="memname">bool FatFile::remove </td>

  2656.           <td>(</td>

  2657.           <td class="paramname"></td><td>)</td>

  2658.           <td></td>

  2659.         </tr>

  2660.       </table>

  2661.   </td>

  2662.   <td class="mlabels-right">

  2663. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2664.   </tr>

  2665. </table>

  2666. </div><div class="memdoc">

  2667. <p>Remove a file.</p>

  2668. <p>The directory entry and all data for the file are deleted.</p>

  2669. <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>

  2670. <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>

  2671. 

  2672. </div>

  2673. </div>

  2674. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2675. <div class="memitem">

  2676. <div class="memproto">

  2677. <table class="mlabels">

  2678.   <tr>

  2679.   <td class="mlabels-left">

  2680.       <table class="memname">

  2681.         <tr>

  2682.           <td class="memname">bool FatFile::remove </td>

  2683.           <td>(</td>

  2684.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2685.           <td class="paramname"><em>dirFile</em>, </td>

  2686.         </tr>

  2687.         <tr>

  2688.           <td class="paramkey"></td>

  2689.           <td></td>

  2690.           <td class="paramtype">const char *&#160;</td>

  2691.           <td class="paramname"><em>path</em>&#160;</td>

  2692.         </tr>

  2693.         <tr>

  2694.           <td></td>

  2695.           <td>)</td>

  2696.           <td></td><td></td>

  2697.         </tr>

  2698.       </table>

  2699.   </td>

  2700.   <td class="mlabels-right">

  2701. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2702.   </tr>

  2703. </table>

  2704. </div><div class="memdoc">

  2705. <p>Remove a file.</p>

  2706. <p>The directory entry and all data for the file are deleted.</p>

  2707. <dl class="params"><dt>Parameters</dt><dd>

  2708.   <table class="params">

  2709.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2710.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2711.   </table>

  2712.   </dd>

  2713. </dl>

  2714. <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>

  2715. <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>

  2716. 

  2717. </div>

  2718. </div>

  2719. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2720. <div class="memitem">

  2721. <div class="memproto">

  2722. <table class="mlabels">

  2723.   <tr>

  2724.   <td class="mlabels-left">

  2725.       <table class="memname">

  2726.         <tr>

  2727.           <td class="memname">bool FatFile::rename </td>

  2728.           <td>(</td>

  2729.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2730.           <td class="paramname"><em>dirFile</em>, </td>

  2731.         </tr>

  2732.         <tr>

  2733.           <td class="paramkey"></td>

  2734.           <td></td>

  2735.           <td class="paramtype">const char *&#160;</td>

  2736.           <td class="paramname"><em>newPath</em>&#160;</td>

  2737.         </tr>

  2738.         <tr>

  2739.           <td></td>

  2740.           <td>)</td>

  2741.           <td></td><td></td>

  2742.         </tr>

  2743.       </table>

  2744.   </td>

  2745.   <td class="mlabels-right">

  2746. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2747.   </tr>

  2748. </table>

  2749. </div><div class="memdoc">

  2750. <p>Rename a file or subdirectory.</p>

  2751. <dl class="params"><dt>Parameters</dt><dd>

  2752.   <table class="params">

  2753.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2754.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2755.   </table>

  2756.   </dd>

  2757. </dl>

  2758. <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>

  2759. 

  2760. </div>

  2761. </div>

  2762. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2763. <div class="memitem">

  2764. <div class="memproto">

  2765. <table class="mlabels">

  2766.   <tr>

  2767.   <td class="mlabels-left">

  2768.       <table class="memname">

  2769.         <tr>

  2770.           <td class="memname">void FatFile::rewind </td>

  2771.           <td>(</td>

  2772.           <td class="paramname"></td><td>)</td>

  2773.           <td></td>

  2774.         </tr>

  2775.       </table>

  2776.   </td>

  2777.   <td class="mlabels-right">

  2778. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2779.   </tr>

  2780. </table>

  2781. </div><div class="memdoc">

  2782. <p>Set the file's current position to zero. </p>

  2783. 

  2784. </div>

  2785. </div>

  2786. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2787. <div class="memitem">

  2788. <div class="memproto">

  2789. <table class="mlabels">

  2790.   <tr>

  2791.   <td class="mlabels-left">

  2792.       <table class="memname">

  2793.         <tr>

  2794.           <td class="memname">bool FatFile::rmdir </td>

  2795.           <td>(</td>

  2796.           <td class="paramname"></td><td>)</td>

  2797.           <td></td>

  2798.         </tr>

  2799.       </table>

  2800.   </td>

  2801.   <td class="mlabels-right">

  2802. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2803.   </tr>

  2804. </table>

  2805. </div><div class="memdoc">

  2806. <p>Remove a directory file.</p>

  2807. <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>

  2808. <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>

  2809. <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>

  2810. 

  2811. </div>

  2812. </div>

  2813. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2814. <div class="memitem">

  2815. <div class="memproto">

  2816. <table class="mlabels">

  2817.   <tr>

  2818.   <td class="mlabels-left">

  2819.       <table class="memname">

  2820.         <tr>

  2821.           <td class="memname">bool FatFile::rmRfStar </td>

  2822.           <td>(</td>

  2823.           <td class="paramname"></td><td>)</td>

  2824.           <td></td>

  2825.         </tr>

  2826.       </table>

  2827.   </td>

  2828.   <td class="mlabels-right">

  2829. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2830.   </tr>

  2831. </table>

  2832. </div><div class="memdoc">

  2833. <p>Recursively delete a directory and all contained files.</p>

  2834. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2835. <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>

  2836. <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>

  2837. <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>

  2838. 

  2839. </div>

  2840. </div>

  2841. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2842. <div class="memitem">

  2843. <div class="memproto">

  2844. <table class="mlabels">

  2845.   <tr>

  2846.   <td class="mlabels-left">

  2847.       <table class="memname">

  2848.         <tr>

  2849.           <td class="memname">bool FatFile::seekCur </td>

  2850.           <td>(</td>

  2851.           <td class="paramtype">int32_t&#160;</td>

  2852.           <td class="paramname"><em>offset</em></td><td>)</td>

  2853.           <td></td>

  2854.         </tr>

  2855.       </table>

  2856.   </td>

  2857.   <td class="mlabels-right">

  2858. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2859.   </tr>

  2860. </table>

  2861. </div><div class="memdoc">

  2862. <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>

  2863.   <table class="params">

  2864.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2865.   </table>

  2866.   </dd>

  2867. </dl>

  2868. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2869. 

  2870. </div>

  2871. </div>

  2872. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2873. <div class="memitem">

  2874. <div class="memproto">

  2875. <table class="mlabels">

  2876.   <tr>

  2877.   <td class="mlabels-left">

  2878.       <table class="memname">

  2879.         <tr>

  2880.           <td class="memname">bool FatFile::seekEnd </td>

  2881.           <td>(</td>

  2882.           <td class="paramtype">int32_t&#160;</td>

  2883.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2884.           <td></td>

  2885.         </tr>

  2886.       </table>

  2887.   </td>

  2888.   <td class="mlabels-right">

  2889. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2890.   </tr>

  2891. </table>

  2892. </div><div class="memdoc">

  2893. <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>

  2894.   <table class="params">

  2895.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2896.   </table>

  2897.   </dd>

  2898. </dl>

  2899. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2900. 

  2901. </div>

  2902. </div>

  2903. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2904. <div class="memitem">

  2905. <div class="memproto">

  2906. <table class="mlabels">

  2907.   <tr>

  2908.   <td class="mlabels-left">

  2909.       <table class="memname">

  2910.         <tr>

  2911.           <td class="memname">bool FatFile::seekSet </td>

  2912.           <td>(</td>

  2913.           <td class="paramtype">uint32_t&#160;</td>

  2914.           <td class="paramname"><em>pos</em></td><td>)</td>

  2915.           <td></td>

  2916.         </tr>

  2917.       </table>

  2918.   </td>

  2919.   <td class="mlabels-right">

  2920. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2921.   </tr>

  2922. </table>

  2923. </div><div class="memdoc">

  2924. <p>Sets a file's position.</p>

  2925. <dl class="params"><dt>Parameters</dt><dd>

  2926.   <table class="params">

  2927.     <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>

  2928.   </table>

  2929.   </dd>

  2930. </dl>

  2931. <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>

  2932. 

  2933. </div>

  2934. </div>

  2935. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2936. <div class="memitem">

  2937. <div class="memproto">

  2938. <table class="mlabels">

  2939.   <tr>

  2940.   <td class="mlabels-left">

  2941.       <table class="memname">

  2942.         <tr>

  2943.           <td class="memname">static bool FatFile::setCwd </td>

  2944.           <td>(</td>

  2945.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2946.           <td class="paramname"><em>dir</em></td><td>)</td>

  2947.           <td></td>

  2948.         </tr>

  2949.       </table>

  2950.   </td>

  2951.   <td class="mlabels-right">

  2952. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2953.   </tr>

  2954. </table>

  2955. </div><div class="memdoc">

  2956. <p>Set the current working directory.</p>

  2957. <dl class="params"><dt>Parameters</dt><dd>

  2958.   <table class="params">

  2959.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2960.   </table>

  2961.   </dd>

  2962. </dl>

  2963. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2964. 

  2965. </div>

  2966. </div>

  2967. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2968. <div class="memitem">

  2969. <div class="memproto">

  2970. <table class="mlabels">

  2971.   <tr>

  2972.   <td class="mlabels-left">

  2973.       <table class="memname">

  2974.         <tr>

  2975.           <td class="memname">void FatFile::setpos </td>

  2976.           <td>(</td>

  2977.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2978.           <td class="paramname"><em>pos</em></td><td>)</td>

  2979.           <td></td>

  2980.         </tr>

  2981.       </table>

  2982.   </td>

  2983.   <td class="mlabels-right">

  2984. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2985.   </tr>

  2986. </table>

  2987. </div><div class="memdoc">

  2988. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2989.   <table class="params">

  2990.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2991.   </table>

  2992.   </dd>

  2993. </dl>

  2994. 

  2995. </div>

  2996. </div>

  2997. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2998. <div class="memitem">

  2999. <div class="memproto">

  3000. <table class="mlabels">

  3001.   <tr>

  3002.   <td class="mlabels-left">

  3003.       <table class="memname">

  3004.         <tr>

  3005.           <td class="memname">bool FatFile::sync </td>

  3006.           <td>(</td>

  3007.           <td class="paramname"></td><td>)</td>

  3008.           <td></td>

  3009.         </tr>

  3010.       </table>

  3011.   </td>

  3012.   <td class="mlabels-right">

  3013. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3014.   </tr>

  3015. </table>

  3016. </div><div class="memdoc">

  3017. <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>

  3018. <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>

  3019. 

  3020. </div>

  3021. </div>

  3022. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  3023. <div class="memitem">

  3024. <div class="memproto">

  3025. <table class="mlabels">

  3026.   <tr>

  3027.   <td class="mlabels-left">

  3028.       <table class="memname">

  3029.         <tr>

  3030.           <td class="memname">bool FatFile::timestamp </td>

  3031.           <td>(</td>

  3032.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3033.           <td class="paramname"><em>file</em></td><td>)</td>

  3034.           <td></td>

  3035.         </tr>

  3036.       </table>

  3037.   </td>

  3038.   <td class="mlabels-right">

  3039. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3040.   </tr>

  3041. </table>

  3042. </div><div class="memdoc">

  3043. <p>Copy a file's timestamps</p>

  3044. <dl class="params"><dt>Parameters</dt><dd>

  3045.   <table class="params">

  3046.     <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>

  3047.   </table>

  3048.   </dd>

  3049. </dl>

  3050. <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>

  3051. <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>

  3052. 

  3053. </div>

  3054. </div>

  3055. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3056. <div class="memitem">

  3057. <div class="memproto">

  3058. <table class="mlabels">

  3059.   <tr>

  3060.   <td class="mlabels-left">

  3061.       <table class="memname">

  3062.         <tr>

  3063.           <td class="memname">bool FatFile::timestamp </td>

  3064.           <td>(</td>

  3065.           <td class="paramtype">uint8_t&#160;</td>

  3066.           <td class="paramname"><em>flags</em>, </td>

  3067.         </tr>

  3068.         <tr>

  3069.           <td class="paramkey"></td>

  3070.           <td></td>

  3071.           <td class="paramtype">uint16_t&#160;</td>

  3072.           <td class="paramname"><em>year</em>, </td>

  3073.         </tr>

  3074.         <tr>

  3075.           <td class="paramkey"></td>

  3076.           <td></td>

  3077.           <td class="paramtype">uint8_t&#160;</td>

  3078.           <td class="paramname"><em>month</em>, </td>

  3079.         </tr>

  3080.         <tr>

  3081.           <td class="paramkey"></td>

  3082.           <td></td>

  3083.           <td class="paramtype">uint8_t&#160;</td>

  3084.           <td class="paramname"><em>day</em>, </td>

  3085.         </tr>

  3086.         <tr>

  3087.           <td class="paramkey"></td>

  3088.           <td></td>

  3089.           <td class="paramtype">uint8_t&#160;</td>

  3090.           <td class="paramname"><em>hour</em>, </td>

  3091.         </tr>

  3092.         <tr>

  3093.           <td class="paramkey"></td>

  3094.           <td></td>

  3095.           <td class="paramtype">uint8_t&#160;</td>

  3096.           <td class="paramname"><em>minute</em>, </td>

  3097.         </tr>

  3098.         <tr>

  3099.           <td class="paramkey"></td>

  3100.           <td></td>

  3101.           <td class="paramtype">uint8_t&#160;</td>

  3102.           <td class="paramname"><em>second</em>&#160;</td>

  3103.         </tr>

  3104.         <tr>

  3105.           <td></td>

  3106.           <td>)</td>

  3107.           <td></td><td></td>

  3108.         </tr>

  3109.       </table>

  3110.   </td>

  3111.   <td class="mlabels-right">

  3112. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3113.   </tr>

  3114. </table>

  3115. </div><div class="memdoc">

  3116. <p>Set a file's timestamps in its directory entry.</p>

  3117. <dl class="params"><dt>Parameters</dt><dd>

  3118.   <table class="params">

  3119.     <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>

  3120.   </table>

  3121.   </dd>

  3122. </dl>

  3123. <p>T_ACCESS - Set the file's last access date.</p>

  3124. <p>T_CREATE - Set the file's creation date and time.</p>

  3125. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3126. <dl class="params"><dt>Parameters</dt><dd>

  3127.   <table class="params">

  3128.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3129.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3130.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3131.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3132.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3133.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3134.   </table>

  3135.   </dd>

  3136. </dl>

  3137. <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>

  3138. <dd>

  3139. 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>

  3140. <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>

  3141. 

  3142. </div>

  3143. </div>

  3144. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3145. <div class="memitem">

  3146. <div class="memproto">

  3147. <table class="mlabels">

  3148.   <tr>

  3149.   <td class="mlabels-left">

  3150.       <table class="memname">

  3151.         <tr>

  3152.           <td class="memname">bool FatFile::truncate </td>

  3153.           <td>(</td>

  3154.           <td class="paramtype">uint32_t&#160;</td>

  3155.           <td class="paramname"><em>length</em></td><td>)</td>

  3156.           <td></td>

  3157.         </tr>

  3158.       </table>

  3159.   </td>

  3160.   <td class="mlabels-right">

  3161. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3162.   </tr>

  3163. </table>

  3164. </div><div class="memdoc">

  3165. <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>

  3166. <dl class="params"><dt>Parameters</dt><dd>

  3167.   <table class="params">

  3168.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3169.   </table>

  3170.   </dd>

  3171. </dl>

  3172. <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>

  3173. 

  3174. </div>

  3175. </div>

  3176. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3177. <div class="memitem">

  3178. <div class="memproto">

  3179. <table class="mlabels">

  3180.   <tr>

  3181.   <td class="mlabels-left">

  3182.       <table class="memname">

  3183.         <tr>

  3184.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3185.           <td>(</td>

  3186.           <td class="paramname"></td><td>)</td>

  3187.           <td> const</td>

  3188.         </tr>

  3189.       </table>

  3190.   </td>

  3191.   <td class="mlabels-right">

  3192. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3193.   </tr>

  3194. </table>

  3195. </div><div class="memdoc">

  3196. <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>

  3197. 

  3198. </div>

  3199. </div>

  3200. <a class="anchor" id="a460b033ff85e85f684f8d9b615645db1"></a>

  3201. <div class="memitem">

  3202. <div class="memproto">

  3203. <table class="mlabels">

  3204.   <tr>

  3205.   <td class="mlabels-left">

  3206.       <table class="memname">

  3207.         <tr>

  3208.           <td class="memname">size_t PrintFile::write </td>

  3209.           <td>(</td>

  3210.           <td class="paramtype">uint8_t&#160;</td>

  3211.           <td class="paramname"><em>b</em></td><td>)</td>

  3212.           <td></td>

  3213.         </tr>

  3214.       </table>

  3215.   </td>

  3216.   <td class="mlabels-right">

  3217. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3218.   </tr>

  3219. </table>

  3220. </div><div class="memdoc">

  3221. <p>Read the next byte from a file.</p>

  3222. <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>

  3223. <dl class="params"><dt>Parameters</dt><dd>

  3224.   <table class="params">

  3225.     <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>

  3226.   </table>

  3227.   </dd>

  3228. </dl>

  3229. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3230. 

  3231. </div>

  3232. </div>

  3233. <a class="anchor" id="a29c1d534d21c3a82ad04232d37119a57"></a>

  3234. <div class="memitem">

  3235. <div class="memproto">

  3236. <table class="mlabels">

  3237.   <tr>

  3238.   <td class="mlabels-left">

  3239.       <table class="memname">

  3240.         <tr>

  3241.           <td class="memname">size_t PrintFile::write </td>

  3242.           <td>(</td>

  3243.           <td class="paramtype">const uint8_t *&#160;</td>

  3244.           <td class="paramname"><em>buf</em>, </td>

  3245.         </tr>

  3246.         <tr>

  3247.           <td class="paramkey"></td>

  3248.           <td></td>

  3249.           <td class="paramtype">size_t&#160;</td>

  3250.           <td class="paramname"><em>size</em>&#160;</td>

  3251.         </tr>

  3252.         <tr>

  3253.           <td></td>

  3254.           <td>)</td>

  3255.           <td></td><td></td>

  3256.         </tr>

  3257.       </table>

  3258.   </td>

  3259.   <td class="mlabels-right">

  3260. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3261.   </tr>

  3262. </table>

  3263. </div><div class="memdoc">

  3264. <p>Write data to an open file. Form required by Print.</p>

  3265. <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>

  3266. <dl class="params"><dt>Parameters</dt><dd>

  3267.   <table class="params">

  3268.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3269.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3270.   </table>

  3271.   </dd>

  3272. </dl>

  3273. <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>

  3274. 

  3275. </div>

  3276. </div>

  3277. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3278. <div class="memitem">

  3279. <div class="memproto">

  3280. <table class="mlabels">

  3281.   <tr>

  3282.   <td class="mlabels-left">

  3283.       <table class="memname">

  3284.         <tr>

  3285.           <td class="memname">int FatFile::write </td>

  3286.           <td>(</td>

  3287.           <td class="paramtype">const char *&#160;</td>

  3288.           <td class="paramname"><em>str</em></td><td>)</td>

  3289.           <td></td>

  3290.         </tr>

  3291.       </table>

  3292.   </td>

  3293.   <td class="mlabels-right">

  3294. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3295.   </tr>

  3296. </table>

  3297. </div><div class="memdoc">

  3298. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3299.   <table class="params">

  3300.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3301.   </table>

  3302.   </dd>

  3303. </dl>

  3304. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3305. 

  3306. </div>

  3307. </div>

  3308. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3309. <div class="memitem">

  3310. <div class="memproto">

  3311. <table class="mlabels">

  3312.   <tr>

  3313.   <td class="mlabels-left">

  3314.       <table class="memname">

  3315.         <tr>

  3316.           <td class="memname">int FatFile::write </td>

  3317.           <td>(</td>

  3318.           <td class="paramtype">const void *&#160;</td>

  3319.           <td class="paramname"><em>buf</em>, </td>

  3320.         </tr>

  3321.         <tr>

  3322.           <td class="paramkey"></td>

  3323.           <td></td>

  3324.           <td class="paramtype">size_t&#160;</td>

  3325.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3326.         </tr>

  3327.         <tr>

  3328.           <td></td>

  3329.           <td>)</td>

  3330.           <td></td><td></td>

  3331.         </tr>

  3332.       </table>

  3333.   </td>

  3334.   <td class="mlabels-right">

  3335. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3336.   </tr>

  3337. </table>

  3338. </div><div class="memdoc">

  3339. <p>Write data to an open file.</p>

  3340. <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>

  3341. <dl class="params"><dt>Parameters</dt><dd>

  3342.   <table class="params">

  3343.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3344.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3345.   </table>

  3346.   </dd>

  3347. </dl>

  3348. <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>

  3349. 

  3350. </div>

  3351. </div>

  3352. <hr/>The documentation for this class was generated from the following file:<ul>

  3353. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  3354. </ul>

  3355. </div><!-- contents -->

  3356. <!-- start footer part -->

  3357. <hr class="footer"/><address class="footer"><small>

  3358. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3359. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3360. </a> 1.8.10

  3361. </small></address>

  3362. </body>

  3363. </html>