visus
/
teensy-sdfat
İzle 1
Yıldızla 0
Çatalla 0
Kod Sorunlar 0 Değişiklik İstekleri 0 Sürümler 0 Wiki Aktivite
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
23 İşlemeler
1 Dal
Ağaç: d2a2f91ff0
Dallar Biçim İmleri
${ item.name }
Branş ${ searchTerm } oluştur
'd2a2f91ff0'den
${ noResults }
teensy-sdfat/html/class_sd_base_file.html

3218 satır
141KB
Ham Bahset Geçmiş 

  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: SdBaseFile Class Reference</title>

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

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

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

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

  89.   <div class="headertitle">

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

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

  92. <div class="contents">

  93. 

  94. <p>Class for backward compatibility.  

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

  96. 

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

  98. <div class="dynheader">

  99. Inheritance diagram for SdBaseFile:</div>

  100. <div class="dyncontent">

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

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

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

  104. </map>

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

  106. <div class="dynheader">

  107. Collaboration diagram for SdBaseFile:</div>

  108. <div class="dyncontent">

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

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

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

  112. </map>

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

  114. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

  125. <tr class="memitem:aa367708bcc8bc0e0c45c0c2a812c65da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa367708bcc8bc0e0c45c0c2a812c65da">contiguousRange</a> (uint32_t *bgnBlock, uint32_t *endBlock)</td></tr>

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

  127. <tr class="memitem:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0afc2a1cffa238d1cb2049bfa2d8d199">createContiguous</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint32_t size)</td></tr>

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

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

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

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

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

  133. <tr class="memitem:a6858d18c807411a071fd6d1b39d50087"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6858d18c807411a071fd6d1b39d50087">dirEntry</a> (<a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir)</td></tr>

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

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

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

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

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

  139. <tr class="memitem:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4f01d27954ae49aeb6888ac7302f55d9">dmpFile</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>

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

  141. <tr class="memitem:a50242f98dea0d4488ce4039a279f2a57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a50242f98dea0d4488ce4039a279f2a57">exists</a> (const char *path)</td></tr>

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

  143. <tr class="memitem:a31ef26b3ee37cf5f5f4c6024c0ddab69"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets</a> (char *str, int16_t num, char *delim=0)</td></tr>

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

  145. <tr class="memitem:a7e043dfb89d268bfd620bbbadacf1002"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e043dfb89d268bfd620bbbadacf1002">fileAttr</a> () const </td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  292. </table>

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

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

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

  296. <a class="anchor" id="a94d44fc448dc8a06867d490100a57781"></a>

  297. <div class="memitem">

  298. <div class="memproto">

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

  304.           <td class="memname">SdBaseFile::SdBaseFile </td>

  305.           <td>(</td>

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

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

  308.         </tr>

  309.         <tr>

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

  311.           <td></td>

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

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

  314.         </tr>

  315.         <tr>

  316.           <td></td>

  317.           <td>)</td>

  318.           <td></td><td></td>

  319.         </tr>

  320.       </table>

  321.   </td>

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

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

  324.   </tr>

  325. </table>

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

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

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

  329.   <table class="params">

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

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

  332.   </table>

  333.   </dd>

  334. </dl>

  335. 

  336. </div>

  337. </div>

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

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

  340. <div class="memitem">

  341. <div class="memproto">

  342. <table class="mlabels">

  343.   <tr>

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

  345.       <table class="memname">

  346.         <tr>

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

  348.           <td>(</td>

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

  350.           <td></td>

  351.         </tr>

  352.       </table>

  353.   </td>

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

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

  356.   </tr>

  357. </table>

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

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

  360. 

  361. </div>

  362. </div>

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

  364. <div class="memitem">

  365. <div class="memproto">

  366. <table class="mlabels">

  367.   <tr>

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

  369.       <table class="memname">

  370.         <tr>

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

  372.           <td>(</td>

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

  374.           <td></td>

  375.         </tr>

  376.       </table>

  377.   </td>

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

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

  380.   </tr>

  381. </table>

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

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

  384. 

  385. </div>

  386. </div>

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

  388. <div class="memitem">

  389. <div class="memproto">

  390. <table class="mlabels">

  391.   <tr>

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

  393.       <table class="memname">

  394.         <tr>

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

  396.           <td>(</td>

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

  398.           <td></td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

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

  408. 

  409. </div>

  410. </div>

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

  412. <div class="memitem">

  413. <div class="memproto">

  414. <table class="mlabels">

  415.   <tr>

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

  417.       <table class="memname">

  418.         <tr>

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

  420.           <td>(</td>

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

  422.           <td></td>

  423.         </tr>

  424.       </table>

  425.   </td>

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

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

  428.   </tr>

  429. </table>

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

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

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

  433. 

  434. </div>

  435. </div>

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

  437. <div class="memitem">

  438. <div class="memproto">

  439. <table class="mlabels">

  440.   <tr>

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

  442.       <table class="memname">

  443.         <tr>

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

  445.           <td>(</td>

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

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

  448.         </tr>

  449.         <tr>

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

  451.           <td></td>

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

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

  454.         </tr>

  455.         <tr>

  456.           <td></td>

  457.           <td>)</td>

  458.           <td></td><td></td>

  459.         </tr>

  460.       </table>

  461.   </td>

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

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

  464.   </tr>

  465. </table>

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

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

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

  469.   <table class="params">

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

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

  472.   </table>

  473.   </dd>

  474. </dl>

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

  476. 

  477. </div>

  478. </div>

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

  480. <div class="memitem">

  481. <div class="memproto">

  482. <table class="mlabels">

  483.   <tr>

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

  485.       <table class="memname">

  486.         <tr>

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

  488.           <td>(</td>

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

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

  491.         </tr>

  492.         <tr>

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

  494.           <td></td>

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

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

  497.         </tr>

  498.         <tr>

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

  500.           <td></td>

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

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

  503.         </tr>

  504.         <tr>

  505.           <td></td>

  506.           <td>)</td>

  507.           <td></td><td></td>

  508.         </tr>

  509.       </table>

  510.   </td>

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

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

  513.   </tr>

  514. </table>

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

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

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

  518.   <table class="params">

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

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

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

  522.   </table>

  523.   </dd>

  524. </dl>

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

  526. 

  527. </div>

  528. </div>

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

  530. <div class="memitem">

  531. <div class="memproto">

  532. <table class="mlabels">

  533.   <tr>

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

  535.       <table class="memname">

  536.         <tr>

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

  538.           <td>(</td>

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

  540.           <td> const</td>

  541.         </tr>

  542.       </table>

  543.   </td>

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

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

  546.   </tr>

  547. </table>

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

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

  550. 

  551. </div>

  552. </div>

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

  554. <div class="memitem">

  555. <div class="memproto">

  556. <table class="mlabels">

  557.   <tr>

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

  559.       <table class="memname">

  560.         <tr>

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

  562.           <td>(</td>

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

  564.           <td> const</td>

  565.         </tr>

  566.       </table>

  567.   </td>

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

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

  570.   </tr>

  571. </table>

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

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

  574. 

  575. </div>

  576. </div>

  577. <a class="anchor" id="a3b68e603ad8e47bad915f0547e580adb"></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">static <a class="el" href="class_fat_file.html">FatFile</a>* FatFile::cwd </td>

  586.           <td>(</td>

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

  588.           <td></td>

  589.         </tr>

  590.       </table>

  591.   </td>

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

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

  594.   </tr>

  595. </table>

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

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

  598. 

  599. </div>

  600. </div>

  601. <a class="anchor" id="a29a623f50df057e8b49045ba6611ec2b"></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">static void FatFile::dateTimeCallback </td>

  610.           <td>(</td>

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

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

  613.           <td></td>

  614.         </tr>

  615.       </table>

  616.   </td>

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

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

  619.   </tr>

  620. </table>

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

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

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

  624.   <table class="params">

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

  626.   </table>

  627.   </dd>

  628. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  643. 

  644. </div>

  645. </div>

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

  647. <div class="memitem">

  648. <div class="memproto">

  649. <table class="mlabels">

  650.   <tr>

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

  652.       <table class="memname">

  653.         <tr>

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

  655.           <td>(</td>

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

  657.           <td></td>

  658.         </tr>

  659.       </table>

  660.   </td>

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

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

  663.   </tr>

  664. </table>

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

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

  667. 

  668. </div>

  669. </div>

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

  671. <div class="memitem">

  672. <div class="memproto">

  673. <table class="mlabels">

  674.   <tr>

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

  676.       <table class="memname">

  677.         <tr>

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

  679.           <td>(</td>

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

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

  682.           <td></td>

  683.         </tr>

  684.       </table>

  685.   </td>

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

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

  688.   </tr>

  689. </table>

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

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

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

  693.   <table class="params">

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

  695.   </table>

  696.   </dd>

  697. </dl>

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

  699. 

  700. </div>

  701. </div>

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

  703. <div class="memitem">

  704. <div class="memproto">

  705. <table class="mlabels">

  706.   <tr>

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

  708.       <table class="memname">

  709.         <tr>

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

  711.           <td>(</td>

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

  713.           <td></td>

  714.         </tr>

  715.       </table>

  716.   </td>

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

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

  719.   </tr>

  720. </table>

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

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

  723. 

  724. </div>

  725. </div>

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

  727. <div class="memitem">

  728. <div class="memproto">

  729. <table class="mlabels">

  730.   <tr>

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

  732.       <table class="memname">

  733.         <tr>

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

  735.           <td>(</td>

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

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

  738.         </tr>

  739.         <tr>

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

  741.           <td></td>

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

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

  744.         </tr>

  745.         <tr>

  746.           <td></td>

  747.           <td>)</td>

  748.           <td></td><td></td>

  749.         </tr>

  750.       </table>

  751.   </td>

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

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

  754.   </tr>

  755. </table>

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

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

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

  759.   <table class="params">

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

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

  762.   </table>

  763.   </dd>

  764. </dl>

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

  766. 

  767. </div>

  768. </div>

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

  770. <div class="memitem">

  771. <div class="memproto">

  772. <table class="mlabels">

  773.   <tr>

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

  775.       <table class="memname">

  776.         <tr>

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

  778.           <td>(</td>

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

  780.           <td></td>

  781.         </tr>

  782.       </table>

  783.   </td>

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

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

  786.   </tr>

  787. </table>

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

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

  790. 

  791. </div>

  792. </div>

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

  794. <div class="memitem">

  795. <div class="memproto">

  796. <table class="mlabels">

  797.   <tr>

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

  799.       <table class="memname">

  800.         <tr>

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

  802.           <td>(</td>

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

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

  805.         </tr>

  806.         <tr>

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

  808.           <td></td>

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

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

  811.         </tr>

  812.         <tr>

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

  814.           <td></td>

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

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

  817.         </tr>

  818.         <tr>

  819.           <td></td>

  820.           <td>)</td>

  821.           <td></td><td></td>

  822.         </tr>

  823.       </table>

  824.   </td>

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

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

  827.   </tr>

  828. </table>

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

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

  831.   <table class="params">

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

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

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

  835.   </table>

  836.   </dd>

  837. </dl>

  838. 

  839. </div>

  840. </div>

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

  842. <div class="memitem">

  843. <div class="memproto">

  844. <table class="mlabels">

  845.   <tr>

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

  847.       <table class="memname">

  848.         <tr>

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

  850.           <td>(</td>

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

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

  853.           <td></td>

  854.         </tr>

  855.       </table>

  856.   </td>

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

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

  859.   </tr>

  860. </table>

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

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

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

  864.   <table class="params">

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

  866.   </table>

  867.   </dd>

  868. </dl>

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

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

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

  872. 

  873. </div>

  874. </div>

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

  876. <div class="memitem">

  877. <div class="memproto">

  878. <table class="mlabels">

  879.   <tr>

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

  881.       <table class="memname">

  882.         <tr>

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

  884.           <td>(</td>

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

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

  887.         </tr>

  888.         <tr>

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

  890.           <td></td>

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

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

  893.         </tr>

  894.         <tr>

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

  896.           <td></td>

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

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

  899.         </tr>

  900.         <tr>

  901.           <td></td>

  902.           <td>)</td>

  903.           <td></td><td></td>

  904.         </tr>

  905.       </table>

  906.   </td>

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

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

  909.   </tr>

  910. </table>

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

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

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

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

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

  916.   <table class="params">

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

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

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

  920.   </table>

  921.   </dd>

  922. </dl>

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

  924. 

  925. </div>

  926. </div>

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

  928. <div class="memitem">

  929. <div class="memproto">

  930. <table class="mlabels">

  931.   <tr>

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

  933.       <table class="memname">

  934.         <tr>

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

  936.           <td>(</td>

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

  938.           <td> const</td>

  939.         </tr>

  940.       </table>

  941.   </td>

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

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

  944.   </tr>

  945. </table>

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

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

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

  949. 

  950. </div>

  951. </div>

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

  953. <div class="memitem">

  954. <div class="memproto">

  955. <table class="mlabels">

  956.   <tr>

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

  958.       <table class="memname">

  959.         <tr>

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

  961.           <td>(</td>

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

  963.           <td> const</td>

  964.         </tr>

  965.       </table>

  966.   </td>

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

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

  969.   </tr>

  970. </table>

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

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

  973. 

  974. </div>

  975. </div>

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

  977. <div class="memitem">

  978. <div class="memproto">

  979. <table class="mlabels">

  980.   <tr>

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

  982.       <table class="memname">

  983.         <tr>

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

  985.           <td>(</td>

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

  987.           <td> const</td>

  988.         </tr>

  989.       </table>

  990.   </td>

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

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

  993.   </tr>

  994. </table>

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

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

  997. 

  998. </div>

  999. </div>

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

  1001. <div class="memitem">

  1002. <div class="memproto">

  1003. <table class="mlabels">

  1004.   <tr>

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

  1006.       <table class="memname">

  1007.         <tr>

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

  1009.           <td>(</td>

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

  1011.           <td></td>

  1012.         </tr>

  1013.       </table>

  1014.   </td>

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

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

  1017.   </tr>

  1018. </table>

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

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

  1021. 

  1022. </div>

  1023. </div>

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

  1025. <div class="memitem">

  1026. <div class="memproto">

  1027. <table class="mlabels">

  1028.   <tr>

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

  1030.       <table class="memname">

  1031.         <tr>

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

  1033.           <td>(</td>

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

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

  1036.         </tr>

  1037.         <tr>

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

  1039.           <td></td>

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

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

  1042.         </tr>

  1043.         <tr>

  1044.           <td></td>

  1045.           <td>)</td>

  1046.           <td></td><td></td>

  1047.         </tr>

  1048.       </table>

  1049.   </td>

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

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

  1052.   </tr>

  1053. </table>

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

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

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

  1057.   <table class="params">

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

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

  1060.   </table>

  1061.   </dd>

  1062. </dl>

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

  1064. 

  1065. </div>

  1066. </div>

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

  1068. <div class="memitem">

  1069. <div class="memproto">

  1070. <table class="mlabels">

  1071.   <tr>

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

  1073.       <table class="memname">

  1074.         <tr>

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

  1076.           <td>(</td>

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

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

  1079.           <td></td>

  1080.         </tr>

  1081.       </table>

  1082.   </td>

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

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

  1085.   </tr>

  1086. </table>

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

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

  1089.   <table class="params">

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

  1091.   </table>

  1092.   </dd>

  1093. </dl>

  1094. 

  1095. </div>

  1096. </div>

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

  1098. <div class="memitem">

  1099. <div class="memproto">

  1100. <table class="mlabels">

  1101.   <tr>

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

  1103.       <table class="memname">

  1104.         <tr>

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

  1106.           <td>(</td>

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

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

  1109.           <td></td>

  1110.         </tr>

  1111.       </table>

  1112.   </td>

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

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

  1115.   </tr>

  1116. </table>

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

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

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

  1120.   <table class="params">

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

  1122.   </table>

  1123.   </dd>

  1124. </dl>

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

  1126. 

  1127. </div>

  1128. </div>

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

  1130. <div class="memitem">

  1131. <div class="memproto">

  1132. <table class="mlabels">

  1133.   <tr>

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

  1135.       <table class="memname">

  1136.         <tr>

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

  1138.           <td>(</td>

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

  1140.           <td></td>

  1141.         </tr>

  1142.       </table>

  1143.   </td>

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

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

  1146.   </tr>

  1147. </table>

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

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

  1150. 

  1151. </div>

  1152. </div>

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

  1154. <div class="memitem">

  1155. <div class="memproto">

  1156. <table class="mlabels">

  1157.   <tr>

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

  1159.       <table class="memname">

  1160.         <tr>

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

  1162.           <td>(</td>

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

  1164.           <td> const</td>

  1165.         </tr>

  1166.       </table>

  1167.   </td>

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

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

  1170.   </tr>

  1171. </table>

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

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

  1174. 

  1175. </div>

  1176. </div>

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

  1178. <div class="memitem">

  1179. <div class="memproto">

  1180. <table class="mlabels">

  1181.   <tr>

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

  1183.       <table class="memname">

  1184.         <tr>

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

  1186.           <td>(</td>

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

  1188.           <td> const</td>

  1189.         </tr>

  1190.       </table>

  1191.   </td>

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

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

  1194.   </tr>

  1195. </table>

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

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

  1198. 

  1199. </div>

  1200. </div>

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

  1202. <div class="memitem">

  1203. <div class="memproto">

  1204. <table class="mlabels">

  1205.   <tr>

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

  1207.       <table class="memname">

  1208.         <tr>

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

  1210.           <td>(</td>

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

  1212.           <td> const</td>

  1213.         </tr>

  1214.       </table>

  1215.   </td>

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

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

  1218.   </tr>

  1219. </table>

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

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

  1222. 

  1223. </div>

  1224. </div>

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

  1226. <div class="memitem">

  1227. <div class="memproto">

  1228. <table class="mlabels">

  1229.   <tr>

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

  1231.       <table class="memname">

  1232.         <tr>

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

  1234.           <td>(</td>

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

  1236.           <td> const</td>

  1237.         </tr>

  1238.       </table>

  1239.   </td>

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

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

  1242.   </tr>

  1243. </table>

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

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

  1246. 

  1247. </div>

  1248. </div>

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

  1250. <div class="memitem">

  1251. <div class="memproto">

  1252. <table class="mlabels">

  1253.   <tr>

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

  1255.       <table class="memname">

  1256.         <tr>

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

  1258.           <td>(</td>

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

  1260.           <td> const</td>

  1261.         </tr>

  1262.       </table>

  1263.   </td>

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

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

  1266.   </tr>

  1267. </table>

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

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

  1270. 

  1271. </div>

  1272. </div>

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

  1274. <div class="memitem">

  1275. <div class="memproto">

  1276. <table class="mlabels">

  1277.   <tr>

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

  1279.       <table class="memname">

  1280.         <tr>

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

  1282.           <td>(</td>

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

  1284.           <td> const</td>

  1285.         </tr>

  1286.       </table>

  1287.   </td>

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

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

  1290.   </tr>

  1291. </table>

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

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

  1294. 

  1295. </div>

  1296. </div>

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

  1298. <div class="memitem">

  1299. <div class="memproto">

  1300. <table class="mlabels">

  1301.   <tr>

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

  1303.       <table class="memname">

  1304.         <tr>

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

  1306.           <td>(</td>

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

  1308.           <td> const</td>

  1309.         </tr>

  1310.       </table>

  1311.   </td>

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

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

  1314.   </tr>

  1315. </table>

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

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

  1318. 

  1319. </div>

  1320. </div>

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

  1322. <div class="memitem">

  1323. <div class="memproto">

  1324. <table class="mlabels">

  1325.   <tr>

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

  1327.       <table class="memname">

  1328.         <tr>

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

  1330.           <td>(</td>

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

  1332.           <td> const</td>

  1333.         </tr>

  1334.       </table>

  1335.   </td>

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

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

  1338.   </tr>

  1339. </table>

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

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

  1342. 

  1343. </div>

  1344. </div>

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

  1346. <div class="memitem">

  1347. <div class="memproto">

  1348. <table class="mlabels">

  1349.   <tr>

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

  1351.       <table class="memname">

  1352.         <tr>

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

  1354.           <td>(</td>

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

  1356.           <td> const</td>

  1357.         </tr>

  1358.       </table>

  1359.   </td>

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

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

  1362.   </tr>

  1363. </table>

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

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

  1366. 

  1367. </div>

  1368. </div>

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

  1370. <div class="memitem">

  1371. <div class="memproto">

  1372. <table class="mlabels">

  1373.   <tr>

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

  1375.       <table class="memname">

  1376.         <tr>

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

  1378.           <td>(</td>

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

  1380.           <td> const</td>

  1381.         </tr>

  1382.       </table>

  1383.   </td>

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

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

  1386.   </tr>

  1387. </table>

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

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

  1390. 

  1391. </div>

  1392. </div>

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

  1394. <div class="memitem">

  1395. <div class="memproto">

  1396. <table class="mlabels">

  1397.   <tr>

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

  1399.       <table class="memname">

  1400.         <tr>

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

  1402.           <td>(</td>

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

  1404.           <td> const</td>

  1405.         </tr>

  1406.       </table>

  1407.   </td>

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

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

  1410.   </tr>

  1411. </table>

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

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

  1414. 

  1415. </div>

  1416. </div>

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

  1418. <div class="memitem">

  1419. <div class="memproto">

  1420. <table class="mlabels">

  1421.   <tr>

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

  1423.       <table class="memname">

  1424.         <tr>

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

  1426.           <td>(</td>

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

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

  1429.           <td></td>

  1430.         </tr>

  1431.       </table>

  1432.   </td>

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

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

  1435.   </tr>

  1436. </table>

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

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

  1439.   <table class="params">

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

  1441.   </table>

  1442.   </dd>

  1443. </dl>

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

  1445. 

  1446. </div>

  1447. </div>

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

  1449. <div class="memitem">

  1450. <div class="memproto">

  1451. <table class="mlabels">

  1452.   <tr>

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

  1454.       <table class="memname">

  1455.         <tr>

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

  1457.           <td>(</td>

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

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

  1460.           <td></td>

  1461.         </tr>

  1462.       </table>

  1463.   </td>

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

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

  1466.   </tr>

  1467. </table>

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

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

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

  1471.   <table class="params">

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

  1473.   </table>

  1474.   </dd>

  1475. </dl>

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

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

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

  1479. 

  1480. </div>

  1481. </div>

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

  1483. <div class="memitem">

  1484. <div class="memproto">

  1485. <table class="mlabels">

  1486.   <tr>

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

  1488.       <table class="memname">

  1489.         <tr>

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

  1491.           <td>(</td>

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

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

  1494.         </tr>

  1495.         <tr>

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

  1497.           <td></td>

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

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

  1500.         </tr>

  1501.         <tr>

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

  1503.           <td></td>

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

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

  1506.         </tr>

  1507.         <tr>

  1508.           <td></td>

  1509.           <td>)</td>

  1510.           <td></td><td></td>

  1511.         </tr>

  1512.       </table>

  1513.   </td>

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

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

  1516.   </tr>

  1517. </table>

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

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

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

  1521.   <table class="params">

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

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

  1524.   </table>

  1525.   </dd>

  1526. </dl>

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

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

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

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

  1531.   <table class="params">

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

  1533.   </table>

  1534.   </dd>

  1535. </dl>

  1536. 

  1537. </div>

  1538. </div>

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

  1540. <div class="memitem">

  1541. <div class="memproto">

  1542. <table class="mlabels">

  1543.   <tr>

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

  1545.       <table class="memname">

  1546.         <tr>

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

  1548.           <td>(</td>

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

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

  1551.         </tr>

  1552.         <tr>

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

  1554.           <td></td>

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

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

  1557.         </tr>

  1558.         <tr>

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

  1560.           <td></td>

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

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

  1563.         </tr>

  1564.         <tr>

  1565.           <td></td>

  1566.           <td>)</td>

  1567.           <td></td><td></td>

  1568.         </tr>

  1569.       </table>

  1570.   </td>

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

  1572. <span class="mlabels"><span class="mlabel">inherited</span></span>  </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="mlabels">

  1593.   <tr>

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

  1595.       <table class="memname">

  1596.         <tr>

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

  1598.           <td>(</td>

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

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

  1601.         </tr>

  1602.         <tr>

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

  1604.           <td></td>

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

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

  1607.         </tr>

  1608.         <tr>

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

  1610.           <td></td>

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

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

  1613.         </tr>

  1614.         <tr>

  1615.           <td></td>

  1616.           <td>)</td>

  1617.           <td></td><td></td>

  1618.         </tr>

  1619.       </table>

  1620.   </td>

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

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

  1623.   </tr>

  1624. </table>

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

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

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

  1628.   <table class="params">

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

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

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

  1632.   </table>

  1633.   </dd>

  1634. </dl>

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

  1636. 

  1637. </div>

  1638. </div>

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

  1640. <div class="memitem">

  1641. <div class="memproto">

  1642. <table class="mlabels">

  1643.   <tr>

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

  1645.       <table class="memname">

  1646.         <tr>

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

  1648.           <td>(</td>

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

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

  1651.         </tr>

  1652.         <tr>

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

  1654.           <td></td>

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

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

  1657.         </tr>

  1658.         <tr>

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

  1660.           <td></td>

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

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

  1663.         </tr>

  1664.         <tr>

  1665.           <td></td>

  1666.           <td>)</td>

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

  1668.         </tr>

  1669.       </table>

  1670.   </td>

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

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

  1673.   </tr>

  1674. </table>

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

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

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

  1678.   <table class="params">

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

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

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

  1682.   </table>

  1683.   </dd>

  1684. </dl>

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

  1686. 

  1687. </div>

  1688. </div>

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

  1690. <div class="memitem">

  1691. <div class="memproto">

  1692. <table class="mlabels">

  1693.   <tr>

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

  1695.       <table class="memname">

  1696.         <tr>

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

  1698.           <td>(</td>

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

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

  1701.         </tr>

  1702.         <tr>

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

  1704.           <td></td>

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

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

  1707.         </tr>

  1708.         <tr>

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

  1710.           <td></td>

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

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

  1713.         </tr>

  1714.         <tr>

  1715.           <td></td>

  1716.           <td>)</td>

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

  1718.         </tr>

  1719.       </table>

  1720.   </td>

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

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

  1723.   </tr>

  1724. </table>

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

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

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

  1728.   <table class="params">

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

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

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

  1732.   </table>

  1733.   </dd>

  1734. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1749. 

  1750. </div>

  1751. </div>

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

  1753. <div class="memitem">

  1754. <div class="memproto">

  1755. <table class="mlabels">

  1756.   <tr>

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

  1758.       <table class="memname">

  1759.         <tr>

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

  1761.           <td>(</td>

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

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

  1764.         </tr>

  1765.         <tr>

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

  1767.           <td></td>

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

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

  1770.         </tr>

  1771.         <tr>

  1772.           <td></td>

  1773.           <td>)</td>

  1774.           <td></td><td></td>

  1775.         </tr>

  1776.       </table>

  1777.   </td>

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

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

  1780.   </tr>

  1781. </table>

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

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

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

  1785.   <table class="params">

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

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

  1788.   </table>

  1789.   </dd>

  1790. </dl>

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

  1792. 

  1793. </div>

  1794. </div>

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

  1796. <div class="memitem">

  1797. <div class="memproto">

  1798. <table class="mlabels">

  1799.   <tr>

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

  1801.       <table class="memname">

  1802.         <tr>

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

  1804.           <td>(</td>

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

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

  1807.         </tr>

  1808.         <tr>

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

  1810.           <td></td>

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

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

  1813.         </tr>

  1814.         <tr>

  1815.           <td></td>

  1816.           <td>)</td>

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

  1818.         </tr>

  1819.       </table>

  1820.   </td>

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

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

  1823.   </tr>

  1824. </table>

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

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

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

  1828.   <table class="params">

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

  1830.     <tr><td class="paramdir">[in]</td><td class="paramname">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>

  1831.   </table>

  1832.   </dd>

  1833. </dl>

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

  1835. 

  1836. </div>

  1837. </div>

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

  1839. <div class="memitem">

  1840. <div class="memproto">

  1841. <table class="mlabels">

  1842.   <tr>

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

  1844.       <table class="memname">

  1845.         <tr>

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

  1847.           <td>(</td>

  1848.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1849.           <td class="paramname"><em>vol</em></td><td>)</td>

  1850.           <td></td>

  1851.         </tr>

  1852.       </table>

  1853.   </td>

  1854.   <td class="mlabels-right">

  1855. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1856.   </tr>

  1857. </table>

  1858. </div><div class="memdoc">

  1859. <p>Open a volume's root directory.</p>

  1860. <dl class="params"><dt>Parameters</dt><dd>

  1861.   <table class="params">

  1862.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1863.   </table>

  1864.   </dd>

  1865. </dl>

  1866. <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>

  1867. 

  1868. </div>

  1869. </div>

  1870. <a class="anchor" id="ac05b7136b887539426856c623869aa3a"></a>

  1871. <div class="memitem">

  1872. <div class="memproto">

  1873. <table class="mlabels">

  1874.   <tr>

  1875.   <td class="mlabels-left">

  1876.       <table class="memname">

  1877.         <tr>

  1878.           <td class="memname">int FatFile::peek </td>

  1879.           <td>(</td>

  1880.           <td class="paramname"></td><td>)</td>

  1881.           <td></td>

  1882.         </tr>

  1883.       </table>

  1884.   </td>

  1885.   <td class="mlabels-right">

  1886. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1887.   </tr>

  1888. </table>

  1889. </div><div class="memdoc">

  1890. <p>Return the next available byte without consuming it.</p>

  1891. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1892. 

  1893. </div>

  1894. </div>

  1895. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1896. <div class="memitem">

  1897. <div class="memproto">

  1898. <table class="mlabels">

  1899.   <tr>

  1900.   <td class="mlabels-left">

  1901.       <table class="memname">

  1902.         <tr>

  1903.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1904.           <td>(</td>

  1905.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1906.           <td class="paramname"><em>pr</em></td><td>)</td>

  1907.           <td></td>

  1908.         </tr>

  1909.       </table>

  1910.   </td>

  1911.   <td class="mlabels-right">

  1912. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1913.   </tr>

  1914. </table>

  1915. </div><div class="memdoc">

  1916. <p>Print a file's creation date and time</p>

  1917. <dl class="params"><dt>Parameters</dt><dd>

  1918.   <table class="params">

  1919.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1920.   </table>

  1921.   </dd>

  1922. </dl>

  1923. <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>

  1924. 

  1925. </div>

  1926. </div>

  1927. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1928. <div class="memitem">

  1929. <div class="memproto">

  1930. <table class="mlabels">

  1931.   <tr>

  1932.   <td class="mlabels-left">

  1933.       <table class="memname">

  1934.         <tr>

  1935.           <td class="memname">static void FatFile::printFatDate </td>

  1936.           <td>(</td>

  1937.           <td class="paramtype">uint16_t&#160;</td>

  1938.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1939.           <td></td>

  1940.         </tr>

  1941.       </table>

  1942.   </td>

  1943.   <td class="mlabels-right">

  1944. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1945.   </tr>

  1946. </table>

  1947. </div><div class="memdoc">

  1948. <p>Print a directory date field.</p>

  1949. <p>Format is yyyy-mm-dd.</p>

  1950. <dl class="params"><dt>Parameters</dt><dd>

  1951.   <table class="params">

  1952.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1953.   </table>

  1954.   </dd>

  1955. </dl>

  1956. 

  1957. </div>

  1958. </div>

  1959. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1960. <div class="memitem">

  1961. <div class="memproto">

  1962. <table class="mlabels">

  1963.   <tr>

  1964.   <td class="mlabels-left">

  1965.       <table class="memname">

  1966.         <tr>

  1967.           <td class="memname">void FatFile::printFatDate </td>

  1968.           <td>(</td>

  1969.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1970.           <td class="paramname"><em>pr</em>, </td>

  1971.         </tr>

  1972.         <tr>

  1973.           <td class="paramkey"></td>

  1974.           <td></td>

  1975.           <td class="paramtype">uint16_t&#160;</td>

  1976.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1977.         </tr>

  1978.         <tr>

  1979.           <td></td>

  1980.           <td>)</td>

  1981.           <td></td><td></td>

  1982.         </tr>

  1983.       </table>

  1984.   </td>

  1985.   <td class="mlabels-right">

  1986. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1987.   </tr>

  1988. </table>

  1989. </div><div class="memdoc">

  1990. <p>Print a directory date field.</p>

  1991. <p>Format is yyyy-mm-dd.</p>

  1992. <dl class="params"><dt>Parameters</dt><dd>

  1993.   <table class="params">

  1994.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1995.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1996.   </table>

  1997.   </dd>

  1998. </dl>

  1999. 

  2000. </div>

  2001. </div>

  2002. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2003. <div class="memitem">

  2004. <div class="memproto">

  2005. <table class="mlabels">

  2006.   <tr>

  2007.   <td class="mlabels-left">

  2008.       <table class="memname">

  2009.         <tr>

  2010.           <td class="memname">static void FatFile::printFatTime </td>

  2011.           <td>(</td>

  2012.           <td class="paramtype">uint16_t&#160;</td>

  2013.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2014.           <td></td>

  2015.         </tr>

  2016.       </table>

  2017.   </td>

  2018.   <td class="mlabels-right">

  2019. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2020.   </tr>

  2021. </table>

  2022. </div><div class="memdoc">

  2023. <p>Print a directory time field.</p>

  2024. <p>Format is hh:mm:ss.</p>

  2025. <dl class="params"><dt>Parameters</dt><dd>

  2026.   <table class="params">

  2027.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2028.   </table>

  2029.   </dd>

  2030. </dl>

  2031. 

  2032. </div>

  2033. </div>

  2034. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2035. <div class="memitem">

  2036. <div class="memproto">

  2037. <table class="mlabels">

  2038.   <tr>

  2039.   <td class="mlabels-left">

  2040.       <table class="memname">

  2041.         <tr>

  2042.           <td class="memname">void FatFile::printFatTime </td>

  2043.           <td>(</td>

  2044.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2045.           <td class="paramname"><em>pr</em>, </td>

  2046.         </tr>

  2047.         <tr>

  2048.           <td class="paramkey"></td>

  2049.           <td></td>

  2050.           <td class="paramtype">uint16_t&#160;</td>

  2051.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2052.         </tr>

  2053.         <tr>

  2054.           <td></td>

  2055.           <td>)</td>

  2056.           <td></td><td></td>

  2057.         </tr>

  2058.       </table>

  2059.   </td>

  2060.   <td class="mlabels-right">

  2061. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2062.   </tr>

  2063. </table>

  2064. </div><div class="memdoc">

  2065. <p>Print a directory time field.</p>

  2066. <p>Format is hh:mm:ss.</p>

  2067. <dl class="params"><dt>Parameters</dt><dd>

  2068.   <table class="params">

  2069.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2070.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2071.   </table>

  2072.   </dd>

  2073. </dl>

  2074. 

  2075. </div>

  2076. </div>

  2077. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2078. <div class="memitem">

  2079. <div class="memproto">

  2080. <table class="mlabels">

  2081.   <tr>

  2082.   <td class="mlabels-left">

  2083.       <table class="memname">

  2084.         <tr>

  2085.           <td class="memname">int FatFile::printField </td>

  2086.           <td>(</td>

  2087.           <td class="paramtype">float&#160;</td>

  2088.           <td class="paramname"><em>value</em>, </td>

  2089.         </tr>

  2090.         <tr>

  2091.           <td class="paramkey"></td>

  2092.           <td></td>

  2093.           <td class="paramtype">char&#160;</td>

  2094.           <td class="paramname"><em>term</em>, </td>

  2095.         </tr>

  2096.         <tr>

  2097.           <td class="paramkey"></td>

  2098.           <td></td>

  2099.           <td class="paramtype">uint8_t&#160;</td>

  2100.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2101.         </tr>

  2102.         <tr>

  2103.           <td></td>

  2104.           <td>)</td>

  2105.           <td></td><td></td>

  2106.         </tr>

  2107.       </table>

  2108.   </td>

  2109.   <td class="mlabels-right">

  2110. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2111.   </tr>

  2112. </table>

  2113. </div><div class="memdoc">

  2114. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2115.   <table class="params">

  2116.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2117.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2118.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2119.   </table>

  2120.   </dd>

  2121. </dl>

  2122. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2123. 

  2124. </div>

  2125. </div>

  2126. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2127. <div class="memitem">

  2128. <div class="memproto">

  2129. <table class="mlabels">

  2130.   <tr>

  2131.   <td class="mlabels-left">

  2132.       <table class="memname">

  2133.         <tr>

  2134.           <td class="memname">int FatFile::printField </td>

  2135.           <td>(</td>

  2136.           <td class="paramtype">int16_t&#160;</td>

  2137.           <td class="paramname"><em>value</em>, </td>

  2138.         </tr>

  2139.         <tr>

  2140.           <td class="paramkey"></td>

  2141.           <td></td>

  2142.           <td class="paramtype">char&#160;</td>

  2143.           <td class="paramname"><em>term</em>&#160;</td>

  2144.         </tr>

  2145.         <tr>

  2146.           <td></td>

  2147.           <td>)</td>

  2148.           <td></td><td></td>

  2149.         </tr>

  2150.       </table>

  2151.   </td>

  2152.   <td class="mlabels-right">

  2153. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2154.   </tr>

  2155. </table>

  2156. </div><div class="memdoc">

  2157. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2158.   <table class="params">

  2159.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2160.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2161.   </table>

  2162.   </dd>

  2163. </dl>

  2164. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2165. 

  2166. </div>

  2167. </div>

  2168. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2169. <div class="memitem">

  2170. <div class="memproto">

  2171. <table class="mlabels">

  2172.   <tr>

  2173.   <td class="mlabels-left">

  2174.       <table class="memname">

  2175.         <tr>

  2176.           <td class="memname">int FatFile::printField </td>

  2177.           <td>(</td>

  2178.           <td class="paramtype">uint16_t&#160;</td>

  2179.           <td class="paramname"><em>value</em>, </td>

  2180.         </tr>

  2181.         <tr>

  2182.           <td class="paramkey"></td>

  2183.           <td></td>

  2184.           <td class="paramtype">char&#160;</td>

  2185.           <td class="paramname"><em>term</em>&#160;</td>

  2186.         </tr>

  2187.         <tr>

  2188.           <td></td>

  2189.           <td>)</td>

  2190.           <td></td><td></td>

  2191.         </tr>

  2192.       </table>

  2193.   </td>

  2194.   <td class="mlabels-right">

  2195. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2196.   </tr>

  2197. </table>

  2198. </div><div class="memdoc">

  2199. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2200.   <table class="params">

  2201.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2202.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2203.   </table>

  2204.   </dd>

  2205. </dl>

  2206. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2207. 

  2208. </div>

  2209. </div>

  2210. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2211. <div class="memitem">

  2212. <div class="memproto">

  2213. <table class="mlabels">

  2214.   <tr>

  2215.   <td class="mlabels-left">

  2216.       <table class="memname">

  2217.         <tr>

  2218.           <td class="memname">int FatFile::printField </td>

  2219.           <td>(</td>

  2220.           <td class="paramtype">int32_t&#160;</td>

  2221.           <td class="paramname"><em>value</em>, </td>

  2222.         </tr>

  2223.         <tr>

  2224.           <td class="paramkey"></td>

  2225.           <td></td>

  2226.           <td class="paramtype">char&#160;</td>

  2227.           <td class="paramname"><em>term</em>&#160;</td>

  2228.         </tr>

  2229.         <tr>

  2230.           <td></td>

  2231.           <td>)</td>

  2232.           <td></td><td></td>

  2233.         </tr>

  2234.       </table>

  2235.   </td>

  2236.   <td class="mlabels-right">

  2237. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2238.   </tr>

  2239. </table>

  2240. </div><div class="memdoc">

  2241. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2242.   <table class="params">

  2243.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2244.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2245.   </table>

  2246.   </dd>

  2247. </dl>

  2248. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2249. 

  2250. </div>

  2251. </div>

  2252. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2253. <div class="memitem">

  2254. <div class="memproto">

  2255. <table class="mlabels">

  2256.   <tr>

  2257.   <td class="mlabels-left">

  2258.       <table class="memname">

  2259.         <tr>

  2260.           <td class="memname">int FatFile::printField </td>

  2261.           <td>(</td>

  2262.           <td class="paramtype">uint32_t&#160;</td>

  2263.           <td class="paramname"><em>value</em>, </td>

  2264.         </tr>

  2265.         <tr>

  2266.           <td class="paramkey"></td>

  2267.           <td></td>

  2268.           <td class="paramtype">char&#160;</td>

  2269.           <td class="paramname"><em>term</em>&#160;</td>

  2270.         </tr>

  2271.         <tr>

  2272.           <td></td>

  2273.           <td>)</td>

  2274.           <td></td><td></td>

  2275.         </tr>

  2276.       </table>

  2277.   </td>

  2278.   <td class="mlabels-right">

  2279. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2280.   </tr>

  2281. </table>

  2282. </div><div class="memdoc">

  2283. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2284.   <table class="params">

  2285.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2286.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2287.   </table>

  2288.   </dd>

  2289. </dl>

  2290. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2291. 

  2292. </div>

  2293. </div>

  2294. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2295. <div class="memitem">

  2296. <div class="memproto">

  2297. <table class="mlabels">

  2298.   <tr>

  2299.   <td class="mlabels-left">

  2300.       <table class="memname">

  2301.         <tr>

  2302.           <td class="memname">size_t FatFile::printFileSize </td>

  2303.           <td>(</td>

  2304.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2305.           <td class="paramname"><em>pr</em></td><td>)</td>

  2306.           <td></td>

  2307.         </tr>

  2308.       </table>

  2309.   </td>

  2310.   <td class="mlabels-right">

  2311. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2312.   </tr>

  2313. </table>

  2314. </div><div class="memdoc">

  2315. <p>Print a file's size.</p>

  2316. <dl class="params"><dt>Parameters</dt><dd>

  2317.   <table class="params">

  2318.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2319.   </table>

  2320.   </dd>

  2321. </dl>

  2322. <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>

  2323. 

  2324. </div>

  2325. </div>

  2326. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2327. <div class="memitem">

  2328. <div class="memproto">

  2329. <table class="mlabels">

  2330.   <tr>

  2331.   <td class="mlabels-left">

  2332.       <table class="memname">

  2333.         <tr>

  2334.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2335.           <td>(</td>

  2336.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2337.           <td class="paramname"><em>pr</em></td><td>)</td>

  2338.           <td></td>

  2339.         </tr>

  2340.       </table>

  2341.   </td>

  2342.   <td class="mlabels-right">

  2343. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2344.   </tr>

  2345. </table>

  2346. </div><div class="memdoc">

  2347. <p>Print a file's modify date and time</p>

  2348. <dl class="params"><dt>Parameters</dt><dd>

  2349.   <table class="params">

  2350.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2351.   </table>

  2352.   </dd>

  2353. </dl>

  2354. <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>

  2355. 

  2356. </div>

  2357. </div>

  2358. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2359. <div class="memitem">

  2360. <div class="memproto">

  2361. <table class="mlabels">

  2362.   <tr>

  2363.   <td class="mlabels-left">

  2364.       <table class="memname">

  2365.         <tr>

  2366.           <td class="memname">size_t FatFile::printName </td>

  2367.           <td>(</td>

  2368.           <td class="paramname"></td><td>)</td>

  2369.           <td></td>

  2370.         </tr>

  2371.       </table>

  2372.   </td>

  2373.   <td class="mlabels-right">

  2374. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2375.   </tr>

  2376. </table>

  2377. </div><div class="memdoc">

  2378. <p>Print a file's name.</p>

  2379. <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>

  2380. 

  2381. </div>

  2382. </div>

  2383. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2384. <div class="memitem">

  2385. <div class="memproto">

  2386. <table class="mlabels">

  2387.   <tr>

  2388.   <td class="mlabels-left">

  2389.       <table class="memname">

  2390.         <tr>

  2391.           <td class="memname">size_t FatFile::printName </td>

  2392.           <td>(</td>

  2393.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2394.           <td class="paramname"><em>pr</em></td><td>)</td>

  2395.           <td></td>

  2396.         </tr>

  2397.       </table>

  2398.   </td>

  2399.   <td class="mlabels-right">

  2400. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2401.   </tr>

  2402. </table>

  2403. </div><div class="memdoc">

  2404. <p>Print a file's name</p>

  2405. <dl class="params"><dt>Parameters</dt><dd>

  2406.   <table class="params">

  2407.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2408.   </table>

  2409.   </dd>

  2410. </dl>

  2411. <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>

  2412. 

  2413. </div>

  2414. </div>

  2415. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2416. <div class="memitem">

  2417. <div class="memproto">

  2418. <table class="mlabels">

  2419.   <tr>

  2420.   <td class="mlabels-left">

  2421.       <table class="memname">

  2422.         <tr>

  2423.           <td class="memname">size_t FatFile::printSFN </td>

  2424.           <td>(</td>

  2425.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2426.           <td class="paramname"><em>pr</em></td><td>)</td>

  2427.           <td></td>

  2428.         </tr>

  2429.       </table>

  2430.   </td>

  2431.   <td class="mlabels-right">

  2432. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2433.   </tr>

  2434. </table>

  2435. </div><div class="memdoc">

  2436. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2437. <dl class="params"><dt>Parameters</dt><dd>

  2438.   <table class="params">

  2439.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2440.   </table>

  2441.   </dd>

  2442. </dl>

  2443. <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>

  2444. 

  2445. </div>

  2446. </div>

  2447. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2448. <div class="memitem">

  2449. <div class="memproto">

  2450. <table class="mlabels">

  2451.   <tr>

  2452.   <td class="mlabels-left">

  2453.       <table class="memname">

  2454.         <tr>

  2455.           <td class="memname">int FatFile::read </td>

  2456.           <td>(</td>

  2457.           <td class="paramname"></td><td>)</td>

  2458.           <td></td>

  2459.         </tr>

  2460.       </table>

  2461.   </td>

  2462.   <td class="mlabels-right">

  2463. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2464.   </tr>

  2465. </table>

  2466. </div><div class="memdoc">

  2467. <p>Read the next byte from a file.</p>

  2468. <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>

  2469. 

  2470. </div>

  2471. </div>

  2472. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2473. <div class="memitem">

  2474. <div class="memproto">

  2475. <table class="mlabels">

  2476.   <tr>

  2477.   <td class="mlabels-left">

  2478.       <table class="memname">

  2479.         <tr>

  2480.           <td class="memname">int FatFile::read </td>

  2481.           <td>(</td>

  2482.           <td class="paramtype">void *&#160;</td>

  2483.           <td class="paramname"><em>buf</em>, </td>

  2484.         </tr>

  2485.         <tr>

  2486.           <td class="paramkey"></td>

  2487.           <td></td>

  2488.           <td class="paramtype">size_t&#160;</td>

  2489.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2490.         </tr>

  2491.         <tr>

  2492.           <td></td>

  2493.           <td>)</td>

  2494.           <td></td><td></td>

  2495.         </tr>

  2496.       </table>

  2497.   </td>

  2498.   <td class="mlabels-right">

  2499. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2500.   </tr>

  2501. </table>

  2502. </div><div class="memdoc">

  2503. <p>Read data from a file starting at the current position.</p>

  2504. <dl class="params"><dt>Parameters</dt><dd>

  2505.   <table class="params">

  2506.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2507.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2508.   </table>

  2509.   </dd>

  2510. </dl>

  2511. <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>

  2512. 

  2513. </div>

  2514. </div>

  2515. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2516. <div class="memitem">

  2517. <div class="memproto">

  2518. <table class="mlabels">

  2519.   <tr>

  2520.   <td class="mlabels-left">

  2521.       <table class="memname">

  2522.         <tr>

  2523.           <td class="memname">int8_t FatFile::readDir </td>

  2524.           <td>(</td>

  2525.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2526.           <td class="paramname"><em>dir</em></td><td>)</td>

  2527.           <td></td>

  2528.         </tr>

  2529.       </table>

  2530.   </td>

  2531.   <td class="mlabels-right">

  2532. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2533.   </tr>

  2534. </table>

  2535. </div><div class="memdoc">

  2536. <p>Read the next directory entry from a directory file.</p>

  2537. <dl class="params"><dt>Parameters</dt><dd>

  2538.   <table class="params">

  2539.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2540.   </table>

  2541.   </dd>

  2542. </dl>

  2543. <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>

  2544. 

  2545. </div>

  2546. </div>

  2547. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2548. <div class="memitem">

  2549. <div class="memproto">

  2550. <table class="mlabels">

  2551.   <tr>

  2552.   <td class="mlabels-left">

  2553.       <table class="memname">

  2554.         <tr>

  2555.           <td class="memname">bool FatFile::remove </td>

  2556.           <td>(</td>

  2557.           <td class="paramname"></td><td>)</td>

  2558.           <td></td>

  2559.         </tr>

  2560.       </table>

  2561.   </td>

  2562.   <td class="mlabels-right">

  2563. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2564.   </tr>

  2565. </table>

  2566. </div><div class="memdoc">

  2567. <p>Remove a file.</p>

  2568. <p>The directory entry and all data for the file are deleted.</p>

  2569. <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>

  2570. <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>

  2571. 

  2572. </div>

  2573. </div>

  2574. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2575. <div class="memitem">

  2576. <div class="memproto">

  2577. <table class="mlabels">

  2578.   <tr>

  2579.   <td class="mlabels-left">

  2580.       <table class="memname">

  2581.         <tr>

  2582.           <td class="memname">bool FatFile::remove </td>

  2583.           <td>(</td>

  2584.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2585.           <td class="paramname"><em>dirFile</em>, </td>

  2586.         </tr>

  2587.         <tr>

  2588.           <td class="paramkey"></td>

  2589.           <td></td>

  2590.           <td class="paramtype">const char *&#160;</td>

  2591.           <td class="paramname"><em>path</em>&#160;</td>

  2592.         </tr>

  2593.         <tr>

  2594.           <td></td>

  2595.           <td>)</td>

  2596.           <td></td><td></td>

  2597.         </tr>

  2598.       </table>

  2599.   </td>

  2600.   <td class="mlabels-right">

  2601. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2602.   </tr>

  2603. </table>

  2604. </div><div class="memdoc">

  2605. <p>Remove a file.</p>

  2606. <p>The directory entry and all data for the file are deleted.</p>

  2607. <dl class="params"><dt>Parameters</dt><dd>

  2608.   <table class="params">

  2609.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2610.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2611.   </table>

  2612.   </dd>

  2613. </dl>

  2614. <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>

  2615. <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>

  2616. 

  2617. </div>

  2618. </div>

  2619. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2620. <div class="memitem">

  2621. <div class="memproto">

  2622. <table class="mlabels">

  2623.   <tr>

  2624.   <td class="mlabels-left">

  2625.       <table class="memname">

  2626.         <tr>

  2627.           <td class="memname">bool FatFile::rename </td>

  2628.           <td>(</td>

  2629.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2630.           <td class="paramname"><em>dirFile</em>, </td>

  2631.         </tr>

  2632.         <tr>

  2633.           <td class="paramkey"></td>

  2634.           <td></td>

  2635.           <td class="paramtype">const char *&#160;</td>

  2636.           <td class="paramname"><em>newPath</em>&#160;</td>

  2637.         </tr>

  2638.         <tr>

  2639.           <td></td>

  2640.           <td>)</td>

  2641.           <td></td><td></td>

  2642.         </tr>

  2643.       </table>

  2644.   </td>

  2645.   <td class="mlabels-right">

  2646. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2647.   </tr>

  2648. </table>

  2649. </div><div class="memdoc">

  2650. <p>Rename a file or subdirectory.</p>

  2651. <dl class="params"><dt>Parameters</dt><dd>

  2652.   <table class="params">

  2653.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2654.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2655.   </table>

  2656.   </dd>

  2657. </dl>

  2658. <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>

  2659. 

  2660. </div>

  2661. </div>

  2662. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2663. <div class="memitem">

  2664. <div class="memproto">

  2665. <table class="mlabels">

  2666.   <tr>

  2667.   <td class="mlabels-left">

  2668.       <table class="memname">

  2669.         <tr>

  2670.           <td class="memname">void FatFile::rewind </td>

  2671.           <td>(</td>

  2672.           <td class="paramname"></td><td>)</td>

  2673.           <td></td>

  2674.         </tr>

  2675.       </table>

  2676.   </td>

  2677.   <td class="mlabels-right">

  2678. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2679.   </tr>

  2680. </table>

  2681. </div><div class="memdoc">

  2682. <p>Set the file's current position to zero. </p>

  2683. 

  2684. </div>

  2685. </div>

  2686. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2687. <div class="memitem">

  2688. <div class="memproto">

  2689. <table class="mlabels">

  2690.   <tr>

  2691.   <td class="mlabels-left">

  2692.       <table class="memname">

  2693.         <tr>

  2694.           <td class="memname">bool FatFile::rmdir </td>

  2695.           <td>(</td>

  2696.           <td class="paramname"></td><td>)</td>

  2697.           <td></td>

  2698.         </tr>

  2699.       </table>

  2700.   </td>

  2701.   <td class="mlabels-right">

  2702. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2703.   </tr>

  2704. </table>

  2705. </div><div class="memdoc">

  2706. <p>Remove a directory file.</p>

  2707. <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>

  2708. <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>

  2709. <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>

  2710. 

  2711. </div>

  2712. </div>

  2713. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2714. <div class="memitem">

  2715. <div class="memproto">

  2716. <table class="mlabels">

  2717.   <tr>

  2718.   <td class="mlabels-left">

  2719.       <table class="memname">

  2720.         <tr>

  2721.           <td class="memname">bool FatFile::rmRfStar </td>

  2722.           <td>(</td>

  2723.           <td class="paramname"></td><td>)</td>

  2724.           <td></td>

  2725.         </tr>

  2726.       </table>

  2727.   </td>

  2728.   <td class="mlabels-right">

  2729. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2730.   </tr>

  2731. </table>

  2732. </div><div class="memdoc">

  2733. <p>Recursively delete a directory and all contained files.</p>

  2734. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2735. <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>

  2736. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a directory that has a long name. 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>

  2737. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2738. 

  2739. </div>

  2740. </div>

  2741. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2742. <div class="memitem">

  2743. <div class="memproto">

  2744. <table class="mlabels">

  2745.   <tr>

  2746.   <td class="mlabels-left">

  2747.       <table class="memname">

  2748.         <tr>

  2749.           <td class="memname">bool FatFile::seekCur </td>

  2750.           <td>(</td>

  2751.           <td class="paramtype">int32_t&#160;</td>

  2752.           <td class="paramname"><em>offset</em></td><td>)</td>

  2753.           <td></td>

  2754.         </tr>

  2755.       </table>

  2756.   </td>

  2757.   <td class="mlabels-right">

  2758. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2759.   </tr>

  2760. </table>

  2761. </div><div class="memdoc">

  2762. <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>

  2763.   <table class="params">

  2764.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2765.   </table>

  2766.   </dd>

  2767. </dl>

  2768. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2769. 

  2770. </div>

  2771. </div>

  2772. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2773. <div class="memitem">

  2774. <div class="memproto">

  2775. <table class="mlabels">

  2776.   <tr>

  2777.   <td class="mlabels-left">

  2778.       <table class="memname">

  2779.         <tr>

  2780.           <td class="memname">bool FatFile::seekEnd </td>

  2781.           <td>(</td>

  2782.           <td class="paramtype">int32_t&#160;</td>

  2783.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2784.           <td></td>

  2785.         </tr>

  2786.       </table>

  2787.   </td>

  2788.   <td class="mlabels-right">

  2789. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2790.   </tr>

  2791. </table>

  2792. </div><div class="memdoc">

  2793. <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>

  2794.   <table class="params">

  2795.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2796.   </table>

  2797.   </dd>

  2798. </dl>

  2799. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2800. 

  2801. </div>

  2802. </div>

  2803. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2804. <div class="memitem">

  2805. <div class="memproto">

  2806. <table class="mlabels">

  2807.   <tr>

  2808.   <td class="mlabels-left">

  2809.       <table class="memname">

  2810.         <tr>

  2811.           <td class="memname">bool FatFile::seekSet </td>

  2812.           <td>(</td>

  2813.           <td class="paramtype">uint32_t&#160;</td>

  2814.           <td class="paramname"><em>pos</em></td><td>)</td>

  2815.           <td></td>

  2816.         </tr>

  2817.       </table>

  2818.   </td>

  2819.   <td class="mlabels-right">

  2820. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2821.   </tr>

  2822. </table>

  2823. </div><div class="memdoc">

  2824. <p>Sets a file's position.</p>

  2825. <dl class="params"><dt>Parameters</dt><dd>

  2826.   <table class="params">

  2827.     <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>

  2828.   </table>

  2829.   </dd>

  2830. </dl>

  2831. <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>

  2832. 

  2833. </div>

  2834. </div>

  2835. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2836. <div class="memitem">

  2837. <div class="memproto">

  2838. <table class="mlabels">

  2839.   <tr>

  2840.   <td class="mlabels-left">

  2841.       <table class="memname">

  2842.         <tr>

  2843.           <td class="memname">static bool FatFile::setCwd </td>

  2844.           <td>(</td>

  2845.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2846.           <td class="paramname"><em>dir</em></td><td>)</td>

  2847.           <td></td>

  2848.         </tr>

  2849.       </table>

  2850.   </td>

  2851.   <td class="mlabels-right">

  2852. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2853.   </tr>

  2854. </table>

  2855. </div><div class="memdoc">

  2856. <p>Set the current working directory.</p>

  2857. <dl class="params"><dt>Parameters</dt><dd>

  2858.   <table class="params">

  2859.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2860.   </table>

  2861.   </dd>

  2862. </dl>

  2863. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2864. 

  2865. </div>

  2866. </div>

  2867. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2868. <div class="memitem">

  2869. <div class="memproto">

  2870. <table class="mlabels">

  2871.   <tr>

  2872.   <td class="mlabels-left">

  2873.       <table class="memname">

  2874.         <tr>

  2875.           <td class="memname">void FatFile::setpos </td>

  2876.           <td>(</td>

  2877.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2878.           <td class="paramname"><em>pos</em></td><td>)</td>

  2879.           <td></td>

  2880.         </tr>

  2881.       </table>

  2882.   </td>

  2883.   <td class="mlabels-right">

  2884. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2885.   </tr>

  2886. </table>

  2887. </div><div class="memdoc">

  2888. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2889.   <table class="params">

  2890.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2891.   </table>

  2892.   </dd>

  2893. </dl>

  2894. 

  2895. </div>

  2896. </div>

  2897. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2898. <div class="memitem">

  2899. <div class="memproto">

  2900. <table class="mlabels">

  2901.   <tr>

  2902.   <td class="mlabels-left">

  2903.       <table class="memname">

  2904.         <tr>

  2905.           <td class="memname">bool FatFile::sync </td>

  2906.           <td>(</td>

  2907.           <td class="paramname"></td><td>)</td>

  2908.           <td></td>

  2909.         </tr>

  2910.       </table>

  2911.   </td>

  2912.   <td class="mlabels-right">

  2913. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2914.   </tr>

  2915. </table>

  2916. </div><div class="memdoc">

  2917. <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>

  2918. <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>

  2919. 

  2920. </div>

  2921. </div>

  2922. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2923. <div class="memitem">

  2924. <div class="memproto">

  2925. <table class="mlabels">

  2926.   <tr>

  2927.   <td class="mlabels-left">

  2928.       <table class="memname">

  2929.         <tr>

  2930.           <td class="memname">bool FatFile::timestamp </td>

  2931.           <td>(</td>

  2932.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2933.           <td class="paramname"><em>file</em></td><td>)</td>

  2934.           <td></td>

  2935.         </tr>

  2936.       </table>

  2937.   </td>

  2938.   <td class="mlabels-right">

  2939. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2940.   </tr>

  2941. </table>

  2942. </div><div class="memdoc">

  2943. <p>Copy a file's timestamps</p>

  2944. <dl class="params"><dt>Parameters</dt><dd>

  2945.   <table class="params">

  2946.     <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>

  2947.   </table>

  2948.   </dd>

  2949. </dl>

  2950. <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>

  2951. <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>

  2952. 

  2953. </div>

  2954. </div>

  2955. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2956. <div class="memitem">

  2957. <div class="memproto">

  2958. <table class="mlabels">

  2959.   <tr>

  2960.   <td class="mlabels-left">

  2961.       <table class="memname">

  2962.         <tr>

  2963.           <td class="memname">bool FatFile::timestamp </td>

  2964.           <td>(</td>

  2965.           <td class="paramtype">uint8_t&#160;</td>

  2966.           <td class="paramname"><em>flags</em>, </td>

  2967.         </tr>

  2968.         <tr>

  2969.           <td class="paramkey"></td>

  2970.           <td></td>

  2971.           <td class="paramtype">uint16_t&#160;</td>

  2972.           <td class="paramname"><em>year</em>, </td>

  2973.         </tr>

  2974.         <tr>

  2975.           <td class="paramkey"></td>

  2976.           <td></td>

  2977.           <td class="paramtype">uint8_t&#160;</td>

  2978.           <td class="paramname"><em>month</em>, </td>

  2979.         </tr>

  2980.         <tr>

  2981.           <td class="paramkey"></td>

  2982.           <td></td>

  2983.           <td class="paramtype">uint8_t&#160;</td>

  2984.           <td class="paramname"><em>day</em>, </td>

  2985.         </tr>

  2986.         <tr>

  2987.           <td class="paramkey"></td>

  2988.           <td></td>

  2989.           <td class="paramtype">uint8_t&#160;</td>

  2990.           <td class="paramname"><em>hour</em>, </td>

  2991.         </tr>

  2992.         <tr>

  2993.           <td class="paramkey"></td>

  2994.           <td></td>

  2995.           <td class="paramtype">uint8_t&#160;</td>

  2996.           <td class="paramname"><em>minute</em>, </td>

  2997.         </tr>

  2998.         <tr>

  2999.           <td class="paramkey"></td>

  3000.           <td></td>

  3001.           <td class="paramtype">uint8_t&#160;</td>

  3002.           <td class="paramname"><em>second</em>&#160;</td>

  3003.         </tr>

  3004.         <tr>

  3005.           <td></td>

  3006.           <td>)</td>

  3007.           <td></td><td></td>

  3008.         </tr>

  3009.       </table>

  3010.   </td>

  3011.   <td class="mlabels-right">

  3012. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3013.   </tr>

  3014. </table>

  3015. </div><div class="memdoc">

  3016. <p>Set a file's timestamps in its directory entry.</p>

  3017. <dl class="params"><dt>Parameters</dt><dd>

  3018.   <table class="params">

  3019.     <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>

  3020.   </table>

  3021.   </dd>

  3022. </dl>

  3023. <p>T_ACCESS - Set the file's last access date.</p>

  3024. <p>T_CREATE - Set the file's creation date and time.</p>

  3025. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3026. <dl class="params"><dt>Parameters</dt><dd>

  3027.   <table class="params">

  3028.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3029.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3030.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3031.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3032.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3033.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3034.   </table>

  3035.   </dd>

  3036. </dl>

  3037. <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>

  3038. <dd>

  3039. 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>

  3040. <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>

  3041. 

  3042. </div>

  3043. </div>

  3044. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3045. <div class="memitem">

  3046. <div class="memproto">

  3047. <table class="mlabels">

  3048.   <tr>

  3049.   <td class="mlabels-left">

  3050.       <table class="memname">

  3051.         <tr>

  3052.           <td class="memname">bool FatFile::truncate </td>

  3053.           <td>(</td>

  3054.           <td class="paramtype">uint32_t&#160;</td>

  3055.           <td class="paramname"><em>length</em></td><td>)</td>

  3056.           <td></td>

  3057.         </tr>

  3058.       </table>

  3059.   </td>

  3060.   <td class="mlabels-right">

  3061. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3062.   </tr>

  3063. </table>

  3064. </div><div class="memdoc">

  3065. <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>

  3066. <dl class="params"><dt>Parameters</dt><dd>

  3067.   <table class="params">

  3068.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3069.   </table>

  3070.   </dd>

  3071. </dl>

  3072. <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>

  3073. 

  3074. </div>

  3075. </div>

  3076. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3077. <div class="memitem">

  3078. <div class="memproto">

  3079. <table class="mlabels">

  3080.   <tr>

  3081.   <td class="mlabels-left">

  3082.       <table class="memname">

  3083.         <tr>

  3084.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3085.           <td>(</td>

  3086.           <td class="paramname"></td><td>)</td>

  3087.           <td> const</td>

  3088.         </tr>

  3089.       </table>

  3090.   </td>

  3091.   <td class="mlabels-right">

  3092. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3093.   </tr>

  3094. </table>

  3095. </div><div class="memdoc">

  3096. <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>

  3097. 

  3098. </div>

  3099. </div>

  3100. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3101. <div class="memitem">

  3102. <div class="memproto">

  3103. <table class="mlabels">

  3104.   <tr>

  3105.   <td class="mlabels-left">

  3106.       <table class="memname">

  3107.         <tr>

  3108.           <td class="memname">int FatFile::write </td>

  3109.           <td>(</td>

  3110.           <td class="paramtype">const char *&#160;</td>

  3111.           <td class="paramname"><em>str</em></td><td>)</td>

  3112.           <td></td>

  3113.         </tr>

  3114.       </table>

  3115.   </td>

  3116.   <td class="mlabels-right">

  3117. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3118.   </tr>

  3119. </table>

  3120. </div><div class="memdoc">

  3121. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3122.   <table class="params">

  3123.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3124.   </table>

  3125.   </dd>

  3126. </dl>

  3127. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3128. 

  3129. </div>

  3130. </div>

  3131. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  3132. <div class="memitem">

  3133. <div class="memproto">

  3134. <table class="mlabels">

  3135.   <tr>

  3136.   <td class="mlabels-left">

  3137.       <table class="memname">

  3138.         <tr>

  3139.           <td class="memname">int FatFile::write </td>

  3140.           <td>(</td>

  3141.           <td class="paramtype">uint8_t&#160;</td>

  3142.           <td class="paramname"><em>b</em></td><td>)</td>

  3143.           <td></td>

  3144.         </tr>

  3145.       </table>

  3146.   </td>

  3147.   <td class="mlabels-right">

  3148. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3149.   </tr>

  3150. </table>

  3151. </div><div class="memdoc">

  3152. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  3153.   <table class="params">

  3154.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  3155.   </table>

  3156.   </dd>

  3157. </dl>

  3158. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  3159. 

  3160. </div>

  3161. </div>

  3162. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3163. <div class="memitem">

  3164. <div class="memproto">

  3165. <table class="mlabels">

  3166.   <tr>

  3167.   <td class="mlabels-left">

  3168.       <table class="memname">

  3169.         <tr>

  3170.           <td class="memname">int FatFile::write </td>

  3171.           <td>(</td>

  3172.           <td class="paramtype">const void *&#160;</td>

  3173.           <td class="paramname"><em>buf</em>, </td>

  3174.         </tr>

  3175.         <tr>

  3176.           <td class="paramkey"></td>

  3177.           <td></td>

  3178.           <td class="paramtype">size_t&#160;</td>

  3179.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3180.         </tr>

  3181.         <tr>

  3182.           <td></td>

  3183.           <td>)</td>

  3184.           <td></td><td></td>

  3185.         </tr>

  3186.       </table>

  3187.   </td>

  3188.   <td class="mlabels-right">

  3189. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3190.   </tr>

  3191. </table>

  3192. </div><div class="memdoc">

  3193. <p>Write data to an open file.</p>

  3194. <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>

  3195. <dl class="params"><dt>Parameters</dt><dd>

  3196.   <table class="params">

  3197.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3198.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3199.   </table>

  3200.   </dd>

  3201. </dl>

  3202. <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>

  3203. 

  3204. </div>

  3205. </div>

  3206. <hr/>The documentation for this class was generated from the following file:<ul>

  3207. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  3208. </ul>

  3209. </div><!-- contents -->

  3210. <!-- start footer part -->

  3211. <hr class="footer"/><address class="footer"><small>

  3212. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3213. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3214. </a> 1.8.10

  3215. </small></address>

  3216. </body>

  3217. </html>