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.
16 İşlemeler
1 Dal
Ağaç: cb56364787
Dallar Biçim İmleri
${ item.name }
Branş ${ searchTerm } oluştur
'cb56364787'den
${ noResults }
teensy-sdfat/html/class_sd_base_file.html

3216 satır
143KB
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.8"/>

  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/search.js"></script>

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  74. 

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

  76. <div id="MSearchResultsWindow">

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

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

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Class for backward compatibility.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for SdBaseFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_fat_file.html" title="Basic file class. " alt="" coords="18,5,80,32"/>
</map>

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

  104. <div class="dynheader">

  105. Collaboration diagram for SdBaseFile:</div>

  106. <div class="dyncontent">

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

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

  109. <area shape="rect" id="node2" href="class_fat_file.html" title="Basic file class. " alt="" coords="18,5,80,32"/>
</map>

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

  111. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  289. </table>

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

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

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

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

  294. <div class="memitem">

  295. <div class="memproto">

  296. <table class="mlabels">

  297.   <tr>

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

  299.       <table class="memname">

  300.         <tr>

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

  302.           <td>(</td>

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

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

  305.         </tr>

  306.         <tr>

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

  308.           <td></td>

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

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

  311.         </tr>

  312.         <tr>

  313.           <td></td>

  314.           <td>)</td>

  315.           <td></td><td></td>

  316.         </tr>

  317.       </table>

  318.   </td>

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

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

  321.   </tr>

  322. </table>

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

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

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

  326.   <table class="params">

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

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

  329.   </table>

  330.   </dd>

  331. </dl>

  332. 

  333. </div>

  334. </div>

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

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

  337. <div class="memitem">

  338. <div class="memproto">

  339. <table class="mlabels">

  340.   <tr>

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

  342.       <table class="memname">

  343.         <tr>

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

  345.           <td>(</td>

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

  347.           <td></td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

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

  357. 

  358. </div>

  359. </div>

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

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

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

  369.           <td>(</td>

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

  371.           <td></td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

  381. 

  382. </div>

  383. </div>

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

  385. <div class="memitem">

  386. <div class="memproto">

  387. <table class="mlabels">

  388.   <tr>

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

  390.       <table class="memname">

  391.         <tr>

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

  393.           <td>(</td>

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

  395.           <td></td>

  396.         </tr>

  397.       </table>

  398.   </td>

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

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

  401.   </tr>

  402. </table>

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

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

  405. 

  406. </div>

  407. </div>

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

  409. <div class="memitem">

  410. <div class="memproto">

  411. <table class="mlabels">

  412.   <tr>

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

  414.       <table class="memname">

  415.         <tr>

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

  417.           <td>(</td>

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

  419.           <td></td>

  420.         </tr>

  421.       </table>

  422.   </td>

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

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

  425.   </tr>

  426. </table>

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

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

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

  430. 

  431. </div>

  432. </div>

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

  434. <div class="memitem">

  435. <div class="memproto">

  436. <table class="mlabels">

  437.   <tr>

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

  439.       <table class="memname">

  440.         <tr>

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

  442.           <td>(</td>

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

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

  445.         </tr>

  446.         <tr>

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

  448.           <td></td>

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

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

  451.         </tr>

  452.         <tr>

  453.           <td></td>

  454.           <td>)</td>

  455.           <td></td><td></td>

  456.         </tr>

  457.       </table>

  458.   </td>

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

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

  461.   </tr>

  462. </table>

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

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

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

  466.   <table class="params">

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

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

  469.   </table>

  470.   </dd>

  471. </dl>

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

  473. 

  474. </div>

  475. </div>

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

  477. <div class="memitem">

  478. <div class="memproto">

  479. <table class="mlabels">

  480.   <tr>

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

  482.       <table class="memname">

  483.         <tr>

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

  485.           <td>(</td>

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

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

  488.         </tr>

  489.         <tr>

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

  491.           <td></td>

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

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

  494.         </tr>

  495.         <tr>

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

  497.           <td></td>

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

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

  500.         </tr>

  501.         <tr>

  502.           <td></td>

  503.           <td>)</td>

  504.           <td></td><td></td>

  505.         </tr>

  506.       </table>

  507.   </td>

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

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

  510.   </tr>

  511. </table>

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

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

  514. <dl class="section note"><dt>Note</dt><dd>This function only supports short DOS 8.3 names. See <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> for more information.</dd></dl>

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

  516.   <table class="params">

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

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

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

  520.   </table>

  521.   </dd>

  522. </dl>

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

  524. 

  525. </div>

  526. </div>

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

  528. <div class="memitem">

  529. <div class="memproto">

  530. <table class="mlabels">

  531.   <tr>

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

  533.       <table class="memname">

  534.         <tr>

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

  536.           <td>(</td>

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

  538.           <td> const</td>

  539.         </tr>

  540.       </table>

  541.   </td>

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

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

  544.   </tr>

  545. </table>

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

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

  548. 

  549. </div>

  550. </div>

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

  552. <div class="memitem">

  553. <div class="memproto">

  554. <table class="mlabels">

  555.   <tr>

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

  557.       <table class="memname">

  558.         <tr>

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

  560.           <td>(</td>

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

  562.           <td> const</td>

  563.         </tr>

  564.       </table>

  565.   </td>

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

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

  568.   </tr>

  569. </table>

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

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

  572. 

  573. </div>

  574. </div>

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

  576. <div class="memitem">

  577. <div class="memproto">

  578. <table class="mlabels">

  579.   <tr>

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

  581.       <table class="memname">

  582.         <tr>

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

  584.           <td>(</td>

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

  586.           <td></td>

  587.         </tr>

  588.       </table>

  589.   </td>

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

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

  592.   </tr>

  593. </table>

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

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

  596. 

  597. </div>

  598. </div>

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

  600. <div class="memitem">

  601. <div class="memproto">

  602. <table class="mlabels">

  603.   <tr>

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

  605.       <table class="memname">

  606.         <tr>

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

  608.           <td>(</td>

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

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

  611.           <td></td>

  612.         </tr>

  613.       </table>

  614.   </td>

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

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

  617.   </tr>

  618. </table>

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

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

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

  622.   <table class="params">

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

  624.   </table>

  625.   </dd>

  626. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  641. 

  642. </div>

  643. </div>

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

  645. <div class="memitem">

  646. <div class="memproto">

  647. <table class="mlabels">

  648.   <tr>

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

  650.       <table class="memname">

  651.         <tr>

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

  653.           <td>(</td>

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

  655.           <td></td>

  656.         </tr>

  657.       </table>

  658.   </td>

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

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

  661.   </tr>

  662. </table>

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

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

  665. 

  666. </div>

  667. </div>

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

  669. <div class="memitem">

  670. <div class="memproto">

  671. <table class="mlabels">

  672.   <tr>

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

  674.       <table class="memname">

  675.         <tr>

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

  677.           <td>(</td>

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

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

  680.           <td></td>

  681.         </tr>

  682.       </table>

  683.   </td>

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

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

  686.   </tr>

  687. </table>

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

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

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

  691.   <table class="params">

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

  693.   </table>

  694.   </dd>

  695. </dl>

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

  697. 

  698. </div>

  699. </div>

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

  701. <div class="memitem">

  702. <div class="memproto">

  703. <table class="mlabels">

  704.   <tr>

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

  706.       <table class="memname">

  707.         <tr>

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

  709.           <td>(</td>

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

  711.           <td></td>

  712.         </tr>

  713.       </table>

  714.   </td>

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

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

  717.   </tr>

  718. </table>

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

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

  721. 

  722. </div>

  723. </div>

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

  725. <div class="memitem">

  726. <div class="memproto">

  727. <table class="mlabels">

  728.   <tr>

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

  730.       <table class="memname">

  731.         <tr>

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

  733.           <td>(</td>

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

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

  736.         </tr>

  737.         <tr>

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

  739.           <td></td>

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

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

  742.         </tr>

  743.         <tr>

  744.           <td></td>

  745.           <td>)</td>

  746.           <td></td><td></td>

  747.         </tr>

  748.       </table>

  749.   </td>

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

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

  752.   </tr>

  753. </table>

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

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

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

  757.   <table class="params">

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

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

  760.   </table>

  761.   </dd>

  762. </dl>

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

  764. 

  765. </div>

  766. </div>

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

  768. <div class="memitem">

  769. <div class="memproto">

  770. <table class="mlabels">

  771.   <tr>

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

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

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

  778.           <td></td>

  779.         </tr>

  780.       </table>

  781.   </td>

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

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

  784.   </tr>

  785. </table>

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

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

  788. 

  789. </div>

  790. </div>

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

  792. <div class="memitem">

  793. <div class="memproto">

  794. <table class="mlabels">

  795.   <tr>

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

  797.       <table class="memname">

  798.         <tr>

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

  800.           <td>(</td>

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

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

  803.         </tr>

  804.         <tr>

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

  806.           <td></td>

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

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

  809.         </tr>

  810.         <tr>

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

  812.           <td></td>

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

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

  815.         </tr>

  816.         <tr>

  817.           <td></td>

  818.           <td>)</td>

  819.           <td></td><td></td>

  820.         </tr>

  821.       </table>

  822.   </td>

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

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

  825.   </tr>

  826. </table>

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

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

  829.   <table class="params">

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

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

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

  833.   </table>

  834.   </dd>

  835. </dl>

  836. 

  837. </div>

  838. </div>

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

  840. <div class="memitem">

  841. <div class="memproto">

  842. <table class="mlabels">

  843.   <tr>

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

  845.       <table class="memname">

  846.         <tr>

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

  848.           <td>(</td>

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

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

  851.           <td></td>

  852.         </tr>

  853.       </table>

  854.   </td>

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

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

  857.   </tr>

  858. </table>

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

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

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

  862.   <table class="params">

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

  864.   </table>

  865.   </dd>

  866. </dl>

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

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

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

  870. 

  871. </div>

  872. </div>

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

  874. <div class="memitem">

  875. <div class="memproto">

  876. <table class="mlabels">

  877.   <tr>

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

  879.       <table class="memname">

  880.         <tr>

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

  882.           <td>(</td>

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

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

  885.         </tr>

  886.         <tr>

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

  888.           <td></td>

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

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

  891.         </tr>

  892.         <tr>

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

  894.           <td></td>

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

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

  897.         </tr>

  898.         <tr>

  899.           <td></td>

  900.           <td>)</td>

  901.           <td></td><td></td>

  902.         </tr>

  903.       </table>

  904.   </td>

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

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

  907.   </tr>

  908. </table>

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

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

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

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

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

  914.   <table class="params">

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

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

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

  918.   </table>

  919.   </dd>

  920. </dl>

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

  922. 

  923. </div>

  924. </div>

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

  926. <div class="memitem">

  927. <div class="memproto">

  928. <table class="mlabels">

  929.   <tr>

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

  931.       <table class="memname">

  932.         <tr>

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

  934.           <td>(</td>

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

  936.           <td> const</td>

  937.         </tr>

  938.       </table>

  939.   </td>

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

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

  942.   </tr>

  943. </table>

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

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

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

  947. 

  948. </div>

  949. </div>

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

  951. <div class="memitem">

  952. <div class="memproto">

  953. <table class="mlabels">

  954.   <tr>

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

  956.       <table class="memname">

  957.         <tr>

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

  959.           <td>(</td>

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

  961.           <td> const</td>

  962.         </tr>

  963.       </table>

  964.   </td>

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

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

  967.   </tr>

  968. </table>

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

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

  971. 

  972. </div>

  973. </div>

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

  975. <div class="memitem">

  976. <div class="memproto">

  977. <table class="mlabels">

  978.   <tr>

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

  980.       <table class="memname">

  981.         <tr>

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

  983.           <td>(</td>

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

  985.           <td> const</td>

  986.         </tr>

  987.       </table>

  988.   </td>

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

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

  991.   </tr>

  992. </table>

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

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

  995. 

  996. </div>

  997. </div>

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

  999. <div class="memitem">

  1000. <div class="memproto">

  1001. <table class="mlabels">

  1002.   <tr>

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

  1004.       <table class="memname">

  1005.         <tr>

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

  1007.           <td>(</td>

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

  1009.           <td></td>

  1010.         </tr>

  1011.       </table>

  1012.   </td>

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

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

  1015.   </tr>

  1016. </table>

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

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

  1019. 

  1020. </div>

  1021. </div>

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

  1023. <div class="memitem">

  1024. <div class="memproto">

  1025. <table class="mlabels">

  1026.   <tr>

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

  1028.       <table class="memname">

  1029.         <tr>

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

  1031.           <td>(</td>

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

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

  1034.         </tr>

  1035.         <tr>

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

  1037.           <td></td>

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

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

  1040.         </tr>

  1041.         <tr>

  1042.           <td></td>

  1043.           <td>)</td>

  1044.           <td></td><td></td>

  1045.         </tr>

  1046.       </table>

  1047.   </td>

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

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

  1050.   </tr>

  1051. </table>

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

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

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

  1055.   <table class="params">

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

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

  1058.   </table>

  1059.   </dd>

  1060. </dl>

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

  1062. 

  1063. </div>

  1064. </div>

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

  1066. <div class="memitem">

  1067. <div class="memproto">

  1068. <table class="mlabels">

  1069.   <tr>

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

  1071.       <table class="memname">

  1072.         <tr>

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

  1074.           <td>(</td>

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

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

  1077.           <td></td>

  1078.         </tr>

  1079.       </table>

  1080.   </td>

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

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

  1083.   </tr>

  1084. </table>

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

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

  1087.   <table class="params">

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

  1089.   </table>

  1090.   </dd>

  1091. </dl>

  1092. 

  1093. </div>

  1094. </div>

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

  1096. <div class="memitem">

  1097. <div class="memproto">

  1098. <table class="mlabels">

  1099.   <tr>

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

  1101.       <table class="memname">

  1102.         <tr>

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

  1104.           <td>(</td>

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

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

  1107.           <td></td>

  1108.         </tr>

  1109.       </table>

  1110.   </td>

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

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

  1113.   </tr>

  1114. </table>

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

  1116. <p>Get 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>

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

  1118.   <table class="params">

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

  1120.   </table>

  1121.   </dd>

  1122. </dl>

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

  1124. 

  1125. </div>

  1126. </div>

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

  1128. <div class="memitem">

  1129. <div class="memproto">

  1130. <table class="mlabels">

  1131.   <tr>

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

  1133.       <table class="memname">

  1134.         <tr>

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

  1136.           <td>(</td>

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

  1138.           <td></td>

  1139.         </tr>

  1140.       </table>

  1141.   </td>

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

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

  1144.   </tr>

  1145. </table>

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

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

  1148. 

  1149. </div>

  1150. </div>

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

  1152. <div class="memitem">

  1153. <div class="memproto">

  1154. <table class="mlabels">

  1155.   <tr>

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

  1157.       <table class="memname">

  1158.         <tr>

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

  1160.           <td>(</td>

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

  1162.           <td> const</td>

  1163.         </tr>

  1164.       </table>

  1165.   </td>

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

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

  1168.   </tr>

  1169. </table>

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

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

  1172. 

  1173. </div>

  1174. </div>

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

  1176. <div class="memitem">

  1177. <div class="memproto">

  1178. <table class="mlabels">

  1179.   <tr>

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

  1181.       <table class="memname">

  1182.         <tr>

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

  1184.           <td>(</td>

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

  1186.           <td> const</td>

  1187.         </tr>

  1188.       </table>

  1189.   </td>

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

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

  1192.   </tr>

  1193. </table>

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

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

  1196. 

  1197. </div>

  1198. </div>

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

  1200. <div class="memitem">

  1201. <div class="memproto">

  1202. <table class="mlabels">

  1203.   <tr>

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

  1205.       <table class="memname">

  1206.         <tr>

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

  1208.           <td>(</td>

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

  1210.           <td> const</td>

  1211.         </tr>

  1212.       </table>

  1213.   </td>

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

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

  1216.   </tr>

  1217. </table>

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

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

  1220. 

  1221. </div>

  1222. </div>

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

  1224. <div class="memitem">

  1225. <div class="memproto">

  1226. <table class="mlabels">

  1227.   <tr>

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

  1229.       <table class="memname">

  1230.         <tr>

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

  1232.           <td>(</td>

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

  1234.           <td> const</td>

  1235.         </tr>

  1236.       </table>

  1237.   </td>

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

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

  1240.   </tr>

  1241. </table>

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

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

  1244. 

  1245. </div>

  1246. </div>

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

  1248. <div class="memitem">

  1249. <div class="memproto">

  1250. <table class="mlabels">

  1251.   <tr>

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

  1253.       <table class="memname">

  1254.         <tr>

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

  1256.           <td>(</td>

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

  1258.           <td> const</td>

  1259.         </tr>

  1260.       </table>

  1261.   </td>

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

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

  1264.   </tr>

  1265. </table>

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

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

  1268. 

  1269. </div>

  1270. </div>

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

  1272. <div class="memitem">

  1273. <div class="memproto">

  1274. <table class="mlabels">

  1275.   <tr>

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

  1277.       <table class="memname">

  1278.         <tr>

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

  1280.           <td>(</td>

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

  1282.           <td> const</td>

  1283.         </tr>

  1284.       </table>

  1285.   </td>

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

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

  1288.   </tr>

  1289. </table>

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

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

  1292. 

  1293. </div>

  1294. </div>

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

  1296. <div class="memitem">

  1297. <div class="memproto">

  1298. <table class="mlabels">

  1299.   <tr>

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

  1301.       <table class="memname">

  1302.         <tr>

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

  1304.           <td>(</td>

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

  1306.           <td> const</td>

  1307.         </tr>

  1308.       </table>

  1309.   </td>

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

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

  1312.   </tr>

  1313. </table>

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

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

  1316. 

  1317. </div>

  1318. </div>

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

  1320. <div class="memitem">

  1321. <div class="memproto">

  1322. <table class="mlabels">

  1323.   <tr>

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

  1325.       <table class="memname">

  1326.         <tr>

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

  1328.           <td>(</td>

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

  1330.           <td> const</td>

  1331.         </tr>

  1332.       </table>

  1333.   </td>

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

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

  1336.   </tr>

  1337. </table>

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

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

  1340. 

  1341. </div>

  1342. </div>

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

  1344. <div class="memitem">

  1345. <div class="memproto">

  1346. <table class="mlabels">

  1347.   <tr>

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

  1349.       <table class="memname">

  1350.         <tr>

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

  1352.           <td>(</td>

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

  1354.           <td> const</td>

  1355.         </tr>

  1356.       </table>

  1357.   </td>

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

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

  1360.   </tr>

  1361. </table>

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

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

  1364. 

  1365. </div>

  1366. </div>

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

  1368. <div class="memitem">

  1369. <div class="memproto">

  1370. <table class="mlabels">

  1371.   <tr>

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

  1373.       <table class="memname">

  1374.         <tr>

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

  1376.           <td>(</td>

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

  1378.           <td> const</td>

  1379.         </tr>

  1380.       </table>

  1381.   </td>

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

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

  1384.   </tr>

  1385. </table>

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

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

  1388. 

  1389. </div>

  1390. </div>

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

  1392. <div class="memitem">

  1393. <div class="memproto">

  1394. <table class="mlabels">

  1395.   <tr>

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

  1397.       <table class="memname">

  1398.         <tr>

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

  1400.           <td>(</td>

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

  1402.           <td> const</td>

  1403.         </tr>

  1404.       </table>

  1405.   </td>

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

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

  1408.   </tr>

  1409. </table>

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

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

  1412. 

  1413. </div>

  1414. </div>

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

  1416. <div class="memitem">

  1417. <div class="memproto">

  1418. <table class="mlabels">

  1419.   <tr>

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

  1421.       <table class="memname">

  1422.         <tr>

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

  1424.           <td>(</td>

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

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

  1427.           <td></td>

  1428.         </tr>

  1429.       </table>

  1430.   </td>

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

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

  1433.   </tr>

  1434. </table>

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

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

  1437.   <table class="params">

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

  1439.   </table>

  1440.   </dd>

  1441. </dl>

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

  1443. 

  1444. </div>

  1445. </div>

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

  1447. <div class="memitem">

  1448. <div class="memproto">

  1449. <table class="mlabels">

  1450.   <tr>

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

  1452.       <table class="memname">

  1453.         <tr>

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

  1455.           <td>(</td>

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

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

  1458.           <td></td>

  1459.         </tr>

  1460.       </table>

  1461.   </td>

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

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

  1464.   </tr>

  1465. </table>

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

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

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

  1469.   <table class="params">

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

  1471.   </table>

  1472.   </dd>

  1473. </dl>

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

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

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

  1477. 

  1478. </div>

  1479. </div>

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

  1481. <div class="memitem">

  1482. <div class="memproto">

  1483. <table class="mlabels">

  1484.   <tr>

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

  1486.       <table class="memname">

  1487.         <tr>

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

  1489.           <td>(</td>

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

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

  1492.         </tr>

  1493.         <tr>

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

  1495.           <td></td>

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

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

  1498.         </tr>

  1499.         <tr>

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

  1501.           <td></td>

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

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

  1504.         </tr>

  1505.         <tr>

  1506.           <td></td>

  1507.           <td>)</td>

  1508.           <td></td><td></td>

  1509.         </tr>

  1510.       </table>

  1511.   </td>

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

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

  1514.   </tr>

  1515. </table>

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

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

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

  1519.   <table class="params">

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

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

  1522.   </table>

  1523.   </dd>

  1524. </dl>

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

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

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

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

  1529.   <table class="params">

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

  1531.   </table>

  1532.   </dd>

  1533. </dl>

  1534. 

  1535. </div>

  1536. </div>

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

  1538. <div class="memitem">

  1539. <div class="memproto">

  1540. <table class="mlabels">

  1541.   <tr>

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

  1543.       <table class="memname">

  1544.         <tr>

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

  1546.           <td>(</td>

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

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

  1549.         </tr>

  1550.         <tr>

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

  1552.           <td></td>

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

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

  1555.         </tr>

  1556.         <tr>

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

  1558.           <td></td>

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

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

  1561.         </tr>

  1562.         <tr>

  1563.           <td></td>

  1564.           <td>)</td>

  1565.           <td></td><td></td>

  1566.         </tr>

  1567.       </table>

  1568.   </td>

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

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

  1571.   </tr>

  1572. </table>

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

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

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

  1576.   <table class="params">

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

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

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

  1580.   </table>

  1581.   </dd>

  1582. </dl>

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

  1584. 

  1585. </div>

  1586. </div>

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

  1588. <div class="memitem">

  1589. <div class="memproto">

  1590. <table class="mlabels">

  1591.   <tr>

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

  1593.       <table class="memname">

  1594.         <tr>

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

  1596.           <td>(</td>

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

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

  1599.         </tr>

  1600.         <tr>

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

  1602.           <td></td>

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

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

  1605.         </tr>

  1606.         <tr>

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

  1608.           <td></td>

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

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

  1611.         </tr>

  1612.         <tr>

  1613.           <td></td>

  1614.           <td>)</td>

  1615.           <td></td><td></td>

  1616.         </tr>

  1617.       </table>

  1618.   </td>

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

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

  1621.   </tr>

  1622. </table>

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

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

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

  1626.   <table class="params">

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

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

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

  1630.   </table>

  1631.   </dd>

  1632. </dl>

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

  1634. 

  1635. </div>

  1636. </div>

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

  1638. <div class="memitem">

  1639. <div class="memproto">

  1640. <table class="mlabels">

  1641.   <tr>

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

  1643.       <table class="memname">

  1644.         <tr>

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

  1646.           <td>(</td>

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

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

  1649.         </tr>

  1650.         <tr>

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

  1652.           <td></td>

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

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

  1655.         </tr>

  1656.         <tr>

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

  1658.           <td></td>

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

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

  1661.         </tr>

  1662.         <tr>

  1663.           <td></td>

  1664.           <td>)</td>

  1665.           <td></td><td></td>

  1666.         </tr>

  1667.       </table>

  1668.   </td>

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

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

  1671.   </tr>

  1672. </table>

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

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

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

  1676.   <table class="params">

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

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

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

  1680.   </table>

  1681.   </dd>

  1682. </dl>

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

  1684. 

  1685. </div>

  1686. </div>

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

  1688. <div class="memitem">

  1689. <div class="memproto">

  1690. <table class="mlabels">

  1691.   <tr>

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

  1693.       <table class="memname">

  1694.         <tr>

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

  1696.           <td>(</td>

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

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

  1699.         </tr>

  1700.         <tr>

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

  1702.           <td></td>

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

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

  1705.         </tr>

  1706.         <tr>

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

  1708.           <td></td>

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

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

  1711.         </tr>

  1712.         <tr>

  1713.           <td></td>

  1714.           <td>)</td>

  1715.           <td></td><td></td>

  1716.         </tr>

  1717.       </table>

  1718.   </td>

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

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

  1721.   </tr>

  1722. </table>

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

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

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

  1726.   <table class="params">

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

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

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

  1730.   </table>

  1731.   </dd>

  1732. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1747. 

  1748. </div>

  1749. </div>

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

  1751. <div class="memitem">

  1752. <div class="memproto">

  1753. <table class="mlabels">

  1754.   <tr>

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

  1756.       <table class="memname">

  1757.         <tr>

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

  1759.           <td>(</td>

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

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

  1762.         </tr>

  1763.         <tr>

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

  1765.           <td></td>

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

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

  1768.         </tr>

  1769.         <tr>

  1770.           <td></td>

  1771.           <td>)</td>

  1772.           <td></td><td></td>

  1773.         </tr>

  1774.       </table>

  1775.   </td>

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

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

  1778.   </tr>

  1779. </table>

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

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

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

  1783.   <table class="params">

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

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

  1786.   </table>

  1787.   </dd>

  1788. </dl>

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

  1790. 

  1791. </div>

  1792. </div>

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

  1794. <div class="memitem">

  1795. <div class="memproto">

  1796. <table class="mlabels">

  1797.   <tr>

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

  1799.       <table class="memname">

  1800.         <tr>

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

  1802.           <td>(</td>

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

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

  1805.         </tr>

  1806.         <tr>

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

  1808.           <td></td>

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

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

  1811.         </tr>

  1812.         <tr>

  1813.           <td></td>

  1814.           <td>)</td>

  1815.           <td></td><td></td>

  1816.         </tr>

  1817.       </table>

  1818.   </td>

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

  1820. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1821.   </tr>

  1822. </table>

  1823. </div><div class="memdoc">

  1824. <p>Open the next file or subdirectory in a directory.</p>

  1825. <dl class="params"><dt>Parameters</dt><dd>

  1826.   <table class="params">

  1827.     <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>

  1828.     <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>

  1829.   </table>

  1830.   </dd>

  1831. </dl>

  1832. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1833. 

  1834. </div>

  1835. </div>

  1836. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1837. <div class="memitem">

  1838. <div class="memproto">

  1839. <table class="mlabels">

  1840.   <tr>

  1841.   <td class="mlabels-left">

  1842.       <table class="memname">

  1843.         <tr>

  1844.           <td class="memname">bool FatFile::openRoot </td>

  1845.           <td>(</td>

  1846.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1847.           <td class="paramname"><em>vol</em></td><td>)</td>

  1848.           <td></td>

  1849.         </tr>

  1850.       </table>

  1851.   </td>

  1852.   <td class="mlabels-right">

  1853. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1854.   </tr>

  1855. </table>

  1856. </div><div class="memdoc">

  1857. <p>Open a volume's root directory.</p>

  1858. <dl class="params"><dt>Parameters</dt><dd>

  1859.   <table class="params">

  1860.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1861.   </table>

  1862.   </dd>

  1863. </dl>

  1864. <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>

  1865. 

  1866. </div>

  1867. </div>

  1868. <a class="anchor" id="ac05b7136b887539426856c623869aa3a"></a>

  1869. <div class="memitem">

  1870. <div class="memproto">

  1871. <table class="mlabels">

  1872.   <tr>

  1873.   <td class="mlabels-left">

  1874.       <table class="memname">

  1875.         <tr>

  1876.           <td class="memname">int FatFile::peek </td>

  1877.           <td>(</td>

  1878.           <td class="paramname"></td><td>)</td>

  1879.           <td></td>

  1880.         </tr>

  1881.       </table>

  1882.   </td>

  1883.   <td class="mlabels-right">

  1884. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1885.   </tr>

  1886. </table>

  1887. </div><div class="memdoc">

  1888. <p>Return the next available byte without consuming it.</p>

  1889. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1890. 

  1891. </div>

  1892. </div>

  1893. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1894. <div class="memitem">

  1895. <div class="memproto">

  1896. <table class="mlabels">

  1897.   <tr>

  1898.   <td class="mlabels-left">

  1899.       <table class="memname">

  1900.         <tr>

  1901.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1902.           <td>(</td>

  1903.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1904.           <td class="paramname"><em>pr</em></td><td>)</td>

  1905.           <td></td>

  1906.         </tr>

  1907.       </table>

  1908.   </td>

  1909.   <td class="mlabels-right">

  1910. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1911.   </tr>

  1912. </table>

  1913. </div><div class="memdoc">

  1914. <p>Print a file's creation date and time</p>

  1915. <dl class="params"><dt>Parameters</dt><dd>

  1916.   <table class="params">

  1917.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1918.   </table>

  1919.   </dd>

  1920. </dl>

  1921. <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>

  1922. 

  1923. </div>

  1924. </div>

  1925. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1926. <div class="memitem">

  1927. <div class="memproto">

  1928. <table class="mlabels">

  1929.   <tr>

  1930.   <td class="mlabels-left">

  1931.       <table class="memname">

  1932.         <tr>

  1933.           <td class="memname">static void FatFile::printFatDate </td>

  1934.           <td>(</td>

  1935.           <td class="paramtype">uint16_t&#160;</td>

  1936.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1937.           <td></td>

  1938.         </tr>

  1939.       </table>

  1940.   </td>

  1941.   <td class="mlabels-right">

  1942. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1943.   </tr>

  1944. </table>

  1945. </div><div class="memdoc">

  1946. <p>Print a directory date field.</p>

  1947. <p>Format is yyyy-mm-dd.</p>

  1948. <dl class="params"><dt>Parameters</dt><dd>

  1949.   <table class="params">

  1950.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1951.   </table>

  1952.   </dd>

  1953. </dl>

  1954. 

  1955. </div>

  1956. </div>

  1957. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1958. <div class="memitem">

  1959. <div class="memproto">

  1960. <table class="mlabels">

  1961.   <tr>

  1962.   <td class="mlabels-left">

  1963.       <table class="memname">

  1964.         <tr>

  1965.           <td class="memname">void FatFile::printFatDate </td>

  1966.           <td>(</td>

  1967.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1968.           <td class="paramname"><em>pr</em>, </td>

  1969.         </tr>

  1970.         <tr>

  1971.           <td class="paramkey"></td>

  1972.           <td></td>

  1973.           <td class="paramtype">uint16_t&#160;</td>

  1974.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1975.         </tr>

  1976.         <tr>

  1977.           <td></td>

  1978.           <td>)</td>

  1979.           <td></td><td></td>

  1980.         </tr>

  1981.       </table>

  1982.   </td>

  1983.   <td class="mlabels-right">

  1984. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1985.   </tr>

  1986. </table>

  1987. </div><div class="memdoc">

  1988. <p>Print a directory date field.</p>

  1989. <p>Format is yyyy-mm-dd.</p>

  1990. <dl class="params"><dt>Parameters</dt><dd>

  1991.   <table class="params">

  1992.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1993.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1994.   </table>

  1995.   </dd>

  1996. </dl>

  1997. 

  1998. </div>

  1999. </div>

  2000. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2001. <div class="memitem">

  2002. <div class="memproto">

  2003. <table class="mlabels">

  2004.   <tr>

  2005.   <td class="mlabels-left">

  2006.       <table class="memname">

  2007.         <tr>

  2008.           <td class="memname">static void FatFile::printFatTime </td>

  2009.           <td>(</td>

  2010.           <td class="paramtype">uint16_t&#160;</td>

  2011.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2012.           <td></td>

  2013.         </tr>

  2014.       </table>

  2015.   </td>

  2016.   <td class="mlabels-right">

  2017. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2018.   </tr>

  2019. </table>

  2020. </div><div class="memdoc">

  2021. <p>Print a directory time field.</p>

  2022. <p>Format is hh:mm:ss.</p>

  2023. <dl class="params"><dt>Parameters</dt><dd>

  2024.   <table class="params">

  2025.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2026.   </table>

  2027.   </dd>

  2028. </dl>

  2029. 

  2030. </div>

  2031. </div>

  2032. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2033. <div class="memitem">

  2034. <div class="memproto">

  2035. <table class="mlabels">

  2036.   <tr>

  2037.   <td class="mlabels-left">

  2038.       <table class="memname">

  2039.         <tr>

  2040.           <td class="memname">void FatFile::printFatTime </td>

  2041.           <td>(</td>

  2042.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2043.           <td class="paramname"><em>pr</em>, </td>

  2044.         </tr>

  2045.         <tr>

  2046.           <td class="paramkey"></td>

  2047.           <td></td>

  2048.           <td class="paramtype">uint16_t&#160;</td>

  2049.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2050.         </tr>

  2051.         <tr>

  2052.           <td></td>

  2053.           <td>)</td>

  2054.           <td></td><td></td>

  2055.         </tr>

  2056.       </table>

  2057.   </td>

  2058.   <td class="mlabels-right">

  2059. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2060.   </tr>

  2061. </table>

  2062. </div><div class="memdoc">

  2063. <p>Print a directory time field.</p>

  2064. <p>Format is hh:mm:ss.</p>

  2065. <dl class="params"><dt>Parameters</dt><dd>

  2066.   <table class="params">

  2067.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2068.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2069.   </table>

  2070.   </dd>

  2071. </dl>

  2072. 

  2073. </div>

  2074. </div>

  2075. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2076. <div class="memitem">

  2077. <div class="memproto">

  2078. <table class="mlabels">

  2079.   <tr>

  2080.   <td class="mlabels-left">

  2081.       <table class="memname">

  2082.         <tr>

  2083.           <td class="memname">int FatFile::printField </td>

  2084.           <td>(</td>

  2085.           <td class="paramtype">float&#160;</td>

  2086.           <td class="paramname"><em>value</em>, </td>

  2087.         </tr>

  2088.         <tr>

  2089.           <td class="paramkey"></td>

  2090.           <td></td>

  2091.           <td class="paramtype">char&#160;</td>

  2092.           <td class="paramname"><em>term</em>, </td>

  2093.         </tr>

  2094.         <tr>

  2095.           <td class="paramkey"></td>

  2096.           <td></td>

  2097.           <td class="paramtype">uint8_t&#160;</td>

  2098.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2099.         </tr>

  2100.         <tr>

  2101.           <td></td>

  2102.           <td>)</td>

  2103.           <td></td><td></td>

  2104.         </tr>

  2105.       </table>

  2106.   </td>

  2107.   <td class="mlabels-right">

  2108. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2109.   </tr>

  2110. </table>

  2111. </div><div class="memdoc">

  2112. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2113.   <table class="params">

  2114.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2115.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2116.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2117.   </table>

  2118.   </dd>

  2119. </dl>

  2120. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2121. 

  2122. </div>

  2123. </div>

  2124. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2125. <div class="memitem">

  2126. <div class="memproto">

  2127. <table class="mlabels">

  2128.   <tr>

  2129.   <td class="mlabels-left">

  2130.       <table class="memname">

  2131.         <tr>

  2132.           <td class="memname">int FatFile::printField </td>

  2133.           <td>(</td>

  2134.           <td class="paramtype">int16_t&#160;</td>

  2135.           <td class="paramname"><em>value</em>, </td>

  2136.         </tr>

  2137.         <tr>

  2138.           <td class="paramkey"></td>

  2139.           <td></td>

  2140.           <td class="paramtype">char&#160;</td>

  2141.           <td class="paramname"><em>term</em>&#160;</td>

  2142.         </tr>

  2143.         <tr>

  2144.           <td></td>

  2145.           <td>)</td>

  2146.           <td></td><td></td>

  2147.         </tr>

  2148.       </table>

  2149.   </td>

  2150.   <td class="mlabels-right">

  2151. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2152.   </tr>

  2153. </table>

  2154. </div><div class="memdoc">

  2155. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2156.   <table class="params">

  2157.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2158.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2159.   </table>

  2160.   </dd>

  2161. </dl>

  2162. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2163. 

  2164. </div>

  2165. </div>

  2166. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2167. <div class="memitem">

  2168. <div class="memproto">

  2169. <table class="mlabels">

  2170.   <tr>

  2171.   <td class="mlabels-left">

  2172.       <table class="memname">

  2173.         <tr>

  2174.           <td class="memname">int FatFile::printField </td>

  2175.           <td>(</td>

  2176.           <td class="paramtype">uint16_t&#160;</td>

  2177.           <td class="paramname"><em>value</em>, </td>

  2178.         </tr>

  2179.         <tr>

  2180.           <td class="paramkey"></td>

  2181.           <td></td>

  2182.           <td class="paramtype">char&#160;</td>

  2183.           <td class="paramname"><em>term</em>&#160;</td>

  2184.         </tr>

  2185.         <tr>

  2186.           <td></td>

  2187.           <td>)</td>

  2188.           <td></td><td></td>

  2189.         </tr>

  2190.       </table>

  2191.   </td>

  2192.   <td class="mlabels-right">

  2193. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2194.   </tr>

  2195. </table>

  2196. </div><div class="memdoc">

  2197. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2198.   <table class="params">

  2199.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2200.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2201.   </table>

  2202.   </dd>

  2203. </dl>

  2204. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2205. 

  2206. </div>

  2207. </div>

  2208. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2209. <div class="memitem">

  2210. <div class="memproto">

  2211. <table class="mlabels">

  2212.   <tr>

  2213.   <td class="mlabels-left">

  2214.       <table class="memname">

  2215.         <tr>

  2216.           <td class="memname">int FatFile::printField </td>

  2217.           <td>(</td>

  2218.           <td class="paramtype">int32_t&#160;</td>

  2219.           <td class="paramname"><em>value</em>, </td>

  2220.         </tr>

  2221.         <tr>

  2222.           <td class="paramkey"></td>

  2223.           <td></td>

  2224.           <td class="paramtype">char&#160;</td>

  2225.           <td class="paramname"><em>term</em>&#160;</td>

  2226.         </tr>

  2227.         <tr>

  2228.           <td></td>

  2229.           <td>)</td>

  2230.           <td></td><td></td>

  2231.         </tr>

  2232.       </table>

  2233.   </td>

  2234.   <td class="mlabels-right">

  2235. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2236.   </tr>

  2237. </table>

  2238. </div><div class="memdoc">

  2239. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2240.   <table class="params">

  2241.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2242.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2243.   </table>

  2244.   </dd>

  2245. </dl>

  2246. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2247. 

  2248. </div>

  2249. </div>

  2250. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2251. <div class="memitem">

  2252. <div class="memproto">

  2253. <table class="mlabels">

  2254.   <tr>

  2255.   <td class="mlabels-left">

  2256.       <table class="memname">

  2257.         <tr>

  2258.           <td class="memname">int FatFile::printField </td>

  2259.           <td>(</td>

  2260.           <td class="paramtype">uint32_t&#160;</td>

  2261.           <td class="paramname"><em>value</em>, </td>

  2262.         </tr>

  2263.         <tr>

  2264.           <td class="paramkey"></td>

  2265.           <td></td>

  2266.           <td class="paramtype">char&#160;</td>

  2267.           <td class="paramname"><em>term</em>&#160;</td>

  2268.         </tr>

  2269.         <tr>

  2270.           <td></td>

  2271.           <td>)</td>

  2272.           <td></td><td></td>

  2273.         </tr>

  2274.       </table>

  2275.   </td>

  2276.   <td class="mlabels-right">

  2277. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2278.   </tr>

  2279. </table>

  2280. </div><div class="memdoc">

  2281. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2282.   <table class="params">

  2283.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2284.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2285.   </table>

  2286.   </dd>

  2287. </dl>

  2288. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2289. 

  2290. </div>

  2291. </div>

  2292. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2293. <div class="memitem">

  2294. <div class="memproto">

  2295. <table class="mlabels">

  2296.   <tr>

  2297.   <td class="mlabels-left">

  2298.       <table class="memname">

  2299.         <tr>

  2300.           <td class="memname">size_t FatFile::printFileSize </td>

  2301.           <td>(</td>

  2302.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2303.           <td class="paramname"><em>pr</em></td><td>)</td>

  2304.           <td></td>

  2305.         </tr>

  2306.       </table>

  2307.   </td>

  2308.   <td class="mlabels-right">

  2309. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2310.   </tr>

  2311. </table>

  2312. </div><div class="memdoc">

  2313. <p>Print a file's size.</p>

  2314. <dl class="params"><dt>Parameters</dt><dd>

  2315.   <table class="params">

  2316.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2317.   </table>

  2318.   </dd>

  2319. </dl>

  2320. <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>

  2321. 

  2322. </div>

  2323. </div>

  2324. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2325. <div class="memitem">

  2326. <div class="memproto">

  2327. <table class="mlabels">

  2328.   <tr>

  2329.   <td class="mlabels-left">

  2330.       <table class="memname">

  2331.         <tr>

  2332.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2333.           <td>(</td>

  2334.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2335.           <td class="paramname"><em>pr</em></td><td>)</td>

  2336.           <td></td>

  2337.         </tr>

  2338.       </table>

  2339.   </td>

  2340.   <td class="mlabels-right">

  2341. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2342.   </tr>

  2343. </table>

  2344. </div><div class="memdoc">

  2345. <p>Print a file's modify date and time</p>

  2346. <dl class="params"><dt>Parameters</dt><dd>

  2347.   <table class="params">

  2348.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2349.   </table>

  2350.   </dd>

  2351. </dl>

  2352. <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>

  2353. 

  2354. </div>

  2355. </div>

  2356. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2357. <div class="memitem">

  2358. <div class="memproto">

  2359. <table class="mlabels">

  2360.   <tr>

  2361.   <td class="mlabels-left">

  2362.       <table class="memname">

  2363.         <tr>

  2364.           <td class="memname">size_t FatFile::printName </td>

  2365.           <td>(</td>

  2366.           <td class="paramname"></td><td>)</td>

  2367.           <td></td>

  2368.         </tr>

  2369.       </table>

  2370.   </td>

  2371.   <td class="mlabels-right">

  2372. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2373.   </tr>

  2374. </table>

  2375. </div><div class="memdoc">

  2376. <p>Print a file's name.</p>

  2377. <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>

  2378. 

  2379. </div>

  2380. </div>

  2381. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2382. <div class="memitem">

  2383. <div class="memproto">

  2384. <table class="mlabels">

  2385.   <tr>

  2386.   <td class="mlabels-left">

  2387.       <table class="memname">

  2388.         <tr>

  2389.           <td class="memname">size_t FatFile::printName </td>

  2390.           <td>(</td>

  2391.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2392.           <td class="paramname"><em>pr</em></td><td>)</td>

  2393.           <td></td>

  2394.         </tr>

  2395.       </table>

  2396.   </td>

  2397.   <td class="mlabels-right">

  2398. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2399.   </tr>

  2400. </table>

  2401. </div><div class="memdoc">

  2402. <p>Print a file's name</p>

  2403. <dl class="params"><dt>Parameters</dt><dd>

  2404.   <table class="params">

  2405.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2406.   </table>

  2407.   </dd>

  2408. </dl>

  2409. <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>

  2410. 

  2411. </div>

  2412. </div>

  2413. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2414. <div class="memitem">

  2415. <div class="memproto">

  2416. <table class="mlabels">

  2417.   <tr>

  2418.   <td class="mlabels-left">

  2419.       <table class="memname">

  2420.         <tr>

  2421.           <td class="memname">size_t FatFile::printSFN </td>

  2422.           <td>(</td>

  2423.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2424.           <td class="paramname"><em>pr</em></td><td>)</td>

  2425.           <td></td>

  2426.         </tr>

  2427.       </table>

  2428.   </td>

  2429.   <td class="mlabels-right">

  2430. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2431.   </tr>

  2432. </table>

  2433. </div><div class="memdoc">

  2434. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2435. <dl class="params"><dt>Parameters</dt><dd>

  2436.   <table class="params">

  2437.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2438.   </table>

  2439.   </dd>

  2440. </dl>

  2441. <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>

  2442. 

  2443. </div>

  2444. </div>

  2445. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2446. <div class="memitem">

  2447. <div class="memproto">

  2448. <table class="mlabels">

  2449.   <tr>

  2450.   <td class="mlabels-left">

  2451.       <table class="memname">

  2452.         <tr>

  2453.           <td class="memname">int FatFile::read </td>

  2454.           <td>(</td>

  2455.           <td class="paramname"></td><td>)</td>

  2456.           <td></td>

  2457.         </tr>

  2458.       </table>

  2459.   </td>

  2460.   <td class="mlabels-right">

  2461. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2462.   </tr>

  2463. </table>

  2464. </div><div class="memdoc">

  2465. <p>Read the next byte from a file.</p>

  2466. <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>

  2467. 

  2468. </div>

  2469. </div>

  2470. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2471. <div class="memitem">

  2472. <div class="memproto">

  2473. <table class="mlabels">

  2474.   <tr>

  2475.   <td class="mlabels-left">

  2476.       <table class="memname">

  2477.         <tr>

  2478.           <td class="memname">int FatFile::read </td>

  2479.           <td>(</td>

  2480.           <td class="paramtype">void *&#160;</td>

  2481.           <td class="paramname"><em>buf</em>, </td>

  2482.         </tr>

  2483.         <tr>

  2484.           <td class="paramkey"></td>

  2485.           <td></td>

  2486.           <td class="paramtype">size_t&#160;</td>

  2487.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2488.         </tr>

  2489.         <tr>

  2490.           <td></td>

  2491.           <td>)</td>

  2492.           <td></td><td></td>

  2493.         </tr>

  2494.       </table>

  2495.   </td>

  2496.   <td class="mlabels-right">

  2497. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2498.   </tr>

  2499. </table>

  2500. </div><div class="memdoc">

  2501. <p>Read data from a file starting at the current position.</p>

  2502. <dl class="params"><dt>Parameters</dt><dd>

  2503.   <table class="params">

  2504.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2505.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2506.   </table>

  2507.   </dd>

  2508. </dl>

  2509. <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>

  2510. 

  2511. </div>

  2512. </div>

  2513. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2514. <div class="memitem">

  2515. <div class="memproto">

  2516. <table class="mlabels">

  2517.   <tr>

  2518.   <td class="mlabels-left">

  2519.       <table class="memname">

  2520.         <tr>

  2521.           <td class="memname">int8_t FatFile::readDir </td>

  2522.           <td>(</td>

  2523.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2524.           <td class="paramname"><em>dir</em></td><td>)</td>

  2525.           <td></td>

  2526.         </tr>

  2527.       </table>

  2528.   </td>

  2529.   <td class="mlabels-right">

  2530. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2531.   </tr>

  2532. </table>

  2533. </div><div class="memdoc">

  2534. <p>Read the next directory entry from a directory file.</p>

  2535. <dl class="params"><dt>Parameters</dt><dd>

  2536.   <table class="params">

  2537.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2538.   </table>

  2539.   </dd>

  2540. </dl>

  2541. <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>

  2542. 

  2543. </div>

  2544. </div>

  2545. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2546. <div class="memitem">

  2547. <div class="memproto">

  2548. <table class="mlabels">

  2549.   <tr>

  2550.   <td class="mlabels-left">

  2551.       <table class="memname">

  2552.         <tr>

  2553.           <td class="memname">bool FatFile::remove </td>

  2554.           <td>(</td>

  2555.           <td class="paramname"></td><td>)</td>

  2556.           <td></td>

  2557.         </tr>

  2558.       </table>

  2559.   </td>

  2560.   <td class="mlabels-right">

  2561. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2562.   </tr>

  2563. </table>

  2564. </div><div class="memdoc">

  2565. <p>Remove a file.</p>

  2566. <p>The directory entry and all data for the file are deleted.</p>

  2567. <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>

  2568. <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>

  2569. 

  2570. </div>

  2571. </div>

  2572. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2573. <div class="memitem">

  2574. <div class="memproto">

  2575. <table class="mlabels">

  2576.   <tr>

  2577.   <td class="mlabels-left">

  2578.       <table class="memname">

  2579.         <tr>

  2580.           <td class="memname">bool FatFile::remove </td>

  2581.           <td>(</td>

  2582.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2583.           <td class="paramname"><em>dirFile</em>, </td>

  2584.         </tr>

  2585.         <tr>

  2586.           <td class="paramkey"></td>

  2587.           <td></td>

  2588.           <td class="paramtype">const char *&#160;</td>

  2589.           <td class="paramname"><em>path</em>&#160;</td>

  2590.         </tr>

  2591.         <tr>

  2592.           <td></td>

  2593.           <td>)</td>

  2594.           <td></td><td></td>

  2595.         </tr>

  2596.       </table>

  2597.   </td>

  2598.   <td class="mlabels-right">

  2599. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2600.   </tr>

  2601. </table>

  2602. </div><div class="memdoc">

  2603. <p>Remove a file.</p>

  2604. <p>The directory entry and all data for the file are deleted.</p>

  2605. <dl class="params"><dt>Parameters</dt><dd>

  2606.   <table class="params">

  2607.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2608.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2609.   </table>

  2610.   </dd>

  2611. </dl>

  2612. <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>

  2613. <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>

  2614. 

  2615. </div>

  2616. </div>

  2617. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2618. <div class="memitem">

  2619. <div class="memproto">

  2620. <table class="mlabels">

  2621.   <tr>

  2622.   <td class="mlabels-left">

  2623.       <table class="memname">

  2624.         <tr>

  2625.           <td class="memname">bool FatFile::rename </td>

  2626.           <td>(</td>

  2627.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2628.           <td class="paramname"><em>dirFile</em>, </td>

  2629.         </tr>

  2630.         <tr>

  2631.           <td class="paramkey"></td>

  2632.           <td></td>

  2633.           <td class="paramtype">const char *&#160;</td>

  2634.           <td class="paramname"><em>newPath</em>&#160;</td>

  2635.         </tr>

  2636.         <tr>

  2637.           <td></td>

  2638.           <td>)</td>

  2639.           <td></td><td></td>

  2640.         </tr>

  2641.       </table>

  2642.   </td>

  2643.   <td class="mlabels-right">

  2644. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2645.   </tr>

  2646. </table>

  2647. </div><div class="memdoc">

  2648. <p>Rename a file or subdirectory.</p>

  2649. <dl class="params"><dt>Parameters</dt><dd>

  2650.   <table class="params">

  2651.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2652.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2653.   </table>

  2654.   </dd>

  2655. </dl>

  2656. <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>

  2657. 

  2658. </div>

  2659. </div>

  2660. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2661. <div class="memitem">

  2662. <div class="memproto">

  2663. <table class="mlabels">

  2664.   <tr>

  2665.   <td class="mlabels-left">

  2666.       <table class="memname">

  2667.         <tr>

  2668.           <td class="memname">void FatFile::rewind </td>

  2669.           <td>(</td>

  2670.           <td class="paramname"></td><td>)</td>

  2671.           <td></td>

  2672.         </tr>

  2673.       </table>

  2674.   </td>

  2675.   <td class="mlabels-right">

  2676. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2677.   </tr>

  2678. </table>

  2679. </div><div class="memdoc">

  2680. <p>Set the file's current position to zero. </p>

  2681. 

  2682. </div>

  2683. </div>

  2684. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2685. <div class="memitem">

  2686. <div class="memproto">

  2687. <table class="mlabels">

  2688.   <tr>

  2689.   <td class="mlabels-left">

  2690.       <table class="memname">

  2691.         <tr>

  2692.           <td class="memname">bool FatFile::rmdir </td>

  2693.           <td>(</td>

  2694.           <td class="paramname"></td><td>)</td>

  2695.           <td></td>

  2696.         </tr>

  2697.       </table>

  2698.   </td>

  2699.   <td class="mlabels-right">

  2700. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2701.   </tr>

  2702. </table>

  2703. </div><div class="memdoc">

  2704. <p>Remove a directory file.</p>

  2705. <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>

  2706. <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>

  2707. <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>

  2708. 

  2709. </div>

  2710. </div>

  2711. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2712. <div class="memitem">

  2713. <div class="memproto">

  2714. <table class="mlabels">

  2715.   <tr>

  2716.   <td class="mlabels-left">

  2717.       <table class="memname">

  2718.         <tr>

  2719.           <td class="memname">bool FatFile::rmRfStar </td>

  2720.           <td>(</td>

  2721.           <td class="paramname"></td><td>)</td>

  2722.           <td></td>

  2723.         </tr>

  2724.       </table>

  2725.   </td>

  2726.   <td class="mlabels-right">

  2727. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2728.   </tr>

  2729. </table>

  2730. </div><div class="memdoc">

  2731. <p>Recursively delete a directory and all contained files.</p>

  2732. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2733. <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>

  2734. <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>

  2735. <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>

  2736. 

  2737. </div>

  2738. </div>

  2739. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2740. <div class="memitem">

  2741. <div class="memproto">

  2742. <table class="mlabels">

  2743.   <tr>

  2744.   <td class="mlabels-left">

  2745.       <table class="memname">

  2746.         <tr>

  2747.           <td class="memname">bool FatFile::seekCur </td>

  2748.           <td>(</td>

  2749.           <td class="paramtype">int32_t&#160;</td>

  2750.           <td class="paramname"><em>offset</em></td><td>)</td>

  2751.           <td></td>

  2752.         </tr>

  2753.       </table>

  2754.   </td>

  2755.   <td class="mlabels-right">

  2756. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2757.   </tr>

  2758. </table>

  2759. </div><div class="memdoc">

  2760. <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>

  2761.   <table class="params">

  2762.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2763.   </table>

  2764.   </dd>

  2765. </dl>

  2766. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2767. 

  2768. </div>

  2769. </div>

  2770. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2771. <div class="memitem">

  2772. <div class="memproto">

  2773. <table class="mlabels">

  2774.   <tr>

  2775.   <td class="mlabels-left">

  2776.       <table class="memname">

  2777.         <tr>

  2778.           <td class="memname">bool FatFile::seekEnd </td>

  2779.           <td>(</td>

  2780.           <td class="paramtype">int32_t&#160;</td>

  2781.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2782.           <td></td>

  2783.         </tr>

  2784.       </table>

  2785.   </td>

  2786.   <td class="mlabels-right">

  2787. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2788.   </tr>

  2789. </table>

  2790. </div><div class="memdoc">

  2791. <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>

  2792.   <table class="params">

  2793.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2794.   </table>

  2795.   </dd>

  2796. </dl>

  2797. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2798. 

  2799. </div>

  2800. </div>

  2801. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2802. <div class="memitem">

  2803. <div class="memproto">

  2804. <table class="mlabels">

  2805.   <tr>

  2806.   <td class="mlabels-left">

  2807.       <table class="memname">

  2808.         <tr>

  2809.           <td class="memname">bool FatFile::seekSet </td>

  2810.           <td>(</td>

  2811.           <td class="paramtype">uint32_t&#160;</td>

  2812.           <td class="paramname"><em>pos</em></td><td>)</td>

  2813.           <td></td>

  2814.         </tr>

  2815.       </table>

  2816.   </td>

  2817.   <td class="mlabels-right">

  2818. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2819.   </tr>

  2820. </table>

  2821. </div><div class="memdoc">

  2822. <p>Sets a file's position.</p>

  2823. <dl class="params"><dt>Parameters</dt><dd>

  2824.   <table class="params">

  2825.     <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>

  2826.   </table>

  2827.   </dd>

  2828. </dl>

  2829. <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>

  2830. 

  2831. </div>

  2832. </div>

  2833. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2834. <div class="memitem">

  2835. <div class="memproto">

  2836. <table class="mlabels">

  2837.   <tr>

  2838.   <td class="mlabels-left">

  2839.       <table class="memname">

  2840.         <tr>

  2841.           <td class="memname">static bool FatFile::setCwd </td>

  2842.           <td>(</td>

  2843.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2844.           <td class="paramname"><em>dir</em></td><td>)</td>

  2845.           <td></td>

  2846.         </tr>

  2847.       </table>

  2848.   </td>

  2849.   <td class="mlabels-right">

  2850. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2851.   </tr>

  2852. </table>

  2853. </div><div class="memdoc">

  2854. <p>Set the current working directory.</p>

  2855. <dl class="params"><dt>Parameters</dt><dd>

  2856.   <table class="params">

  2857.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2858.   </table>

  2859.   </dd>

  2860. </dl>

  2861. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2862. 

  2863. </div>

  2864. </div>

  2865. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2866. <div class="memitem">

  2867. <div class="memproto">

  2868. <table class="mlabels">

  2869.   <tr>

  2870.   <td class="mlabels-left">

  2871.       <table class="memname">

  2872.         <tr>

  2873.           <td class="memname">void FatFile::setpos </td>

  2874.           <td>(</td>

  2875.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2876.           <td class="paramname"><em>pos</em></td><td>)</td>

  2877.           <td></td>

  2878.         </tr>

  2879.       </table>

  2880.   </td>

  2881.   <td class="mlabels-right">

  2882. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2883.   </tr>

  2884. </table>

  2885. </div><div class="memdoc">

  2886. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2887.   <table class="params">

  2888.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2889.   </table>

  2890.   </dd>

  2891. </dl>

  2892. 

  2893. </div>

  2894. </div>

  2895. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2896. <div class="memitem">

  2897. <div class="memproto">

  2898. <table class="mlabels">

  2899.   <tr>

  2900.   <td class="mlabels-left">

  2901.       <table class="memname">

  2902.         <tr>

  2903.           <td class="memname">bool FatFile::sync </td>

  2904.           <td>(</td>

  2905.           <td class="paramname"></td><td>)</td>

  2906.           <td></td>

  2907.         </tr>

  2908.       </table>

  2909.   </td>

  2910.   <td class="mlabels-right">

  2911. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2912.   </tr>

  2913. </table>

  2914. </div><div class="memdoc">

  2915. <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>

  2916. <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>

  2917. 

  2918. </div>

  2919. </div>

  2920. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2921. <div class="memitem">

  2922. <div class="memproto">

  2923. <table class="mlabels">

  2924.   <tr>

  2925.   <td class="mlabels-left">

  2926.       <table class="memname">

  2927.         <tr>

  2928.           <td class="memname">bool FatFile::timestamp </td>

  2929.           <td>(</td>

  2930.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2931.           <td class="paramname"><em>file</em></td><td>)</td>

  2932.           <td></td>

  2933.         </tr>

  2934.       </table>

  2935.   </td>

  2936.   <td class="mlabels-right">

  2937. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2938.   </tr>

  2939. </table>

  2940. </div><div class="memdoc">

  2941. <p>Copy a file's timestamps</p>

  2942. <dl class="params"><dt>Parameters</dt><dd>

  2943.   <table class="params">

  2944.     <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>

  2945.   </table>

  2946.   </dd>

  2947. </dl>

  2948. <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>

  2949. <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>

  2950. 

  2951. </div>

  2952. </div>

  2953. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2954. <div class="memitem">

  2955. <div class="memproto">

  2956. <table class="mlabels">

  2957.   <tr>

  2958.   <td class="mlabels-left">

  2959.       <table class="memname">

  2960.         <tr>

  2961.           <td class="memname">bool FatFile::timestamp </td>

  2962.           <td>(</td>

  2963.           <td class="paramtype">uint8_t&#160;</td>

  2964.           <td class="paramname"><em>flags</em>, </td>

  2965.         </tr>

  2966.         <tr>

  2967.           <td class="paramkey"></td>

  2968.           <td></td>

  2969.           <td class="paramtype">uint16_t&#160;</td>

  2970.           <td class="paramname"><em>year</em>, </td>

  2971.         </tr>

  2972.         <tr>

  2973.           <td class="paramkey"></td>

  2974.           <td></td>

  2975.           <td class="paramtype">uint8_t&#160;</td>

  2976.           <td class="paramname"><em>month</em>, </td>

  2977.         </tr>

  2978.         <tr>

  2979.           <td class="paramkey"></td>

  2980.           <td></td>

  2981.           <td class="paramtype">uint8_t&#160;</td>

  2982.           <td class="paramname"><em>day</em>, </td>

  2983.         </tr>

  2984.         <tr>

  2985.           <td class="paramkey"></td>

  2986.           <td></td>

  2987.           <td class="paramtype">uint8_t&#160;</td>

  2988.           <td class="paramname"><em>hour</em>, </td>

  2989.         </tr>

  2990.         <tr>

  2991.           <td class="paramkey"></td>

  2992.           <td></td>

  2993.           <td class="paramtype">uint8_t&#160;</td>

  2994.           <td class="paramname"><em>minute</em>, </td>

  2995.         </tr>

  2996.         <tr>

  2997.           <td class="paramkey"></td>

  2998.           <td></td>

  2999.           <td class="paramtype">uint8_t&#160;</td>

  3000.           <td class="paramname"><em>second</em>&#160;</td>

  3001.         </tr>

  3002.         <tr>

  3003.           <td></td>

  3004.           <td>)</td>

  3005.           <td></td><td></td>

  3006.         </tr>

  3007.       </table>

  3008.   </td>

  3009.   <td class="mlabels-right">

  3010. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3011.   </tr>

  3012. </table>

  3013. </div><div class="memdoc">

  3014. <p>Set a file's timestamps in its directory entry.</p>

  3015. <dl class="params"><dt>Parameters</dt><dd>

  3016.   <table class="params">

  3017.     <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>

  3018.   </table>

  3019.   </dd>

  3020. </dl>

  3021. <p>T_ACCESS - Set the file's last access date.</p>

  3022. <p>T_CREATE - Set the file's creation date and time.</p>

  3023. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3024. <dl class="params"><dt>Parameters</dt><dd>

  3025.   <table class="params">

  3026.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3027.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3028.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3029.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3030.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3031.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3032.   </table>

  3033.   </dd>

  3034. </dl>

  3035. <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>

  3036. <dd>

  3037. 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>

  3038. <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>

  3039. 

  3040. </div>

  3041. </div>

  3042. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3043. <div class="memitem">

  3044. <div class="memproto">

  3045. <table class="mlabels">

  3046.   <tr>

  3047.   <td class="mlabels-left">

  3048.       <table class="memname">

  3049.         <tr>

  3050.           <td class="memname">bool FatFile::truncate </td>

  3051.           <td>(</td>

  3052.           <td class="paramtype">uint32_t&#160;</td>

  3053.           <td class="paramname"><em>length</em></td><td>)</td>

  3054.           <td></td>

  3055.         </tr>

  3056.       </table>

  3057.   </td>

  3058.   <td class="mlabels-right">

  3059. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3060.   </tr>

  3061. </table>

  3062. </div><div class="memdoc">

  3063. <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>

  3064. <dl class="params"><dt>Parameters</dt><dd>

  3065.   <table class="params">

  3066.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3067.   </table>

  3068.   </dd>

  3069. </dl>

  3070. <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>

  3071. 

  3072. </div>

  3073. </div>

  3074. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3075. <div class="memitem">

  3076. <div class="memproto">

  3077. <table class="mlabels">

  3078.   <tr>

  3079.   <td class="mlabels-left">

  3080.       <table class="memname">

  3081.         <tr>

  3082.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3083.           <td>(</td>

  3084.           <td class="paramname"></td><td>)</td>

  3085.           <td> const</td>

  3086.         </tr>

  3087.       </table>

  3088.   </td>

  3089.   <td class="mlabels-right">

  3090. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3091.   </tr>

  3092. </table>

  3093. </div><div class="memdoc">

  3094. <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>

  3095. 

  3096. </div>

  3097. </div>

  3098. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3099. <div class="memitem">

  3100. <div class="memproto">

  3101. <table class="mlabels">

  3102.   <tr>

  3103.   <td class="mlabels-left">

  3104.       <table class="memname">

  3105.         <tr>

  3106.           <td class="memname">int FatFile::write </td>

  3107.           <td>(</td>

  3108.           <td class="paramtype">const char *&#160;</td>

  3109.           <td class="paramname"><em>str</em></td><td>)</td>

  3110.           <td></td>

  3111.         </tr>

  3112.       </table>

  3113.   </td>

  3114.   <td class="mlabels-right">

  3115. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3116.   </tr>

  3117. </table>

  3118. </div><div class="memdoc">

  3119. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3120.   <table class="params">

  3121.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3122.   </table>

  3123.   </dd>

  3124. </dl>

  3125. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3126. 

  3127. </div>

  3128. </div>

  3129. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  3130. <div class="memitem">

  3131. <div class="memproto">

  3132. <table class="mlabels">

  3133.   <tr>

  3134.   <td class="mlabels-left">

  3135.       <table class="memname">

  3136.         <tr>

  3137.           <td class="memname">int FatFile::write </td>

  3138.           <td>(</td>

  3139.           <td class="paramtype">uint8_t&#160;</td>

  3140.           <td class="paramname"><em>b</em></td><td>)</td>

  3141.           <td></td>

  3142.         </tr>

  3143.       </table>

  3144.   </td>

  3145.   <td class="mlabels-right">

  3146. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3147.   </tr>

  3148. </table>

  3149. </div><div class="memdoc">

  3150. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  3151.   <table class="params">

  3152.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  3153.   </table>

  3154.   </dd>

  3155. </dl>

  3156. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  3157. 

  3158. </div>

  3159. </div>

  3160. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3161. <div class="memitem">

  3162. <div class="memproto">

  3163. <table class="mlabels">

  3164.   <tr>

  3165.   <td class="mlabels-left">

  3166.       <table class="memname">

  3167.         <tr>

  3168.           <td class="memname">int FatFile::write </td>

  3169.           <td>(</td>

  3170.           <td class="paramtype">const void *&#160;</td>

  3171.           <td class="paramname"><em>buf</em>, </td>

  3172.         </tr>

  3173.         <tr>

  3174.           <td class="paramkey"></td>

  3175.           <td></td>

  3176.           <td class="paramtype">size_t&#160;</td>

  3177.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3178.         </tr>

  3179.         <tr>

  3180.           <td></td>

  3181.           <td>)</td>

  3182.           <td></td><td></td>

  3183.         </tr>

  3184.       </table>

  3185.   </td>

  3186.   <td class="mlabels-right">

  3187. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3188.   </tr>

  3189. </table>

  3190. </div><div class="memdoc">

  3191. <p>Write data to an open file.</p>

  3192. <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>

  3193. <dl class="params"><dt>Parameters</dt><dd>

  3194.   <table class="params">

  3195.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3196.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3197.   </table>

  3198.   </dd>

  3199. </dl>

  3200. <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>

  3201. 

  3202. </div>

  3203. </div>

  3204. <hr/>The documentation for this class was generated from the following file:<ul>

  3205. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  3206. </ul>

  3207. </div><!-- contents -->

  3208. <!-- start footer part -->

  3209. <hr class="footer"/><address class="footer"><small>

  3210. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3211. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3212. </a> 1.8.8

  3213. </small></address>

  3214. </body>

  3215. </html>