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.
42 Révisions
1 Branche
Aborescence: 7871875f5c
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/class_fat_file.html

2990 lines
137KB
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: FatFile Class Reference</title>

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

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

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

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

  12. <script type="text/javascript" src="search/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_fat_file-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Basic file class.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for FatFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_fat_stream_base.html" title="Base class for C++ style streams. " alt="" coords="72,80,185,107"/>

  103. <area shape="rect" id="node6" href="class_file.html" title="Arduino SD.h style File API. " alt="" coords="210,80,253,107"/>

  104. <area shape="rect" id="node7" href="class_print_file.html" title="FatFile with Print. " alt="" coords="277,80,348,107"/>

  105. <area shape="rect" id="node9" href="class_sd_base_file.html" title="Class for backward compatibility. " alt="" coords="372,80,461,107"/>

  106. <area shape="rect" id="node10" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. " alt="" coords="485,80,580,107"/>

  107. <area shape="rect" id="node3" href="classfstream.html" title="file input/output stream. " alt="" coords="5,155,71,181"/>

  108. <area shape="rect" id="node4" href="classifstream.html" title="file input stream. " alt="" coords="95,155,163,181"/>

  109. <area shape="rect" id="node5" href="classofstream.html" title="file output stream. " alt="" coords="187,155,259,181"/>

  110. <area shape="rect" id="node8" href="class_sd_file.html" title="Class for backward compatibility. " alt="" coords="283,155,342,181"/>

  111. </map>

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

  113. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  157. <tr class="separator:a1057bc23b92a074539f661e896e79a09"><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:ac05b7136b887539426856c623869aa3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac05b7136b887539426856c623869aa3a">peek</a> ()</td></tr>

  209. <tr class="separator:ac05b7136b887539426856c623869aa3a"><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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  297. </table>

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

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

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

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

  302. <div class="memitem">

  303. <div class="memproto">

  304. <table class="mlabels">

  305.   <tr>

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

  307.       <table class="memname">

  308.         <tr>

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

  310.           <td>(</td>

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

  312.           <td></td>

  313.         </tr>

  314.       </table>

  315.   </td>

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

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

  318.   </tr>

  319. </table>

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

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

  322. 

  323. </div>

  324. </div>

  325. <a class="anchor" id="a29d31067d0aa3a9a74b1a660c38775cc"></a>

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

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

  331.       <table class="memname">

  332.         <tr>

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

  334.           <td>(</td>

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

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

  337.         </tr>

  338.         <tr>

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

  340.           <td></td>

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

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

  343.         </tr>

  344.         <tr>

  345.           <td></td>

  346.           <td>)</td>

  347.           <td></td><td></td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

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

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

  358.   <table class="params">

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

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

  361.   </table>

  362.   </dd>

  363. </dl>

  364. 

  365. </div>

  366. </div>

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

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

  369. <div class="memitem">

  370. <div class="memproto">

  371. <table class="mlabels">

  372.   <tr>

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

  374.       <table class="memname">

  375.         <tr>

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

  377.           <td>(</td>

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

  379.           <td></td>

  380.         </tr>

  381.       </table>

  382.   </td>

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

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

  385.   </tr>

  386. </table>

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

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

  389. 

  390. </div>

  391. </div>

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

  393. <div class="memitem">

  394. <div class="memproto">

  395. <table class="mlabels">

  396.   <tr>

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

  398.       <table class="memname">

  399.         <tr>

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

  401.           <td>(</td>

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

  403.           <td></td>

  404.         </tr>

  405.       </table>

  406.   </td>

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

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

  409.   </tr>

  410. </table>

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

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

  413. 

  414. </div>

  415. </div>

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

  417. <div class="memitem">

  418. <div class="memproto">

  419. <table class="mlabels">

  420.   <tr>

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

  422.       <table class="memname">

  423.         <tr>

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

  425.           <td>(</td>

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

  427.           <td></td>

  428.         </tr>

  429.       </table>

  430.   </td>

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

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

  433.   </tr>

  434. </table>

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

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

  437. 

  438. </div>

  439. </div>

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

  441. <div class="memitem">

  442. <div class="memproto">

  443.       <table class="memname">

  444.         <tr>

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

  446.           <td>(</td>

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

  448.           <td></td>

  449.         </tr>

  450.       </table>

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

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

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

  454. 

  455. </div>

  456. </div>

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

  458. <div class="memitem">

  459. <div class="memproto">

  460.       <table class="memname">

  461.         <tr>

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

  463.           <td>(</td>

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

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

  466.         </tr>

  467.         <tr>

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

  469.           <td></td>

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

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

  472.         </tr>

  473.         <tr>

  474.           <td></td>

  475.           <td>)</td>

  476.           <td></td><td></td>

  477.         </tr>

  478.       </table>

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

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

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

  482.   <table class="params">

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

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

  485.   </table>

  486.   </dd>

  487. </dl>

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

  489. 

  490. </div>

  491. </div>

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

  493. <div class="memitem">

  494. <div class="memproto">

  495.       <table class="memname">

  496.         <tr>

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

  498.           <td>(</td>

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

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

  501.         </tr>

  502.         <tr>

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

  504.           <td></td>

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

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

  507.         </tr>

  508.         <tr>

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

  510.           <td></td>

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

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

  513.         </tr>

  514.         <tr>

  515.           <td></td>

  516.           <td>)</td>

  517.           <td></td><td></td>

  518.         </tr>

  519.       </table>

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

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

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

  523.   <table class="params">

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

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

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

  527.   </table>

  528.   </dd>

  529. </dl>

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

  531. 

  532. </div>

  533. </div>

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

  535. <div class="memitem">

  536. <div class="memproto">

  537. <table class="mlabels">

  538.   <tr>

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

  540.       <table class="memname">

  541.         <tr>

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

  543.           <td>(</td>

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

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

  546.         </tr>

  547.         <tr>

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

  549.           <td></td>

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

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

  552.         </tr>

  553.         <tr>

  554.           <td></td>

  555.           <td>)</td>

  556.           <td></td><td></td>

  557.         </tr>

  558.       </table>

  559.   </td>

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

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

  562.   </tr>

  563. </table>

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

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

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

  567.   <table class="params">

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

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

  570.   </table>

  571.   </dd>

  572. </dl>

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

  574. 

  575. </div>

  576. </div>

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

  578. <div class="memitem">

  579. <div class="memproto">

  580. <table class="mlabels">

  581.   <tr>

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

  583.       <table class="memname">

  584.         <tr>

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

  586.           <td>(</td>

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

  588.           <td> const</td>

  589.         </tr>

  590.       </table>

  591.   </td>

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

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

  594.   </tr>

  595. </table>

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

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

  598. 

  599. </div>

  600. </div>

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

  602. <div class="memitem">

  603. <div class="memproto">

  604. <table class="mlabels">

  605.   <tr>

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

  607.       <table class="memname">

  608.         <tr>

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

  610.           <td>(</td>

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

  612.           <td> const</td>

  613.         </tr>

  614.       </table>

  615.   </td>

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

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

  618.   </tr>

  619. </table>

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

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

  622. 

  623. </div>

  624. </div>

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

  626. <div class="memitem">

  627. <div class="memproto">

  628. <table class="mlabels">

  629.   <tr>

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

  631.       <table class="memname">

  632.         <tr>

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

  634.           <td>(</td>

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

  636.           <td></td>

  637.         </tr>

  638.       </table>

  639.   </td>

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

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

  642.   </tr>

  643. </table>

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

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

  646. 

  647. </div>

  648. </div>

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

  650. <div class="memitem">

  651. <div class="memproto">

  652. <table class="mlabels">

  653.   <tr>

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

  655.       <table class="memname">

  656.         <tr>

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

  658.           <td>(</td>

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

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

  661.           <td></td>

  662.         </tr>

  663.       </table>

  664.   </td>

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

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

  667.   </tr>

  668. </table>

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

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

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

  672.   <table class="params">

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

  674.   </table>

  675.   </dd>

  676. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  691. 

  692. </div>

  693. </div>

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

  695. <div class="memitem">

  696. <div class="memproto">

  697. <table class="mlabels">

  698.   <tr>

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

  700.       <table class="memname">

  701.         <tr>

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

  703.           <td>(</td>

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

  705.           <td></td>

  706.         </tr>

  707.       </table>

  708.   </td>

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

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

  711.   </tr>

  712. </table>

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

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

  715. 

  716. </div>

  717. </div>

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

  719. <div class="memitem">

  720. <div class="memproto">

  721.       <table class="memname">

  722.         <tr>

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

  724.           <td>(</td>

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

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

  727.           <td></td>

  728.         </tr>

  729.       </table>

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

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

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

  733.   <table class="params">

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

  735.   </table>

  736.   </dd>

  737. </dl>

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

  739. 

  740. </div>

  741. </div>

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

  743. <div class="memitem">

  744. <div class="memproto">

  745. <table class="mlabels">

  746.   <tr>

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

  748.       <table class="memname">

  749.         <tr>

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

  751.           <td>(</td>

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

  753.           <td></td>

  754.         </tr>

  755.       </table>

  756.   </td>

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

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

  759.   </tr>

  760. </table>

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

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

  763. 

  764. </div>

  765. </div>

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

  767. <div class="memitem">

  768. <div class="memproto">

  769. <table class="mlabels">

  770.   <tr>

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

  772.       <table class="memname">

  773.         <tr>

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

  775.           <td>(</td>

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

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

  778.         </tr>

  779.         <tr>

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

  781.           <td></td>

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

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

  784.         </tr>

  785.         <tr>

  786.           <td></td>

  787.           <td>)</td>

  788.           <td></td><td></td>

  789.         </tr>

  790.       </table>

  791.   </td>

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

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

  794.   </tr>

  795. </table>

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

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

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

  799.   <table class="params">

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

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

  802.   </table>

  803.   </dd>

  804. </dl>

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

  806. 

  807. </div>

  808. </div>

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

  810. <div class="memitem">

  811. <div class="memproto">

  812.       <table class="memname">

  813.         <tr>

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

  815.           <td>(</td>

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

  817.           <td></td>

  818.         </tr>

  819.       </table>

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

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

  822. 

  823. </div>

  824. </div>

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

  826. <div class="memitem">

  827. <div class="memproto">

  828.       <table class="memname">

  829.         <tr>

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

  831.           <td>(</td>

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

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

  834.         </tr>

  835.         <tr>

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

  837.           <td></td>

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

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

  840.         </tr>

  841.         <tr>

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

  843.           <td></td>

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

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

  846.         </tr>

  847.         <tr>

  848.           <td></td>

  849.           <td>)</td>

  850.           <td></td><td></td>

  851.         </tr>

  852.       </table>

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

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

  855.   <table class="params">

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

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

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

  859.   </table>

  860.   </dd>

  861. </dl>

  862. 

  863. </div>

  864. </div>

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

  866. <div class="memitem">

  867. <div class="memproto">

  868. <table class="mlabels">

  869.   <tr>

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

  871.       <table class="memname">

  872.         <tr>

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

  874.           <td>(</td>

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

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

  877.           <td></td>

  878.         </tr>

  879.       </table>

  880.   </td>

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

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

  883.   </tr>

  884. </table>

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

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

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

  888.   <table class="params">

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

  890.   </table>

  891.   </dd>

  892. </dl>

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

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

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

  896. 

  897. </div>

  898. </div>

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

  900. <div class="memitem">

  901. <div class="memproto">

  902.       <table class="memname">

  903.         <tr>

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

  905.           <td>(</td>

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

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

  908.         </tr>

  909.         <tr>

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

  911.           <td></td>

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

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

  914.         </tr>

  915.         <tr>

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

  917.           <td></td>

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

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

  920.         </tr>

  921.         <tr>

  922.           <td></td>

  923.           <td>)</td>

  924.           <td></td><td></td>

  925.         </tr>

  926.       </table>

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

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

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

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

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

  932.   <table class="params">

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

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

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

  936.   </table>

  937.   </dd>

  938. </dl>

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

  940. 

  941. </div>

  942. </div>

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

  944. <div class="memitem">

  945. <div class="memproto">

  946. <table class="mlabels">

  947.   <tr>

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

  949.       <table class="memname">

  950.         <tr>

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

  952.           <td>(</td>

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

  954.           <td> const</td>

  955.         </tr>

  956.       </table>

  957.   </td>

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

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

  960.   </tr>

  961. </table>

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

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

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

  965. 

  966. </div>

  967. </div>

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

  969. <div class="memitem">

  970. <div class="memproto">

  971. <table class="mlabels">

  972.   <tr>

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

  974.       <table class="memname">

  975.         <tr>

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

  977.           <td>(</td>

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

  979.           <td> const</td>

  980.         </tr>

  981.       </table>

  982.   </td>

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

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

  985.   </tr>

  986. </table>

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

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

  989. 

  990. </div>

  991. </div>

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

  993. <div class="memitem">

  994. <div class="memproto">

  995. <table class="mlabels">

  996.   <tr>

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

  998.       <table class="memname">

  999.         <tr>

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

  1001.           <td>(</td>

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

  1003.           <td></td>

  1004.         </tr>

  1005.       </table>

  1006.   </td>

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

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

  1009.   </tr>

  1010. </table>

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

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

  1013. 

  1014. </div>

  1015. </div>

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

  1017. <div class="memitem">

  1018. <div class="memproto">

  1019. <table class="mlabels">

  1020.   <tr>

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

  1022.       <table class="memname">

  1023.         <tr>

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

  1025.           <td>(</td>

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

  1027.           <td> const</td>

  1028.         </tr>

  1029.       </table>

  1030.   </td>

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

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

  1033.   </tr>

  1034. </table>

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

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

  1037. 

  1038. </div>

  1039. </div>

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

  1041. <div class="memitem">

  1042. <div class="memproto">

  1043. <table class="mlabels">

  1044.   <tr>

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

  1046.       <table class="memname">

  1047.         <tr>

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

  1049.           <td>(</td>

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

  1051.           <td></td>

  1052.         </tr>

  1053.       </table>

  1054.   </td>

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

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

  1057.   </tr>

  1058. </table>

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

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

  1061. 

  1062. </div>

  1063. </div>

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

  1065. <div class="memitem">

  1066. <div class="memproto">

  1067.       <table class="memname">

  1068.         <tr>

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

  1070.           <td>(</td>

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

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

  1073.         </tr>

  1074.         <tr>

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

  1076.           <td></td>

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

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

  1079.         </tr>

  1080.         <tr>

  1081.           <td></td>

  1082.           <td>)</td>

  1083.           <td></td><td></td>

  1084.         </tr>

  1085.       </table>

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

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

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

  1089.   <table class="params">

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

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

  1092.   </table>

  1093.   </dd>

  1094. </dl>

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

  1096. 

  1097. </div>

  1098. </div>

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

  1100. <div class="memitem">

  1101. <div class="memproto">

  1102.       <table class="memname">

  1103.         <tr>

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

  1105.           <td>(</td>

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

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

  1108.           <td></td>

  1109.         </tr>

  1110.       </table>

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

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

  1113.   <table class="params">

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

  1115.   </table>

  1116.   </dd>

  1117. </dl>

  1118. 

  1119. </div>

  1120. </div>

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

  1122. <div class="memitem">

  1123. <div class="memproto">

  1124.       <table class="memname">

  1125.         <tr>

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

  1127.           <td>(</td>

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

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

  1130.           <td></td>

  1131.         </tr>

  1132.       </table>

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

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

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

  1136.   <table class="params">

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

  1138.   </table>

  1139.   </dd>

  1140. </dl>

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

  1142. 

  1143. </div>

  1144. </div>

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

  1146. <div class="memitem">

  1147. <div class="memproto">

  1148. <table class="mlabels">

  1149.   <tr>

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

  1151.       <table class="memname">

  1152.         <tr>

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

  1154.           <td>(</td>

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

  1156.           <td></td>

  1157.         </tr>

  1158.       </table>

  1159.   </td>

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

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

  1162.   </tr>

  1163. </table>

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

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

  1166. 

  1167. </div>

  1168. </div>

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

  1170. <div class="memitem">

  1171. <div class="memproto">

  1172. <table class="mlabels">

  1173.   <tr>

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

  1175.       <table class="memname">

  1176.         <tr>

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

  1178.           <td>(</td>

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

  1180.           <td> const</td>

  1181.         </tr>

  1182.       </table>

  1183.   </td>

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

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

  1186.   </tr>

  1187. </table>

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

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

  1190. 

  1191. </div>

  1192. </div>

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

  1194. <div class="memitem">

  1195. <div class="memproto">

  1196. <table class="mlabels">

  1197.   <tr>

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

  1199.       <table class="memname">

  1200.         <tr>

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

  1202.           <td>(</td>

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

  1204.           <td> const</td>

  1205.         </tr>

  1206.       </table>

  1207.   </td>

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

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

  1210.   </tr>

  1211. </table>

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

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

  1214. 

  1215. </div>

  1216. </div>

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

  1218. <div class="memitem">

  1219. <div class="memproto">

  1220. <table class="mlabels">

  1221.   <tr>

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

  1223.       <table class="memname">

  1224.         <tr>

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

  1226.           <td>(</td>

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

  1228.           <td> const</td>

  1229.         </tr>

  1230.       </table>

  1231.   </td>

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

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

  1234.   </tr>

  1235. </table>

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

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

  1238. 

  1239. </div>

  1240. </div>

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

  1242. <div class="memitem">

  1243. <div class="memproto">

  1244. <table class="mlabels">

  1245.   <tr>

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

  1247.       <table class="memname">

  1248.         <tr>

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

  1250.           <td>(</td>

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

  1252.           <td> const</td>

  1253.         </tr>

  1254.       </table>

  1255.   </td>

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

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

  1258.   </tr>

  1259. </table>

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

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

  1262. 

  1263. </div>

  1264. </div>

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

  1266. <div class="memitem">

  1267. <div class="memproto">

  1268. <table class="mlabels">

  1269.   <tr>

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

  1271.       <table class="memname">

  1272.         <tr>

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

  1274.           <td>(</td>

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

  1276.           <td> const</td>

  1277.         </tr>

  1278.       </table>

  1279.   </td>

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

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

  1282.   </tr>

  1283. </table>

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

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

  1286. 

  1287. </div>

  1288. </div>

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

  1290. <div class="memitem">

  1291. <div class="memproto">

  1292. <table class="mlabels">

  1293.   <tr>

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

  1295.       <table class="memname">

  1296.         <tr>

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

  1298.           <td>(</td>

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

  1300.           <td> const</td>

  1301.         </tr>

  1302.       </table>

  1303.   </td>

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

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

  1306.   </tr>

  1307. </table>

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

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

  1310. 

  1311. </div>

  1312. </div>

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

  1314. <div class="memitem">

  1315. <div class="memproto">

  1316. <table class="mlabels">

  1317.   <tr>

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

  1319.       <table class="memname">

  1320.         <tr>

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

  1322.           <td>(</td>

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

  1324.           <td> const</td>

  1325.         </tr>

  1326.       </table>

  1327.   </td>

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

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

  1330.   </tr>

  1331. </table>

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

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

  1334. 

  1335. </div>

  1336. </div>

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

  1338. <div class="memitem">

  1339. <div class="memproto">

  1340. <table class="mlabels">

  1341.   <tr>

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

  1343.       <table class="memname">

  1344.         <tr>

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

  1346.           <td>(</td>

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

  1348.           <td> const</td>

  1349.         </tr>

  1350.       </table>

  1351.   </td>

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

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

  1354.   </tr>

  1355. </table>

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

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

  1358. 

  1359. </div>

  1360. </div>

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

  1362. <div class="memitem">

  1363. <div class="memproto">

  1364. <table class="mlabels">

  1365.   <tr>

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

  1367.       <table class="memname">

  1368.         <tr>

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

  1370.           <td>(</td>

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

  1372.           <td> const</td>

  1373.         </tr>

  1374.       </table>

  1375.   </td>

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

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

  1378.   </tr>

  1379. </table>

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

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

  1382. 

  1383. </div>

  1384. </div>

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

  1386. <div class="memitem">

  1387. <div class="memproto">

  1388. <table class="mlabels">

  1389.   <tr>

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

  1391.       <table class="memname">

  1392.         <tr>

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

  1394.           <td>(</td>

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

  1396.           <td> const</td>

  1397.         </tr>

  1398.       </table>

  1399.   </td>

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

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

  1402.   </tr>

  1403. </table>

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

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

  1406. 

  1407. </div>

  1408. </div>

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

  1410. <div class="memitem">

  1411. <div class="memproto">

  1412. <table class="mlabels">

  1413.   <tr>

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

  1415.       <table class="memname">

  1416.         <tr>

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

  1418.           <td>(</td>

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

  1420.           <td> const</td>

  1421.         </tr>

  1422.       </table>

  1423.   </td>

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

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

  1426.   </tr>

  1427. </table>

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

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

  1430. 

  1431. </div>

  1432. </div>

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

  1434. <div class="memitem">

  1435. <div class="memproto">

  1436. <table class="mlabels">

  1437.   <tr>

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

  1439.       <table class="memname">

  1440.         <tr>

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

  1442.           <td>(</td>

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

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

  1445.           <td></td>

  1446.         </tr>

  1447.       </table>

  1448.   </td>

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

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

  1451.   </tr>

  1452. </table>

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

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

  1455.   <table class="params">

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

  1457.   </table>

  1458.   </dd>

  1459. </dl>

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

  1461. 

  1462. </div>

  1463. </div>

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

  1465. <div class="memitem">

  1466. <div class="memproto">

  1467. <table class="mlabels">

  1468.   <tr>

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

  1470.       <table class="memname">

  1471.         <tr>

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

  1473.           <td>(</td>

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

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

  1476.           <td></td>

  1477.         </tr>

  1478.       </table>

  1479.   </td>

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

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

  1482.   </tr>

  1483. </table>

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

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

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

  1487.   <table class="params">

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

  1489.   </table>

  1490.   </dd>

  1491. </dl>

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

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

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

  1495. 

  1496. </div>

  1497. </div>

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

  1499. <div class="memitem">

  1500. <div class="memproto">

  1501.       <table class="memname">

  1502.         <tr>

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

  1504.           <td>(</td>

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

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

  1507.         </tr>

  1508.         <tr>

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

  1510.           <td></td>

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

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

  1513.         </tr>

  1514.         <tr>

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

  1516.           <td></td>

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

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

  1519.         </tr>

  1520.         <tr>

  1521.           <td></td>

  1522.           <td>)</td>

  1523.           <td></td><td></td>

  1524.         </tr>

  1525.       </table>

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

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

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

  1529.   <table class="params">

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

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

  1532.   </table>

  1533.   </dd>

  1534. </dl>

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

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

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

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

  1539.   <table class="params">

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

  1541.   </table>

  1542.   </dd>

  1543. </dl>

  1544. 

  1545. </div>

  1546. </div>

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

  1548. <div class="memitem">

  1549. <div class="memproto">

  1550.       <table class="memname">

  1551.         <tr>

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

  1553.           <td>(</td>

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

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

  1556.         </tr>

  1557.         <tr>

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

  1559.           <td></td>

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

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

  1562.         </tr>

  1563.         <tr>

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

  1565.           <td></td>

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

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

  1568.         </tr>

  1569.         <tr>

  1570.           <td></td>

  1571.           <td>)</td>

  1572.           <td></td><td></td>

  1573.         </tr>

  1574.       </table>

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

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

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

  1578.   <table class="params">

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

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

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

  1582.   </table>

  1583.   </dd>

  1584. </dl>

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

  1586. 

  1587. </div>

  1588. </div>

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

  1590. <div class="memitem">

  1591. <div class="memproto">

  1592.       <table class="memname">

  1593.         <tr>

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

  1595.           <td>(</td>

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

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

  1598.         </tr>

  1599.         <tr>

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

  1601.           <td></td>

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

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

  1604.         </tr>

  1605.         <tr>

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

  1607.           <td></td>

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

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

  1610.         </tr>

  1611.         <tr>

  1612.           <td></td>

  1613.           <td>)</td>

  1614.           <td></td><td></td>

  1615.         </tr>

  1616.       </table>

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

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

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

  1620.   <table class="params">

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

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

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

  1624.   </table>

  1625.   </dd>

  1626. </dl>

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

  1628. 

  1629. </div>

  1630. </div>

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

  1632. <div class="memitem">

  1633. <div class="memproto">

  1634.       <table class="memname">

  1635.         <tr>

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

  1637.           <td>(</td>

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

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

  1640.         </tr>

  1641.         <tr>

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

  1643.           <td></td>

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

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

  1646.         </tr>

  1647.         <tr>

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

  1649.           <td></td>

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

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

  1652.         </tr>

  1653.         <tr>

  1654.           <td></td>

  1655.           <td>)</td>

  1656.           <td></td><td></td>

  1657.         </tr>

  1658.       </table>

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

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

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

  1662.   <table class="params">

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

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

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

  1666.   </table>

  1667.   </dd>

  1668. </dl>

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

  1670. 

  1671. </div>

  1672. </div>

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

  1674. <div class="memitem">

  1675. <div class="memproto">

  1676.       <table class="memname">

  1677.         <tr>

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

  1679.           <td>(</td>

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

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

  1682.         </tr>

  1683.         <tr>

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

  1685.           <td></td>

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

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

  1688.         </tr>

  1689.         <tr>

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

  1691.           <td></td>

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

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

  1694.         </tr>

  1695.         <tr>

  1696.           <td></td>

  1697.           <td>)</td>

  1698.           <td></td><td></td>

  1699.         </tr>

  1700.       </table>

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

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

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

  1704.   <table class="params">

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

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

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

  1708.   </table>

  1709.   </dd>

  1710. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1725. 

  1726. </div>

  1727. </div>

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

  1729. <div class="memitem">

  1730. <div class="memproto">

  1731. <table class="mlabels">

  1732.   <tr>

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

  1734.       <table class="memname">

  1735.         <tr>

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

  1737.           <td>(</td>

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

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

  1740.         </tr>

  1741.         <tr>

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

  1743.           <td></td>

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

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

  1746.         </tr>

  1747.         <tr>

  1748.           <td></td>

  1749.           <td>)</td>

  1750.           <td></td><td></td>

  1751.         </tr>

  1752.       </table>

  1753.   </td>

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

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

  1756.   </tr>

  1757. </table>

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

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

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

  1761.   <table class="params">

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

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

  1764.   </table>

  1765.   </dd>

  1766. </dl>

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

  1768. 

  1769. </div>

  1770. </div>

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

  1772. <div class="memitem">

  1773. <div class="memproto">

  1774.       <table class="memname">

  1775.         <tr>

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

  1777.           <td>(</td>

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

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

  1780.         </tr>

  1781.         <tr>

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

  1783.           <td></td>

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

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

  1786.         </tr>

  1787.         <tr>

  1788.           <td></td>

  1789.           <td>)</td>

  1790.           <td></td><td></td>

  1791.         </tr>

  1792.       </table>

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

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

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

  1796.   <table class="params">

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

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

  1799.   </table>

  1800.   </dd>

  1801. </dl>

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

  1803. 

  1804. </div>

  1805. </div>

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

  1807. <div class="memitem">

  1808. <div class="memproto">

  1809.       <table class="memname">

  1810.         <tr>

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

  1812.           <td>(</td>

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

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

  1815.           <td></td>

  1816.         </tr>

  1817.       </table>

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

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

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

  1821.   <table class="params">

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

  1823.   </table>

  1824.   </dd>

  1825. </dl>

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

  1827. 

  1828. </div>

  1829. </div>

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

  1831. <div class="memitem">

  1832. <div class="memproto">

  1833.       <table class="memname">

  1834.         <tr>

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

  1836.           <td>(</td>

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

  1838.           <td></td>

  1839.         </tr>

  1840.       </table>

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

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

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

  1844. 

  1845. </div>

  1846. </div>

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

  1848. <div class="memitem">

  1849. <div class="memproto">

  1850.       <table class="memname">

  1851.         <tr>

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

  1853.           <td>(</td>

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

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

  1856.           <td></td>

  1857.         </tr>

  1858.       </table>

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

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

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

  1862.   <table class="params">

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

  1864.   </table>

  1865.   </dd>

  1866. </dl>

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

  1868. 

  1869. </div>

  1870. </div>

  1871. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1872. <div class="memitem">

  1873. <div class="memproto">

  1874. <table class="mlabels">

  1875.   <tr>

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

  1877.       <table class="memname">

  1878.         <tr>

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

  1880.           <td>(</td>

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

  1882.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1883.           <td></td>

  1884.         </tr>

  1885.       </table>

  1886.   </td>

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

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

  1889.   </tr>

  1890. </table>

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

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

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

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

  1895.   <table class="params">

  1896.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1897.   </table>

  1898.   </dd>

  1899. </dl>

  1900. 

  1901. </div>

  1902. </div>

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

  1904. <div class="memitem">

  1905. <div class="memproto">

  1906. <table class="mlabels">

  1907.   <tr>

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

  1909.       <table class="memname">

  1910.         <tr>

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

  1912.           <td>(</td>

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

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

  1915.         </tr>

  1916.         <tr>

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

  1918.           <td></td>

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

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

  1921.         </tr>

  1922.         <tr>

  1923.           <td></td>

  1924.           <td>)</td>

  1925.           <td></td><td></td>

  1926.         </tr>

  1927.       </table>

  1928.   </td>

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

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

  1931.   </tr>

  1932. </table>

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

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

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

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

  1937.   <table class="params">

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

  1939.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1940.   </table>

  1941.   </dd>

  1942. </dl>

  1943. 

  1944. </div>

  1945. </div>

  1946. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  1947. <div class="memitem">

  1948. <div class="memproto">

  1949. <table class="mlabels">

  1950.   <tr>

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

  1952.       <table class="memname">

  1953.         <tr>

  1954.           <td class="memname">static void FatFile::printFatTime </td>

  1955.           <td>(</td>

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

  1957.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  1958.           <td></td>

  1959.         </tr>

  1960.       </table>

  1961.   </td>

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

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

  1964.   </tr>

  1965. </table>

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

  1967. <p>Print a directory time field.</p>

  1968. <p>Format is hh:mm:ss.</p>

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

  1970.   <table class="params">

  1971.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  1972.   </table>

  1973.   </dd>

  1974. </dl>

  1975. 

  1976. </div>

  1977. </div>

  1978. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  1979. <div class="memitem">

  1980. <div class="memproto">

  1981. <table class="mlabels">

  1982.   <tr>

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

  1984.       <table class="memname">

  1985.         <tr>

  1986.           <td class="memname">void FatFile::printFatTime </td>

  1987.           <td>(</td>

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

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

  1990.         </tr>

  1991.         <tr>

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

  1993.           <td></td>

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

  1995.           <td class="paramname"><em>fatTime</em>&#160;</td>

  1996.         </tr>

  1997.         <tr>

  1998.           <td></td>

  1999.           <td>)</td>

  2000.           <td></td><td></td>

  2001.         </tr>

  2002.       </table>

  2003.   </td>

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

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

  2006.   </tr>

  2007. </table>

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

  2009. <p>Print a directory time field.</p>

  2010. <p>Format is hh:mm:ss.</p>

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

  2012.   <table class="params">

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

  2014.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2015.   </table>

  2016.   </dd>

  2017. </dl>

  2018. 

  2019. </div>

  2020. </div>

  2021. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2022. <div class="memitem">

  2023. <div class="memproto">

  2024.       <table class="memname">

  2025.         <tr>

  2026.           <td class="memname">int FatFile::printField </td>

  2027.           <td>(</td>

  2028.           <td class="paramtype">float&#160;</td>

  2029.           <td class="paramname"><em>value</em>, </td>

  2030.         </tr>

  2031.         <tr>

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

  2033.           <td></td>

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

  2035.           <td class="paramname"><em>term</em>, </td>

  2036.         </tr>

  2037.         <tr>

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

  2039.           <td></td>

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

  2041.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2042.         </tr>

  2043.         <tr>

  2044.           <td></td>

  2045.           <td>)</td>

  2046.           <td></td><td></td>

  2047.         </tr>

  2048.       </table>

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

  2050. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2051.   <table class="params">

  2052.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2053.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2054.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2055.   </table>

  2056.   </dd>

  2057. </dl>

  2058. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2059. 

  2060. </div>

  2061. </div>

  2062. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2063. <div class="memitem">

  2064. <div class="memproto">

  2065.       <table class="memname">

  2066.         <tr>

  2067.           <td class="memname">int FatFile::printField </td>

  2068.           <td>(</td>

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

  2070.           <td class="paramname"><em>value</em>, </td>

  2071.         </tr>

  2072.         <tr>

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

  2074.           <td></td>

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

  2076.           <td class="paramname"><em>term</em>&#160;</td>

  2077.         </tr>

  2078.         <tr>

  2079.           <td></td>

  2080.           <td>)</td>

  2081.           <td></td><td></td>

  2082.         </tr>

  2083.       </table>

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

  2085. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2086.   <table class="params">

  2087.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2088.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2089.   </table>

  2090.   </dd>

  2091. </dl>

  2092. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2093. 

  2094. </div>

  2095. </div>

  2096. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2097. <div class="memitem">

  2098. <div class="memproto">

  2099.       <table class="memname">

  2100.         <tr>

  2101.           <td class="memname">int FatFile::printField </td>

  2102.           <td>(</td>

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

  2104.           <td class="paramname"><em>value</em>, </td>

  2105.         </tr>

  2106.         <tr>

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

  2108.           <td></td>

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

  2110.           <td class="paramname"><em>term</em>&#160;</td>

  2111.         </tr>

  2112.         <tr>

  2113.           <td></td>

  2114.           <td>)</td>

  2115.           <td></td><td></td>

  2116.         </tr>

  2117.       </table>

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

  2119. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2120.   <table class="params">

  2121.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2122.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2123.   </table>

  2124.   </dd>

  2125. </dl>

  2126. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2127. 

  2128. </div>

  2129. </div>

  2130. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2131. <div class="memitem">

  2132. <div class="memproto">

  2133.       <table class="memname">

  2134.         <tr>

  2135.           <td class="memname">int FatFile::printField </td>

  2136.           <td>(</td>

  2137.           <td class="paramtype">int32_t&#160;</td>

  2138.           <td class="paramname"><em>value</em>, </td>

  2139.         </tr>

  2140.         <tr>

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

  2142.           <td></td>

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

  2144.           <td class="paramname"><em>term</em>&#160;</td>

  2145.         </tr>

  2146.         <tr>

  2147.           <td></td>

  2148.           <td>)</td>

  2149.           <td></td><td></td>

  2150.         </tr>

  2151.       </table>

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

  2153. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2154.   <table class="params">

  2155.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2156.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2157.   </table>

  2158.   </dd>

  2159. </dl>

  2160. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2161. 

  2162. </div>

  2163. </div>

  2164. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2165. <div class="memitem">

  2166. <div class="memproto">

  2167.       <table class="memname">

  2168.         <tr>

  2169.           <td class="memname">int FatFile::printField </td>

  2170.           <td>(</td>

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

  2172.           <td class="paramname"><em>value</em>, </td>

  2173.         </tr>

  2174.         <tr>

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

  2176.           <td></td>

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

  2178.           <td class="paramname"><em>term</em>&#160;</td>

  2179.         </tr>

  2180.         <tr>

  2181.           <td></td>

  2182.           <td>)</td>

  2183.           <td></td><td></td>

  2184.         </tr>

  2185.       </table>

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

  2187. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2188.   <table class="params">

  2189.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2190.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2191.   </table>

  2192.   </dd>

  2193. </dl>

  2194. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2195. 

  2196. </div>

  2197. </div>

  2198. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2199. <div class="memitem">

  2200. <div class="memproto">

  2201.       <table class="memname">

  2202.         <tr>

  2203.           <td class="memname">size_t FatFile::printFileSize </td>

  2204.           <td>(</td>

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

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

  2207.           <td></td>

  2208.         </tr>

  2209.       </table>

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

  2211. <p>Print a file's size.</p>

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

  2213.   <table class="params">

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

  2215.   </table>

  2216.   </dd>

  2217. </dl>

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

  2219. 

  2220. </div>

  2221. </div>

  2222. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2223. <div class="memitem">

  2224. <div class="memproto">

  2225.       <table class="memname">

  2226.         <tr>

  2227.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2228.           <td>(</td>

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

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

  2231.           <td></td>

  2232.         </tr>

  2233.       </table>

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

  2235. <p>Print a file's modify date and time</p>

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

  2237.   <table class="params">

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

  2239.   </table>

  2240.   </dd>

  2241. </dl>

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

  2243. 

  2244. </div>

  2245. </div>

  2246. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2247. <div class="memitem">

  2248. <div class="memproto">

  2249. <table class="mlabels">

  2250.   <tr>

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

  2252.       <table class="memname">

  2253.         <tr>

  2254.           <td class="memname">size_t FatFile::printName </td>

  2255.           <td>(</td>

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

  2257.           <td></td>

  2258.         </tr>

  2259.       </table>

  2260.   </td>

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

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

  2263.   </tr>

  2264. </table>

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

  2266. <p>Print a file's name.</p>

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

  2268. 

  2269. </div>

  2270. </div>

  2271. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2272. <div class="memitem">

  2273. <div class="memproto">

  2274.       <table class="memname">

  2275.         <tr>

  2276.           <td class="memname">size_t FatFile::printName </td>

  2277.           <td>(</td>

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

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

  2280.           <td></td>

  2281.         </tr>

  2282.       </table>

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

  2284. <p>Print a file's name</p>

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

  2286.   <table class="params">

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

  2288.   </table>

  2289.   </dd>

  2290. </dl>

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

  2292. 

  2293. </div>

  2294. </div>

  2295. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2296. <div class="memitem">

  2297. <div class="memproto">

  2298.       <table class="memname">

  2299.         <tr>

  2300.           <td class="memname">size_t FatFile::printSFN </td>

  2301.           <td>(</td>

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

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

  2304.           <td></td>

  2305.         </tr>

  2306.       </table>

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

  2308. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

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

  2310.   <table class="params">

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

  2312.   </table>

  2313.   </dd>

  2314. </dl>

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

  2316. 

  2317. </div>

  2318. </div>

  2319. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2320. <div class="memitem">

  2321. <div class="memproto">

  2322. <table class="mlabels">

  2323.   <tr>

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

  2325.       <table class="memname">

  2326.         <tr>

  2327.           <td class="memname">int FatFile::read </td>

  2328.           <td>(</td>

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

  2330.           <td></td>

  2331.         </tr>

  2332.       </table>

  2333.   </td>

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

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

  2336.   </tr>

  2337. </table>

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

  2339. <p>Read the next byte from a file.</p>

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

  2341. 

  2342. </div>

  2343. </div>

  2344. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2345. <div class="memitem">

  2346. <div class="memproto">

  2347.       <table class="memname">

  2348.         <tr>

  2349.           <td class="memname">int FatFile::read </td>

  2350.           <td>(</td>

  2351.           <td class="paramtype">void *&#160;</td>

  2352.           <td class="paramname"><em>buf</em>, </td>

  2353.         </tr>

  2354.         <tr>

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

  2356.           <td></td>

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

  2358.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2359.         </tr>

  2360.         <tr>

  2361.           <td></td>

  2362.           <td>)</td>

  2363.           <td></td><td></td>

  2364.         </tr>

  2365.       </table>

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

  2367. <p>Read data from a file starting at the current position.</p>

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

  2369.   <table class="params">

  2370.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2371.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2372.   </table>

  2373.   </dd>

  2374. </dl>

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

  2376. 

  2377. </div>

  2378. </div>

  2379. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2380. <div class="memitem">

  2381. <div class="memproto">

  2382.       <table class="memname">

  2383.         <tr>

  2384.           <td class="memname">int8_t FatFile::readDir </td>

  2385.           <td>(</td>

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

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

  2388.           <td></td>

  2389.         </tr>

  2390.       </table>

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

  2392. <p>Read the next directory entry from a directory file.</p>

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

  2394.   <table class="params">

  2395.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2396.   </table>

  2397.   </dd>

  2398. </dl>

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

  2400. 

  2401. </div>

  2402. </div>

  2403. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2404. <div class="memitem">

  2405. <div class="memproto">

  2406.       <table class="memname">

  2407.         <tr>

  2408.           <td class="memname">bool FatFile::remove </td>

  2409.           <td>(</td>

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

  2411.           <td></td>

  2412.         </tr>

  2413.       </table>

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

  2415. <p>Remove a file.</p>

  2416. <p>The directory entry and all data for the file are deleted.</p>

  2417. <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>

  2418. <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>

  2419. 

  2420. </div>

  2421. </div>

  2422. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2423. <div class="memitem">

  2424. <div class="memproto">

  2425. <table class="mlabels">

  2426.   <tr>

  2427.   <td class="mlabels-left">

  2428.       <table class="memname">

  2429.         <tr>

  2430.           <td class="memname">bool FatFile::remove </td>

  2431.           <td>(</td>

  2432.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2433.           <td class="paramname"><em>dirFile</em>, </td>

  2434.         </tr>

  2435.         <tr>

  2436.           <td class="paramkey"></td>

  2437.           <td></td>

  2438.           <td class="paramtype">const char *&#160;</td>

  2439.           <td class="paramname"><em>path</em>&#160;</td>

  2440.         </tr>

  2441.         <tr>

  2442.           <td></td>

  2443.           <td>)</td>

  2444.           <td></td><td></td>

  2445.         </tr>

  2446.       </table>

  2447.   </td>

  2448.   <td class="mlabels-right">

  2449. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2450.   </tr>

  2451. </table>

  2452. </div><div class="memdoc">

  2453. <p>Remove a file.</p>

  2454. <p>The directory entry and all data for the file are deleted.</p>

  2455. <dl class="params"><dt>Parameters</dt><dd>

  2456.   <table class="params">

  2457.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2458.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2459.   </table>

  2460.   </dd>

  2461. </dl>

  2462. <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>

  2463. <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>

  2464. 

  2465. </div>

  2466. </div>

  2467. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2468. <div class="memitem">

  2469. <div class="memproto">

  2470.       <table class="memname">

  2471.         <tr>

  2472.           <td class="memname">bool FatFile::rename </td>

  2473.           <td>(</td>

  2474.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2475.           <td class="paramname"><em>dirFile</em>, </td>

  2476.         </tr>

  2477.         <tr>

  2478.           <td class="paramkey"></td>

  2479.           <td></td>

  2480.           <td class="paramtype">const char *&#160;</td>

  2481.           <td class="paramname"><em>newPath</em>&#160;</td>

  2482.         </tr>

  2483.         <tr>

  2484.           <td></td>

  2485.           <td>)</td>

  2486.           <td></td><td></td>

  2487.         </tr>

  2488.       </table>

  2489. </div><div class="memdoc">

  2490. <p>Rename a file or subdirectory.</p>

  2491. <dl class="params"><dt>Parameters</dt><dd>

  2492.   <table class="params">

  2493.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2494.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2495.   </table>

  2496.   </dd>

  2497. </dl>

  2498. <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>

  2499. 

  2500. </div>

  2501. </div>

  2502. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2503. <div class="memitem">

  2504. <div class="memproto">

  2505. <table class="mlabels">

  2506.   <tr>

  2507.   <td class="mlabels-left">

  2508.       <table class="memname">

  2509.         <tr>

  2510.           <td class="memname">void FatFile::rewind </td>

  2511.           <td>(</td>

  2512.           <td class="paramname"></td><td>)</td>

  2513.           <td></td>

  2514.         </tr>

  2515.       </table>

  2516.   </td>

  2517.   <td class="mlabels-right">

  2518. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2519.   </tr>

  2520. </table>

  2521. </div><div class="memdoc">

  2522. <p>Set the file's current position to zero. </p>

  2523. 

  2524. </div>

  2525. </div>

  2526. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2527. <div class="memitem">

  2528. <div class="memproto">

  2529.       <table class="memname">

  2530.         <tr>

  2531.           <td class="memname">bool FatFile::rmdir </td>

  2532.           <td>(</td>

  2533.           <td class="paramname"></td><td>)</td>

  2534.           <td></td>

  2535.         </tr>

  2536.       </table>

  2537. </div><div class="memdoc">

  2538. <p>Remove a directory file.</p>

  2539. <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>

  2540. <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>

  2541. <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>

  2542. 

  2543. </div>

  2544. </div>

  2545. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2546. <div class="memitem">

  2547. <div class="memproto">

  2548.       <table class="memname">

  2549.         <tr>

  2550.           <td class="memname">bool FatFile::rmRfStar </td>

  2551.           <td>(</td>

  2552.           <td class="paramname"></td><td>)</td>

  2553.           <td></td>

  2554.         </tr>

  2555.       </table>

  2556. </div><div class="memdoc">

  2557. <p>Recursively delete a directory and all contained files.</p>

  2558. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2559. <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>

  2560. <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>

  2561. <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>

  2562. 

  2563. </div>

  2564. </div>

  2565. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2566. <div class="memitem">

  2567. <div class="memproto">

  2568. <table class="mlabels">

  2569.   <tr>

  2570.   <td class="mlabels-left">

  2571.       <table class="memname">

  2572.         <tr>

  2573.           <td class="memname">bool FatFile::seekCur </td>

  2574.           <td>(</td>

  2575.           <td class="paramtype">int32_t&#160;</td>

  2576.           <td class="paramname"><em>offset</em></td><td>)</td>

  2577.           <td></td>

  2578.         </tr>

  2579.       </table>

  2580.   </td>

  2581.   <td class="mlabels-right">

  2582. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2583.   </tr>

  2584. </table>

  2585. </div><div class="memdoc">

  2586. <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>

  2587.   <table class="params">

  2588.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2589.   </table>

  2590.   </dd>

  2591. </dl>

  2592. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2593. 

  2594. </div>

  2595. </div>

  2596. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2597. <div class="memitem">

  2598. <div class="memproto">

  2599. <table class="mlabels">

  2600.   <tr>

  2601.   <td class="mlabels-left">

  2602.       <table class="memname">

  2603.         <tr>

  2604.           <td class="memname">bool FatFile::seekEnd </td>

  2605.           <td>(</td>

  2606.           <td class="paramtype">int32_t&#160;</td>

  2607.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2608.           <td></td>

  2609.         </tr>

  2610.       </table>

  2611.   </td>

  2612.   <td class="mlabels-right">

  2613. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2614.   </tr>

  2615. </table>

  2616. </div><div class="memdoc">

  2617. <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>

  2618.   <table class="params">

  2619.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2620.   </table>

  2621.   </dd>

  2622. </dl>

  2623. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2624. 

  2625. </div>

  2626. </div>

  2627. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2628. <div class="memitem">

  2629. <div class="memproto">

  2630.       <table class="memname">

  2631.         <tr>

  2632.           <td class="memname">bool FatFile::seekSet </td>

  2633.           <td>(</td>

  2634.           <td class="paramtype">uint32_t&#160;</td>

  2635.           <td class="paramname"><em>pos</em></td><td>)</td>

  2636.           <td></td>

  2637.         </tr>

  2638.       </table>

  2639. </div><div class="memdoc">

  2640. <p>Sets a file's position.</p>

  2641. <dl class="params"><dt>Parameters</dt><dd>

  2642.   <table class="params">

  2643.     <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>

  2644.   </table>

  2645.   </dd>

  2646. </dl>

  2647. <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>

  2648. 

  2649. </div>

  2650. </div>

  2651. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2652. <div class="memitem">

  2653. <div class="memproto">

  2654. <table class="mlabels">

  2655.   <tr>

  2656.   <td class="mlabels-left">

  2657.       <table class="memname">

  2658.         <tr>

  2659.           <td class="memname">static bool FatFile::setCwd </td>

  2660.           <td>(</td>

  2661.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2662.           <td class="paramname"><em>dir</em></td><td>)</td>

  2663.           <td></td>

  2664.         </tr>

  2665.       </table>

  2666.   </td>

  2667.   <td class="mlabels-right">

  2668. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  2669.   </tr>

  2670. </table>

  2671. </div><div class="memdoc">

  2672. <p>Set the current working directory.</p>

  2673. <dl class="params"><dt>Parameters</dt><dd>

  2674.   <table class="params">

  2675.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2676.   </table>

  2677.   </dd>

  2678. </dl>

  2679. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2680. 

  2681. </div>

  2682. </div>

  2683. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2684. <div class="memitem">

  2685. <div class="memproto">

  2686.       <table class="memname">

  2687.         <tr>

  2688.           <td class="memname">void FatFile::setpos </td>

  2689.           <td>(</td>

  2690.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2691.           <td class="paramname"><em>pos</em></td><td>)</td>

  2692.           <td></td>

  2693.         </tr>

  2694.       </table>

  2695. </div><div class="memdoc">

  2696. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2697.   <table class="params">

  2698.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2699.   </table>

  2700.   </dd>

  2701. </dl>

  2702. 

  2703. </div>

  2704. </div>

  2705. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2706. <div class="memitem">

  2707. <div class="memproto">

  2708.       <table class="memname">

  2709.         <tr>

  2710.           <td class="memname">bool FatFile::sync </td>

  2711.           <td>(</td>

  2712.           <td class="paramname"></td><td>)</td>

  2713.           <td></td>

  2714.         </tr>

  2715.       </table>

  2716. </div><div class="memdoc">

  2717. <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>

  2718. <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>

  2719. 

  2720. </div>

  2721. </div>

  2722. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2723. <div class="memitem">

  2724. <div class="memproto">

  2725.       <table class="memname">

  2726.         <tr>

  2727.           <td class="memname">bool FatFile::timestamp </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>file</em></td><td>)</td>

  2731.           <td></td>

  2732.         </tr>

  2733.       </table>

  2734. </div><div class="memdoc">

  2735. <p>Copy a file's timestamps</p>

  2736. <dl class="params"><dt>Parameters</dt><dd>

  2737.   <table class="params">

  2738.     <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>

  2739.   </table>

  2740.   </dd>

  2741. </dl>

  2742. <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>

  2743. <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>

  2744. 

  2745. </div>

  2746. </div>

  2747. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2748. <div class="memitem">

  2749. <div class="memproto">

  2750.       <table class="memname">

  2751.         <tr>

  2752.           <td class="memname">bool FatFile::timestamp </td>

  2753.           <td>(</td>

  2754.           <td class="paramtype">uint8_t&#160;</td>

  2755.           <td class="paramname"><em>flags</em>, </td>

  2756.         </tr>

  2757.         <tr>

  2758.           <td class="paramkey"></td>

  2759.           <td></td>

  2760.           <td class="paramtype">uint16_t&#160;</td>

  2761.           <td class="paramname"><em>year</em>, </td>

  2762.         </tr>

  2763.         <tr>

  2764.           <td class="paramkey"></td>

  2765.           <td></td>

  2766.           <td class="paramtype">uint8_t&#160;</td>

  2767.           <td class="paramname"><em>month</em>, </td>

  2768.         </tr>

  2769.         <tr>

  2770.           <td class="paramkey"></td>

  2771.           <td></td>

  2772.           <td class="paramtype">uint8_t&#160;</td>

  2773.           <td class="paramname"><em>day</em>, </td>

  2774.         </tr>

  2775.         <tr>

  2776.           <td class="paramkey"></td>

  2777.           <td></td>

  2778.           <td class="paramtype">uint8_t&#160;</td>

  2779.           <td class="paramname"><em>hour</em>, </td>

  2780.         </tr>

  2781.         <tr>

  2782.           <td class="paramkey"></td>

  2783.           <td></td>

  2784.           <td class="paramtype">uint8_t&#160;</td>

  2785.           <td class="paramname"><em>minute</em>, </td>

  2786.         </tr>

  2787.         <tr>

  2788.           <td class="paramkey"></td>

  2789.           <td></td>

  2790.           <td class="paramtype">uint8_t&#160;</td>

  2791.           <td class="paramname"><em>second</em>&#160;</td>

  2792.         </tr>

  2793.         <tr>

  2794.           <td></td>

  2795.           <td>)</td>

  2796.           <td></td><td></td>

  2797.         </tr>

  2798.       </table>

  2799. </div><div class="memdoc">

  2800. <p>Set a file's timestamps in its directory entry.</p>

  2801. <dl class="params"><dt>Parameters</dt><dd>

  2802.   <table class="params">

  2803.     <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>

  2804.   </table>

  2805.   </dd>

  2806. </dl>

  2807. <p>T_ACCESS - Set the file's last access date.</p>

  2808. <p>T_CREATE - Set the file's creation date and time.</p>

  2809. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2810. <dl class="params"><dt>Parameters</dt><dd>

  2811.   <table class="params">

  2812.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2813.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2814.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2815.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2816.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2817.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2818.   </table>

  2819.   </dd>

  2820. </dl>

  2821. <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>

  2822. <dd>

  2823. 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>

  2824. <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>

  2825. 

  2826. </div>

  2827. </div>

  2828. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  2829. <div class="memitem">

  2830. <div class="memproto">

  2831.       <table class="memname">

  2832.         <tr>

  2833.           <td class="memname">bool FatFile::truncate </td>

  2834.           <td>(</td>

  2835.           <td class="paramtype">uint32_t&#160;</td>

  2836.           <td class="paramname"><em>length</em></td><td>)</td>

  2837.           <td></td>

  2838.         </tr>

  2839.       </table>

  2840. </div><div class="memdoc">

  2841. <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>

  2842. <dl class="params"><dt>Parameters</dt><dd>

  2843.   <table class="params">

  2844.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2845.   </table>

  2846.   </dd>

  2847. </dl>

  2848. <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>

  2849. 

  2850. </div>

  2851. </div>

  2852. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  2853. <div class="memitem">

  2854. <div class="memproto">

  2855. <table class="mlabels">

  2856.   <tr>

  2857.   <td class="mlabels-left">

  2858.       <table class="memname">

  2859.         <tr>

  2860.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  2861.           <td>(</td>

  2862.           <td class="paramname"></td><td>)</td>

  2863.           <td> const</td>

  2864.         </tr>

  2865.       </table>

  2866.   </td>

  2867.   <td class="mlabels-right">

  2868. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2869.   </tr>

  2870. </table>

  2871. </div><div class="memdoc">

  2872. <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>

  2873. 

  2874. </div>

  2875. </div>

  2876. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  2877. <div class="memitem">

  2878. <div class="memproto">

  2879. <table class="mlabels">

  2880.   <tr>

  2881.   <td class="mlabels-left">

  2882.       <table class="memname">

  2883.         <tr>

  2884.           <td class="memname">int FatFile::write </td>

  2885.           <td>(</td>

  2886.           <td class="paramtype">const char *&#160;</td>

  2887.           <td class="paramname"><em>str</em></td><td>)</td>

  2888.           <td></td>

  2889.         </tr>

  2890.       </table>

  2891.   </td>

  2892.   <td class="mlabels-right">

  2893. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2894.   </tr>

  2895. </table>

  2896. </div><div class="memdoc">

  2897. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2898.   <table class="params">

  2899.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2900.   </table>

  2901.   </dd>

  2902. </dl>

  2903. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2904. 

  2905. </div>

  2906. </div>

  2907. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  2908. <div class="memitem">

  2909. <div class="memproto">

  2910. <table class="mlabels">

  2911.   <tr>

  2912.   <td class="mlabels-left">

  2913.       <table class="memname">

  2914.         <tr>

  2915.           <td class="memname">int FatFile::write </td>

  2916.           <td>(</td>

  2917.           <td class="paramtype">uint8_t&#160;</td>

  2918.           <td class="paramname"><em>b</em></td><td>)</td>

  2919.           <td></td>

  2920.         </tr>

  2921.       </table>

  2922.   </td>

  2923.   <td class="mlabels-right">

  2924. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2925.   </tr>

  2926. </table>

  2927. </div><div class="memdoc">

  2928. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2929.   <table class="params">

  2930.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2931.   </table>

  2932.   </dd>

  2933. </dl>

  2934. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2935. 

  2936. </div>

  2937. </div>

  2938. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  2939. <div class="memitem">

  2940. <div class="memproto">

  2941.       <table class="memname">

  2942.         <tr>

  2943.           <td class="memname">int FatFile::write </td>

  2944.           <td>(</td>

  2945.           <td class="paramtype">const void *&#160;</td>

  2946.           <td class="paramname"><em>buf</em>, </td>

  2947.         </tr>

  2948.         <tr>

  2949.           <td class="paramkey"></td>

  2950.           <td></td>

  2951.           <td class="paramtype">size_t&#160;</td>

  2952.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2953.         </tr>

  2954.         <tr>

  2955.           <td></td>

  2956.           <td>)</td>

  2957.           <td></td><td></td>

  2958.         </tr>

  2959.       </table>

  2960. </div><div class="memdoc">

  2961. <p>Write data to an open file.</p>

  2962. <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>

  2963. <dl class="params"><dt>Parameters</dt><dd>

  2964.   <table class="params">

  2965.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2966.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  2967.   </table>

  2968.   </dd>

  2969. </dl>

  2970. <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>

  2971. 

  2972. </div>

  2973. </div>

  2974. <hr/>The documentation for this class was generated from the following files:<ul>

  2975. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  2976. <li>Arduino/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  2977. <li>Arduino/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  2978. <li>Arduino/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  2979. <li>Arduino/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  2980. </ul>

  2981. </div><!-- contents -->

  2982. <!-- start footer part -->

  2983. <hr class="footer"/><address class="footer"><small>

  2984. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2985. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2986. </a> 1.8.10

  2987. </small></address>

  2988. </body>

  2989. </html>