visus
/
teensy-sdfat
Tarkkaile 1
Äänestä 0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Activity
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.
18 Commitit
1 Haara
Puu: 5e01de8244
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '5e01de8244'
${ noResults }
teensy-sdfat/html/class_fat_file.html

2911 lines
136KB
Raaka Blame Historia 

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

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

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

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Basic file class.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for FatFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node3" href="class_fat_stream_base.html" title="Base class for C++ style streams. " alt="" coords="71,80,184,107"/>
<area shape="rect" id="node11" href="class_file.html" title="Arduino SD.h style File API. " alt="" coords="209,80,252,107"/>
<area shape="rect" id="node13" href="class_print_file.html" title="FatFile with Print. " alt="" coords="277,80,347,107"/>
<area shape="rect" id="node17" href="class_sd_base_file.html" title="Class for backward compatibility. " alt="" coords="371,80,460,107"/>
<area shape="rect" id="node19" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. " alt="" coords="485,80,579,107"/>
<area shape="rect" id="node5" href="classfstream.html" title="file input/output stream. " alt="" coords="5,155,69,181"/>
<area shape="rect" id="node7" href="classifstream.html" title="file input stream. " alt="" coords="94,155,161,181"/>
<area shape="rect" id="node9" href="classofstream.html" title="file output stream. " alt="" coords="187,155,259,181"/>
<area shape="rect" id="node15" href="class_sd_file.html" title="Class for backward compatibility. " alt="" coords="283,155,341,181"/>
</map>

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

  104. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  284. </table>

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

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

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

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

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

  299.           <td></td>

  300.         </tr>

  301.       </table>

  302.   </td>

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

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

  305.   </tr>

  306. </table>

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

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

  309. 

  310. </div>

  311. </div>

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

  313. <div class="memitem">

  314. <div class="memproto">

  315. <table class="mlabels">

  316.   <tr>

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

  318.       <table class="memname">

  319.         <tr>

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

  321.           <td>(</td>

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

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

  324.         </tr>

  325.         <tr>

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

  327.           <td></td>

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

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

  330.         </tr>

  331.         <tr>

  332.           <td></td>

  333.           <td>)</td>

  334.           <td></td><td></td>

  335.         </tr>

  336.       </table>

  337.   </td>

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

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

  340.   </tr>

  341. </table>

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

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

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

  345.   <table class="params">

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

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

  348.   </table>

  349.   </dd>

  350. </dl>

  351. 

  352. </div>

  353. </div>

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

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

  356. <div class="memitem">

  357. <div class="memproto">

  358. <table class="mlabels">

  359.   <tr>

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

  361.       <table class="memname">

  362.         <tr>

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

  364.           <td>(</td>

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

  366.           <td></td>

  367.         </tr>

  368.       </table>

  369.   </td>

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

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

  372.   </tr>

  373. </table>

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

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

  376. 

  377. </div>

  378. </div>

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

  380. <div class="memitem">

  381. <div class="memproto">

  382. <table class="mlabels">

  383.   <tr>

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

  385.       <table class="memname">

  386.         <tr>

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

  388.           <td>(</td>

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

  390.           <td></td>

  391.         </tr>

  392.       </table>

  393.   </td>

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

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

  396.   </tr>

  397. </table>

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

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

  400. 

  401. </div>

  402. </div>

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

  404. <div class="memitem">

  405. <div class="memproto">

  406. <table class="mlabels">

  407.   <tr>

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

  409.       <table class="memname">

  410.         <tr>

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

  412.           <td>(</td>

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

  414.           <td></td>

  415.         </tr>

  416.       </table>

  417.   </td>

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

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

  420.   </tr>

  421. </table>

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

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

  424. 

  425. </div>

  426. </div>

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

  428. <div class="memitem">

  429. <div class="memproto">

  430.       <table class="memname">

  431.         <tr>

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

  433.           <td>(</td>

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

  435.           <td></td>

  436.         </tr>

  437.       </table>

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

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

  440. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  441. 

  442. </div>

  443. </div>

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

  445. <div class="memitem">

  446. <div class="memproto">

  447.       <table class="memname">

  448.         <tr>

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

  450.           <td>(</td>

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

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

  453.         </tr>

  454.         <tr>

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

  456.           <td></td>

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

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

  459.         </tr>

  460.         <tr>

  461.           <td></td>

  462.           <td>)</td>

  463.           <td></td><td></td>

  464.         </tr>

  465.       </table>

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

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

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

  469.   <table class="params">

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

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

  472.   </table>

  473.   </dd>

  474. </dl>

  475. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  476. 

  477. </div>

  478. </div>

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

  480. <div class="memitem">

  481. <div class="memproto">

  482.       <table class="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. </div><div class="memdoc">

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

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

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

  511.   <table class="params">

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

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

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

  515.   </table>

  516.   </dd>

  517. </dl>

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

  519. 

  520. </div>

  521. </div>

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

  523. <div class="memitem">

  524. <div class="memproto">

  525. <table class="mlabels">

  526.   <tr>

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

  528.       <table class="memname">

  529.         <tr>

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

  531.           <td>(</td>

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

  533.           <td> const</td>

  534.         </tr>

  535.       </table>

  536.   </td>

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

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

  539.   </tr>

  540. </table>

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

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

  543. 

  544. </div>

  545. </div>

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

  547. <div class="memitem">

  548. <div class="memproto">

  549. <table class="mlabels">

  550.   <tr>

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

  552.       <table class="memname">

  553.         <tr>

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

  555.           <td>(</td>

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

  557.           <td> const</td>

  558.         </tr>

  559.       </table>

  560.   </td>

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

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

  563.   </tr>

  564. </table>

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

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

  567. 

  568. </div>

  569. </div>

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

  571. <div class="memitem">

  572. <div class="memproto">

  573. <table class="mlabels">

  574.   <tr>

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

  576.       <table class="memname">

  577.         <tr>

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

  579.           <td>(</td>

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

  581.           <td></td>

  582.         </tr>

  583.       </table>

  584.   </td>

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

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

  587.   </tr>

  588. </table>

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

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

  591. 

  592. </div>

  593. </div>

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

  595. <div class="memitem">

  596. <div class="memproto">

  597. <table class="mlabels">

  598.   <tr>

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

  600.       <table class="memname">

  601.         <tr>

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

  603.           <td>(</td>

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

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

  606.           <td></td>

  607.         </tr>

  608.       </table>

  609.   </td>

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

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

  612.   </tr>

  613. </table>

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

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

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

  617.   <table class="params">

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

  619.   </table>

  620.   </dd>

  621. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  636. 

  637. </div>

  638. </div>

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

  640. <div class="memitem">

  641. <div class="memproto">

  642. <table class="mlabels">

  643.   <tr>

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

  645.       <table class="memname">

  646.         <tr>

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

  648.           <td>(</td>

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

  650.           <td></td>

  651.         </tr>

  652.       </table>

  653.   </td>

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

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

  656.   </tr>

  657. </table>

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

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

  660. 

  661. </div>

  662. </div>

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

  664. <div class="memitem">

  665. <div class="memproto">

  666.       <table class="memname">

  667.         <tr>

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

  669.           <td>(</td>

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

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

  672.           <td></td>

  673.         </tr>

  674.       </table>

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

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

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

  678.   <table class="params">

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

  680.   </table>

  681.   </dd>

  682. </dl>

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

  684. 

  685. </div>

  686. </div>

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

  688. <div class="memitem">

  689. <div class="memproto">

  690. <table class="mlabels">

  691.   <tr>

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

  693.       <table class="memname">

  694.         <tr>

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

  696.           <td>(</td>

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

  698.           <td></td>

  699.         </tr>

  700.       </table>

  701.   </td>

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

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

  704.   </tr>

  705. </table>

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

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

  708. 

  709. </div>

  710. </div>

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

  712. <div class="memitem">

  713. <div class="memproto">

  714. <table class="mlabels">

  715.   <tr>

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

  717.       <table class="memname">

  718.         <tr>

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

  720.           <td>(</td>

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

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

  723.         </tr>

  724.         <tr>

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

  726.           <td></td>

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

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

  729.         </tr>

  730.         <tr>

  731.           <td></td>

  732.           <td>)</td>

  733.           <td></td><td></td>

  734.         </tr>

  735.       </table>

  736.   </td>

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

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

  739.   </tr>

  740. </table>

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

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

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

  744.   <table class="params">

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

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

  747.   </table>

  748.   </dd>

  749. </dl>

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

  751. 

  752. </div>

  753. </div>

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

  755. <div class="memitem">

  756. <div class="memproto">

  757.       <table class="memname">

  758.         <tr>

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

  760.           <td>(</td>

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

  762.           <td></td>

  763.         </tr>

  764.       </table>

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

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

  767. 

  768. </div>

  769. </div>

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

  771. <div class="memitem">

  772. <div class="memproto">

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

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

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

  779.         </tr>

  780.         <tr>

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

  782.           <td></td>

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

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

  785.         </tr>

  786.         <tr>

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

  788.           <td></td>

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

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

  791.         </tr>

  792.         <tr>

  793.           <td></td>

  794.           <td>)</td>

  795.           <td></td><td></td>

  796.         </tr>

  797.       </table>

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

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

  800.   <table class="params">

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

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

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

  804.   </table>

  805.   </dd>

  806. </dl>

  807. 

  808. </div>

  809. </div>

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

  811. <div class="memitem">

  812. <div class="memproto">

  813. <table class="mlabels">

  814.   <tr>

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

  816.       <table class="memname">

  817.         <tr>

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

  819.           <td>(</td>

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

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

  822.           <td></td>

  823.         </tr>

  824.       </table>

  825.   </td>

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

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

  828.   </tr>

  829. </table>

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

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

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

  833.   <table class="params">

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

  835.   </table>

  836.   </dd>

  837. </dl>

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

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

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

  841. 

  842. </div>

  843. </div>

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

  845. <div class="memitem">

  846. <div class="memproto">

  847.       <table class="memname">

  848.         <tr>

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

  850.           <td>(</td>

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

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

  853.         </tr>

  854.         <tr>

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

  856.           <td></td>

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

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

  859.         </tr>

  860.         <tr>

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

  862.           <td></td>

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

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

  865.         </tr>

  866.         <tr>

  867.           <td></td>

  868.           <td>)</td>

  869.           <td></td><td></td>

  870.         </tr>

  871.       </table>

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

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

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

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

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

  877.   <table class="params">

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

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

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

  881.   </table>

  882.   </dd>

  883. </dl>

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

  885. 

  886. </div>

  887. </div>

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

  889. <div class="memitem">

  890. <div class="memproto">

  891. <table class="mlabels">

  892.   <tr>

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

  894.       <table class="memname">

  895.         <tr>

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

  897.           <td>(</td>

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

  899.           <td> const</td>

  900.         </tr>

  901.       </table>

  902.   </td>

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

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

  905.   </tr>

  906. </table>

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

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

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

  910. 

  911. </div>

  912. </div>

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

  914. <div class="memitem">

  915. <div class="memproto">

  916. <table class="mlabels">

  917.   <tr>

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

  919.       <table class="memname">

  920.         <tr>

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

  922.           <td>(</td>

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

  924.           <td> const</td>

  925.         </tr>

  926.       </table>

  927.   </td>

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

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

  930.   </tr>

  931. </table>

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

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

  934. 

  935. </div>

  936. </div>

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

  938. <div class="memitem">

  939. <div class="memproto">

  940. <table class="mlabels">

  941.   <tr>

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

  943.       <table class="memname">

  944.         <tr>

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

  946.           <td>(</td>

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

  948.           <td> const</td>

  949.         </tr>

  950.       </table>

  951.   </td>

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

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

  954.   </tr>

  955. </table>

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

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

  958. 

  959. </div>

  960. </div>

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

  962. <div class="memitem">

  963. <div class="memproto">

  964. <table class="mlabels">

  965.   <tr>

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

  967.       <table class="memname">

  968.         <tr>

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

  970.           <td>(</td>

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

  972.           <td></td>

  973.         </tr>

  974.       </table>

  975.   </td>

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

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

  978.   </tr>

  979. </table>

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

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

  982. 

  983. </div>

  984. </div>

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

  986. <div class="memitem">

  987. <div class="memproto">

  988.       <table class="memname">

  989.         <tr>

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

  991.           <td>(</td>

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

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

  994.         </tr>

  995.         <tr>

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

  997.           <td></td>

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

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

  1000.         </tr>

  1001.         <tr>

  1002.           <td></td>

  1003.           <td>)</td>

  1004.           <td></td><td></td>

  1005.         </tr>

  1006.       </table>

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

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

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

  1010.   <table class="params">

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

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

  1013.   </table>

  1014.   </dd>

  1015. </dl>

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

  1017. 

  1018. </div>

  1019. </div>

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

  1021. <div class="memitem">

  1022. <div class="memproto">

  1023.       <table class="memname">

  1024.         <tr>

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

  1026.           <td>(</td>

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

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

  1029.           <td></td>

  1030.         </tr>

  1031.       </table>

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

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

  1034.   <table class="params">

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

  1036.   </table>

  1037.   </dd>

  1038. </dl>

  1039. 

  1040. </div>

  1041. </div>

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

  1043. <div class="memitem">

  1044. <div class="memproto">

  1045.       <table class="memname">

  1046.         <tr>

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

  1048.           <td>(</td>

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

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

  1051.           <td></td>

  1052.         </tr>

  1053.       </table>

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

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

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

  1057.   <table class="params">

  1058.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. The array must be at least 13 bytes long. </td></tr>

  1059.   </table>

  1060.   </dd>

  1061. </dl>

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

  1063. 

  1064. </div>

  1065. </div>

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

  1067. <div class="memitem">

  1068. <div class="memproto">

  1069. <table class="mlabels">

  1070.   <tr>

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

  1072.       <table class="memname">

  1073.         <tr>

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

  1075.           <td>(</td>

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

  1077.           <td></td>

  1078.         </tr>

  1079.       </table>

  1080.   </td>

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

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

  1083.   </tr>

  1084. </table>

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

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

  1087. 

  1088. </div>

  1089. </div>

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

  1091. <div class="memitem">

  1092. <div class="memproto">

  1093. <table class="mlabels">

  1094.   <tr>

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

  1096.       <table class="memname">

  1097.         <tr>

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

  1099.           <td>(</td>

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

  1101.           <td> const</td>

  1102.         </tr>

  1103.       </table>

  1104.   </td>

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

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

  1107.   </tr>

  1108. </table>

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

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

  1111. 

  1112. </div>

  1113. </div>

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

  1115. <div class="memitem">

  1116. <div class="memproto">

  1117. <table class="mlabels">

  1118.   <tr>

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

  1120.       <table class="memname">

  1121.         <tr>

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

  1123.           <td>(</td>

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

  1125.           <td> const</td>

  1126.         </tr>

  1127.       </table>

  1128.   </td>

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

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

  1131.   </tr>

  1132. </table>

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

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

  1135. 

  1136. </div>

  1137. </div>

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

  1139. <div class="memitem">

  1140. <div class="memproto">

  1141. <table class="mlabels">

  1142.   <tr>

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

  1144.       <table class="memname">

  1145.         <tr>

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

  1147.           <td>(</td>

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

  1149.           <td> const</td>

  1150.         </tr>

  1151.       </table>

  1152.   </td>

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

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

  1155.   </tr>

  1156. </table>

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

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

  1159. 

  1160. </div>

  1161. </div>

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

  1163. <div class="memitem">

  1164. <div class="memproto">

  1165. <table class="mlabels">

  1166.   <tr>

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

  1168.       <table class="memname">

  1169.         <tr>

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

  1171.           <td>(</td>

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

  1173.           <td> const</td>

  1174.         </tr>

  1175.       </table>

  1176.   </td>

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

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

  1179.   </tr>

  1180. </table>

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

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

  1183. 

  1184. </div>

  1185. </div>

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

  1187. <div class="memitem">

  1188. <div class="memproto">

  1189. <table class="mlabels">

  1190.   <tr>

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

  1192.       <table class="memname">

  1193.         <tr>

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

  1195.           <td>(</td>

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

  1197.           <td> const</td>

  1198.         </tr>

  1199.       </table>

  1200.   </td>

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

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

  1203.   </tr>

  1204. </table>

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

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

  1207. 

  1208. </div>

  1209. </div>

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

  1211. <div class="memitem">

  1212. <div class="memproto">

  1213. <table class="mlabels">

  1214.   <tr>

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

  1216.       <table class="memname">

  1217.         <tr>

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

  1219.           <td>(</td>

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

  1221.           <td> const</td>

  1222.         </tr>

  1223.       </table>

  1224.   </td>

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

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

  1227.   </tr>

  1228. </table>

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

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

  1231. 

  1232. </div>

  1233. </div>

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

  1235. <div class="memitem">

  1236. <div class="memproto">

  1237. <table class="mlabels">

  1238.   <tr>

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

  1240.       <table class="memname">

  1241.         <tr>

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

  1243.           <td>(</td>

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

  1245.           <td> const</td>

  1246.         </tr>

  1247.       </table>

  1248.   </td>

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

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

  1251.   </tr>

  1252. </table>

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

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

  1255. 

  1256. </div>

  1257. </div>

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

  1259. <div class="memitem">

  1260. <div class="memproto">

  1261. <table class="mlabels">

  1262.   <tr>

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

  1264.       <table class="memname">

  1265.         <tr>

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

  1267.           <td>(</td>

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

  1269.           <td> const</td>

  1270.         </tr>

  1271.       </table>

  1272.   </td>

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

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

  1275.   </tr>

  1276. </table>

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

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

  1279. 

  1280. </div>

  1281. </div>

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

  1283. <div class="memitem">

  1284. <div class="memproto">

  1285. <table class="mlabels">

  1286.   <tr>

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

  1288.       <table class="memname">

  1289.         <tr>

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

  1291.           <td>(</td>

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

  1293.           <td> const</td>

  1294.         </tr>

  1295.       </table>

  1296.   </td>

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

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

  1299.   </tr>

  1300. </table>

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

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

  1303. 

  1304. </div>

  1305. </div>

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

  1307. <div class="memitem">

  1308. <div class="memproto">

  1309. <table class="mlabels">

  1310.   <tr>

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

  1312.       <table class="memname">

  1313.         <tr>

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

  1315.           <td>(</td>

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

  1317.           <td> const</td>

  1318.         </tr>

  1319.       </table>

  1320.   </td>

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

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

  1323.   </tr>

  1324. </table>

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

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

  1327. 

  1328. </div>

  1329. </div>

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

  1331. <div class="memitem">

  1332. <div class="memproto">

  1333. <table class="mlabels">

  1334.   <tr>

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

  1336.       <table class="memname">

  1337.         <tr>

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

  1339.           <td>(</td>

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

  1341.           <td> const</td>

  1342.         </tr>

  1343.       </table>

  1344.   </td>

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

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

  1347.   </tr>

  1348. </table>

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

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

  1351. 

  1352. </div>

  1353. </div>

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

  1355. <div class="memitem">

  1356. <div class="memproto">

  1357. <table class="mlabels">

  1358.   <tr>

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

  1360.       <table class="memname">

  1361.         <tr>

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

  1363.           <td>(</td>

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

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

  1366.           <td></td>

  1367.         </tr>

  1368.       </table>

  1369.   </td>

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

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

  1372.   </tr>

  1373. </table>

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

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

  1376.   <table class="params">

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

  1378.   </table>

  1379.   </dd>

  1380. </dl>

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

  1382. 

  1383. </div>

  1384. </div>

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

  1386. <div class="memitem">

  1387. <div class="memproto">

  1388. <table class="mlabels">

  1389.   <tr>

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

  1391.       <table class="memname">

  1392.         <tr>

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

  1394.           <td>(</td>

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

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

  1397.           <td></td>

  1398.         </tr>

  1399.       </table>

  1400.   </td>

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

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

  1403.   </tr>

  1404. </table>

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

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

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

  1408.   <table class="params">

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

  1410.   </table>

  1411.   </dd>

  1412. </dl>

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

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

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

  1416. 

  1417. </div>

  1418. </div>

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

  1420. <div class="memitem">

  1421. <div class="memproto">

  1422.       <table class="memname">

  1423.         <tr>

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

  1425.           <td>(</td>

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

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

  1428.         </tr>

  1429.         <tr>

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

  1431.           <td></td>

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

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

  1434.         </tr>

  1435.         <tr>

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

  1437.           <td></td>

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

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

  1440.         </tr>

  1441.         <tr>

  1442.           <td></td>

  1443.           <td>)</td>

  1444.           <td></td><td></td>

  1445.         </tr>

  1446.       </table>

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

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

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

  1450.   <table class="params">

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

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

  1453.   </table>

  1454.   </dd>

  1455. </dl>

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

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

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

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

  1460.   <table class="params">

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

  1462.   </table>

  1463.   </dd>

  1464. </dl>

  1465. 

  1466. </div>

  1467. </div>

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

  1469. <div class="memitem">

  1470. <div class="memproto">

  1471.       <table class="memname">

  1472.         <tr>

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

  1474.           <td>(</td>

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

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

  1477.         </tr>

  1478.         <tr>

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

  1480.           <td></td>

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

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

  1483.         </tr>

  1484.         <tr>

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

  1486.           <td></td>

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

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

  1489.         </tr>

  1490.         <tr>

  1491.           <td></td>

  1492.           <td>)</td>

  1493.           <td></td><td></td>

  1494.         </tr>

  1495.       </table>

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

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

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

  1499.   <table class="params">

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

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

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

  1503.   </table>

  1504.   </dd>

  1505. </dl>

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

  1507. 

  1508. </div>

  1509. </div>

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

  1511. <div class="memitem">

  1512. <div class="memproto">

  1513.       <table class="memname">

  1514.         <tr>

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

  1516.           <td>(</td>

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

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

  1519.         </tr>

  1520.         <tr>

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

  1522.           <td></td>

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

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

  1525.         </tr>

  1526.         <tr>

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

  1528.           <td></td>

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

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

  1531.         </tr>

  1532.         <tr>

  1533.           <td></td>

  1534.           <td>)</td>

  1535.           <td></td><td></td>

  1536.         </tr>

  1537.       </table>

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

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

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

  1541.   <table class="params">

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

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

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

  1545.   </table>

  1546.   </dd>

  1547. </dl>

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

  1549. 

  1550. </div>

  1551. </div>

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

  1553. <div class="memitem">

  1554. <div class="memproto">

  1555.       <table class="memname">

  1556.         <tr>

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

  1558.           <td>(</td>

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

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

  1561.         </tr>

  1562.         <tr>

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

  1564.           <td></td>

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

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

  1567.         </tr>

  1568.         <tr>

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

  1570.           <td></td>

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

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

  1573.         </tr>

  1574.         <tr>

  1575.           <td></td>

  1576.           <td>)</td>

  1577.           <td></td><td></td>

  1578.         </tr>

  1579.       </table>

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

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

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

  1583.   <table class="params">

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

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

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

  1587.   </table>

  1588.   </dd>

  1589. </dl>

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

  1591. 

  1592. </div>

  1593. </div>

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

  1595. <div class="memitem">

  1596. <div class="memproto">

  1597.       <table class="memname">

  1598.         <tr>

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

  1600.           <td>(</td>

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

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

  1603.         </tr>

  1604.         <tr>

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

  1606.           <td></td>

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

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

  1609.         </tr>

  1610.         <tr>

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

  1612.           <td></td>

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

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

  1615.         </tr>

  1616.         <tr>

  1617.           <td></td>

  1618.           <td>)</td>

  1619.           <td></td><td></td>

  1620.         </tr>

  1621.       </table>

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

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

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

  1625.   <table class="params">

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

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

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

  1629.   </table>

  1630.   </dd>

  1631. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1646. 

  1647. </div>

  1648. </div>

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

  1650. <div class="memitem">

  1651. <div class="memproto">

  1652. <table class="mlabels">

  1653.   <tr>

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

  1655.       <table class="memname">

  1656.         <tr>

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

  1658.           <td>(</td>

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

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

  1661.         </tr>

  1662.         <tr>

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

  1664.           <td></td>

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

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

  1667.         </tr>

  1668.         <tr>

  1669.           <td></td>

  1670.           <td>)</td>

  1671.           <td></td><td></td>

  1672.         </tr>

  1673.       </table>

  1674.   </td>

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

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

  1677.   </tr>

  1678. </table>

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

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

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

  1682.   <table class="params">

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

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

  1685.   </table>

  1686.   </dd>

  1687. </dl>

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

  1689. 

  1690. </div>

  1691. </div>

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

  1693. <div class="memitem">

  1694. <div class="memproto">

  1695.       <table class="memname">

  1696.         <tr>

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

  1698.           <td>(</td>

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

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

  1701.         </tr>

  1702.         <tr>

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

  1704.           <td></td>

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

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

  1707.         </tr>

  1708.         <tr>

  1709.           <td></td>

  1710.           <td>)</td>

  1711.           <td></td><td></td>

  1712.         </tr>

  1713.       </table>

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

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

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

  1717.   <table class="params">

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

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

  1720.   </table>

  1721.   </dd>

  1722. </dl>

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

  1724. 

  1725. </div>

  1726. </div>

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

  1728. <div class="memitem">

  1729. <div class="memproto">

  1730.       <table class="memname">

  1731.         <tr>

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

  1733.           <td>(</td>

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

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

  1736.           <td></td>

  1737.         </tr>

  1738.       </table>

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

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

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

  1742.   <table class="params">

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

  1744.   </table>

  1745.   </dd>

  1746. </dl>

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

  1748. 

  1749. </div>

  1750. </div>

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

  1752. <div class="memitem">

  1753. <div class="memproto">

  1754.       <table class="memname">

  1755.         <tr>

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

  1757.           <td>(</td>

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

  1759.           <td></td>

  1760.         </tr>

  1761.       </table>

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

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

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

  1765. 

  1766. </div>

  1767. </div>

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

  1769. <div class="memitem">

  1770. <div class="memproto">

  1771.       <table class="memname">

  1772.         <tr>

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

  1774.           <td>(</td>

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

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

  1777.           <td></td>

  1778.         </tr>

  1779.       </table>

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

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

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

  1783.   <table class="params">

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

  1785.   </table>

  1786.   </dd>

  1787. </dl>

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

  1789. 

  1790. </div>

  1791. </div>

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

  1793. <div class="memitem">

  1794. <div class="memproto">

  1795. <table class="mlabels">

  1796.   <tr>

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

  1798.       <table class="memname">

  1799.         <tr>

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

  1801.           <td>(</td>

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

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

  1804.           <td></td>

  1805.         </tr>

  1806.       </table>

  1807.   </td>

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

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

  1810.   </tr>

  1811. </table>

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

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

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

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

  1816.   <table class="params">

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

  1818.   </table>

  1819.   </dd>

  1820. </dl>

  1821. 

  1822. </div>

  1823. </div>

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

  1825. <div class="memitem">

  1826. <div class="memproto">

  1827. <table class="mlabels">

  1828.   <tr>

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

  1830.       <table class="memname">

  1831.         <tr>

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

  1833.           <td>(</td>

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

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

  1836.         </tr>

  1837.         <tr>

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

  1839.           <td></td>

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

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

  1842.         </tr>

  1843.         <tr>

  1844.           <td></td>

  1845.           <td>)</td>

  1846.           <td></td><td></td>

  1847.         </tr>

  1848.       </table>

  1849.   </td>

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

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

  1852.   </tr>

  1853. </table>

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

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

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

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

  1858.   <table class="params">

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

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

  1861.   </table>

  1862.   </dd>

  1863. </dl>

  1864. 

  1865. </div>

  1866. </div>

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

  1868. <div class="memitem">

  1869. <div class="memproto">

  1870. <table class="mlabels">

  1871.   <tr>

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

  1873.       <table class="memname">

  1874.         <tr>

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

  1876.           <td>(</td>

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

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

  1879.           <td></td>

  1880.         </tr>

  1881.       </table>

  1882.   </td>

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

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

  1885.   </tr>

  1886. </table>

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

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

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

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

  1891.   <table class="params">

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

  1893.   </table>

  1894.   </dd>

  1895. </dl>

  1896. 

  1897. </div>

  1898. </div>

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

  1900. <div class="memitem">

  1901. <div class="memproto">

  1902. <table class="mlabels">

  1903.   <tr>

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

  1905.       <table class="memname">

  1906.         <tr>

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

  1908.           <td>(</td>

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

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

  1911.         </tr>

  1912.         <tr>

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

  1914.           <td></td>

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

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

  1917.         </tr>

  1918.         <tr>

  1919.           <td></td>

  1920.           <td>)</td>

  1921.           <td></td><td></td>

  1922.         </tr>

  1923.       </table>

  1924.   </td>

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

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

  1927.   </tr>

  1928. </table>

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

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

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

  1932. <dl class="params"><dt>Parameters</dt><dd>

  1933.   <table class="params">

  1934.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1935.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  1936.   </table>

  1937.   </dd>

  1938. </dl>

  1939. 

  1940. </div>

  1941. </div>

  1942. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  1943. <div class="memitem">

  1944. <div class="memproto">

  1945.       <table class="memname">

  1946.         <tr>

  1947.           <td class="memname">int FatFile::printField </td>

  1948.           <td>(</td>

  1949.           <td class="paramtype">float&#160;</td>

  1950.           <td class="paramname"><em>value</em>, </td>

  1951.         </tr>

  1952.         <tr>

  1953.           <td class="paramkey"></td>

  1954.           <td></td>

  1955.           <td class="paramtype">char&#160;</td>

  1956.           <td class="paramname"><em>term</em>, </td>

  1957.         </tr>

  1958.         <tr>

  1959.           <td class="paramkey"></td>

  1960.           <td></td>

  1961.           <td class="paramtype">uint8_t&#160;</td>

  1962.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  1963.         </tr>

  1964.         <tr>

  1965.           <td></td>

  1966.           <td>)</td>

  1967.           <td></td><td></td>

  1968.         </tr>

  1969.       </table>

  1970. </div><div class="memdoc">

  1971. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1972.   <table class="params">

  1973.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1974.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1975.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  1976.   </table>

  1977.   </dd>

  1978. </dl>

  1979. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1980. 

  1981. </div>

  1982. </div>

  1983. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  1984. <div class="memitem">

  1985. <div class="memproto">

  1986.       <table class="memname">

  1987.         <tr>

  1988.           <td class="memname">int FatFile::printField </td>

  1989.           <td>(</td>

  1990.           <td class="paramtype">int16_t&#160;</td>

  1991.           <td class="paramname"><em>value</em>, </td>

  1992.         </tr>

  1993.         <tr>

  1994.           <td class="paramkey"></td>

  1995.           <td></td>

  1996.           <td class="paramtype">char&#160;</td>

  1997.           <td class="paramname"><em>term</em>&#160;</td>

  1998.         </tr>

  1999.         <tr>

  2000.           <td></td>

  2001.           <td>)</td>

  2002.           <td></td><td></td>

  2003.         </tr>

  2004.       </table>

  2005. </div><div class="memdoc">

  2006. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2007.   <table class="params">

  2008.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2009.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2010.   </table>

  2011.   </dd>

  2012. </dl>

  2013. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2014. 

  2015. </div>

  2016. </div>

  2017. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2018. <div class="memitem">

  2019. <div class="memproto">

  2020.       <table class="memname">

  2021.         <tr>

  2022.           <td class="memname">int FatFile::printField </td>

  2023.           <td>(</td>

  2024.           <td class="paramtype">uint16_t&#160;</td>

  2025.           <td class="paramname"><em>value</em>, </td>

  2026.         </tr>

  2027.         <tr>

  2028.           <td class="paramkey"></td>

  2029.           <td></td>

  2030.           <td class="paramtype">char&#160;</td>

  2031.           <td class="paramname"><em>term</em>&#160;</td>

  2032.         </tr>

  2033.         <tr>

  2034.           <td></td>

  2035.           <td>)</td>

  2036.           <td></td><td></td>

  2037.         </tr>

  2038.       </table>

  2039. </div><div class="memdoc">

  2040. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2041.   <table class="params">

  2042.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2043.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2044.   </table>

  2045.   </dd>

  2046. </dl>

  2047. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2048. 

  2049. </div>

  2050. </div>

  2051. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2052. <div class="memitem">

  2053. <div class="memproto">

  2054.       <table class="memname">

  2055.         <tr>

  2056.           <td class="memname">int FatFile::printField </td>

  2057.           <td>(</td>

  2058.           <td class="paramtype">int32_t&#160;</td>

  2059.           <td class="paramname"><em>value</em>, </td>

  2060.         </tr>

  2061.         <tr>

  2062.           <td class="paramkey"></td>

  2063.           <td></td>

  2064.           <td class="paramtype">char&#160;</td>

  2065.           <td class="paramname"><em>term</em>&#160;</td>

  2066.         </tr>

  2067.         <tr>

  2068.           <td></td>

  2069.           <td>)</td>

  2070.           <td></td><td></td>

  2071.         </tr>

  2072.       </table>

  2073. </div><div class="memdoc">

  2074. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2075.   <table class="params">

  2076.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2077.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2078.   </table>

  2079.   </dd>

  2080. </dl>

  2081. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2082. 

  2083. </div>

  2084. </div>

  2085. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2086. <div class="memitem">

  2087. <div class="memproto">

  2088.       <table class="memname">

  2089.         <tr>

  2090.           <td class="memname">int FatFile::printField </td>

  2091.           <td>(</td>

  2092.           <td class="paramtype">uint32_t&#160;</td>

  2093.           <td class="paramname"><em>value</em>, </td>

  2094.         </tr>

  2095.         <tr>

  2096.           <td class="paramkey"></td>

  2097.           <td></td>

  2098.           <td class="paramtype">char&#160;</td>

  2099.           <td class="paramname"><em>term</em>&#160;</td>

  2100.         </tr>

  2101.         <tr>

  2102.           <td></td>

  2103.           <td>)</td>

  2104.           <td></td><td></td>

  2105.         </tr>

  2106.       </table>

  2107. </div><div class="memdoc">

  2108. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2109.   <table class="params">

  2110.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2111.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2112.   </table>

  2113.   </dd>

  2114. </dl>

  2115. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2116. 

  2117. </div>

  2118. </div>

  2119. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2120. <div class="memitem">

  2121. <div class="memproto">

  2122.       <table class="memname">

  2123.         <tr>

  2124.           <td class="memname">size_t FatFile::printFileSize </td>

  2125.           <td>(</td>

  2126.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2127.           <td class="paramname"><em>pr</em></td><td>)</td>

  2128.           <td></td>

  2129.         </tr>

  2130.       </table>

  2131. </div><div class="memdoc">

  2132. <p>Print a file's size.</p>

  2133. <dl class="params"><dt>Parameters</dt><dd>

  2134.   <table class="params">

  2135.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2136.   </table>

  2137.   </dd>

  2138. </dl>

  2139. <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>

  2140. 

  2141. </div>

  2142. </div>

  2143. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2144. <div class="memitem">

  2145. <div class="memproto">

  2146.       <table class="memname">

  2147.         <tr>

  2148.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2149.           <td>(</td>

  2150.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2151.           <td class="paramname"><em>pr</em></td><td>)</td>

  2152.           <td></td>

  2153.         </tr>

  2154.       </table>

  2155. </div><div class="memdoc">

  2156. <p>Print a file's modify date and time</p>

  2157. <dl class="params"><dt>Parameters</dt><dd>

  2158.   <table class="params">

  2159.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2160.   </table>

  2161.   </dd>

  2162. </dl>

  2163. <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>

  2164. 

  2165. </div>

  2166. </div>

  2167. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2168. <div class="memitem">

  2169. <div class="memproto">

  2170. <table class="mlabels">

  2171.   <tr>

  2172.   <td class="mlabels-left">

  2173.       <table class="memname">

  2174.         <tr>

  2175.           <td class="memname">size_t FatFile::printName </td>

  2176.           <td>(</td>

  2177.           <td class="paramname"></td><td>)</td>

  2178.           <td></td>

  2179.         </tr>

  2180.       </table>

  2181.   </td>

  2182.   <td class="mlabels-right">

  2183. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2184.   </tr>

  2185. </table>

  2186. </div><div class="memdoc">

  2187. <p>Print a file's name.</p>

  2188. <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>

  2189. 

  2190. </div>

  2191. </div>

  2192. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2193. <div class="memitem">

  2194. <div class="memproto">

  2195.       <table class="memname">

  2196.         <tr>

  2197.           <td class="memname">size_t FatFile::printName </td>

  2198.           <td>(</td>

  2199.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2200.           <td class="paramname"><em>pr</em></td><td>)</td>

  2201.           <td></td>

  2202.         </tr>

  2203.       </table>

  2204. </div><div class="memdoc">

  2205. <p>Print a file's name</p>

  2206. <dl class="params"><dt>Parameters</dt><dd>

  2207.   <table class="params">

  2208.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2209.   </table>

  2210.   </dd>

  2211. </dl>

  2212. <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>

  2213. 

  2214. </div>

  2215. </div>

  2216. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2217. <div class="memitem">

  2218. <div class="memproto">

  2219.       <table class="memname">

  2220.         <tr>

  2221.           <td class="memname">size_t FatFile::printSFN </td>

  2222.           <td>(</td>

  2223.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2224.           <td class="paramname"><em>pr</em></td><td>)</td>

  2225.           <td></td>

  2226.         </tr>

  2227.       </table>

  2228. </div><div class="memdoc">

  2229. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2230. <dl class="params"><dt>Parameters</dt><dd>

  2231.   <table class="params">

  2232.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2233.   </table>

  2234.   </dd>

  2235. </dl>

  2236. <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>

  2237. 

  2238. </div>

  2239. </div>

  2240. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2241. <div class="memitem">

  2242. <div class="memproto">

  2243. <table class="mlabels">

  2244.   <tr>

  2245.   <td class="mlabels-left">

  2246.       <table class="memname">

  2247.         <tr>

  2248.           <td class="memname">int FatFile::read </td>

  2249.           <td>(</td>

  2250.           <td class="paramname"></td><td>)</td>

  2251.           <td></td>

  2252.         </tr>

  2253.       </table>

  2254.   </td>

  2255.   <td class="mlabels-right">

  2256. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2257.   </tr>

  2258. </table>

  2259. </div><div class="memdoc">

  2260. <p>Read the next byte from a file.</p>

  2261. <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>

  2262. 

  2263. </div>

  2264. </div>

  2265. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2266. <div class="memitem">

  2267. <div class="memproto">

  2268.       <table class="memname">

  2269.         <tr>

  2270.           <td class="memname">int FatFile::read </td>

  2271.           <td>(</td>

  2272.           <td class="paramtype">void *&#160;</td>

  2273.           <td class="paramname"><em>buf</em>, </td>

  2274.         </tr>

  2275.         <tr>

  2276.           <td class="paramkey"></td>

  2277.           <td></td>

  2278.           <td class="paramtype">size_t&#160;</td>

  2279.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2280.         </tr>

  2281.         <tr>

  2282.           <td></td>

  2283.           <td>)</td>

  2284.           <td></td><td></td>

  2285.         </tr>

  2286.       </table>

  2287. </div><div class="memdoc">

  2288. <p>Read data from a file starting at the current position.</p>

  2289. <dl class="params"><dt>Parameters</dt><dd>

  2290.   <table class="params">

  2291.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2292.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2293.   </table>

  2294.   </dd>

  2295. </dl>

  2296. <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>

  2297. 

  2298. </div>

  2299. </div>

  2300. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2301. <div class="memitem">

  2302. <div class="memproto">

  2303.       <table class="memname">

  2304.         <tr>

  2305.           <td class="memname">int8_t FatFile::readDir </td>

  2306.           <td>(</td>

  2307.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2308.           <td class="paramname"><em>dir</em></td><td>)</td>

  2309.           <td></td>

  2310.         </tr>

  2311.       </table>

  2312. </div><div class="memdoc">

  2313. <p>Read the next directory entry from a directory file.</p>

  2314. <dl class="params"><dt>Parameters</dt><dd>

  2315.   <table class="params">

  2316.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2317.   </table>

  2318.   </dd>

  2319. </dl>

  2320. <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>

  2321. 

  2322. </div>

  2323. </div>

  2324. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2325. <div class="memitem">

  2326. <div class="memproto">

  2327.       <table class="memname">

  2328.         <tr>

  2329.           <td class="memname">bool FatFile::remove </td>

  2330.           <td>(</td>

  2331.           <td class="paramname"></td><td>)</td>

  2332.           <td></td>

  2333.         </tr>

  2334.       </table>

  2335. </div><div class="memdoc">

  2336. <p>Remove a file.</p>

  2337. <p>The directory entry and all data for the file are deleted.</p>

  2338. <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>

  2339. <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>

  2340. 

  2341. </div>

  2342. </div>

  2343. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2344. <div class="memitem">

  2345. <div class="memproto">

  2346. <table class="mlabels">

  2347.   <tr>

  2348.   <td class="mlabels-left">

  2349.       <table class="memname">

  2350.         <tr>

  2351.           <td class="memname">bool FatFile::remove </td>

  2352.           <td>(</td>

  2353.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2354.           <td class="paramname"><em>dirFile</em>, </td>

  2355.         </tr>

  2356.         <tr>

  2357.           <td class="paramkey"></td>

  2358.           <td></td>

  2359.           <td class="paramtype">const char *&#160;</td>

  2360.           <td class="paramname"><em>path</em>&#160;</td>

  2361.         </tr>

  2362.         <tr>

  2363.           <td></td>

  2364.           <td>)</td>

  2365.           <td></td><td></td>

  2366.         </tr>

  2367.       </table>

  2368.   </td>

  2369.   <td class="mlabels-right">

  2370. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2371.   </tr>

  2372. </table>

  2373. </div><div class="memdoc">

  2374. <p>Remove a file.</p>

  2375. <p>The directory entry and all data for the file are deleted.</p>

  2376. <dl class="params"><dt>Parameters</dt><dd>

  2377.   <table class="params">

  2378.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2379.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2380.   </table>

  2381.   </dd>

  2382. </dl>

  2383. <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>

  2384. <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>

  2385. 

  2386. </div>

  2387. </div>

  2388. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2389. <div class="memitem">

  2390. <div class="memproto">

  2391.       <table class="memname">

  2392.         <tr>

  2393.           <td class="memname">bool FatFile::rename </td>

  2394.           <td>(</td>

  2395.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2396.           <td class="paramname"><em>dirFile</em>, </td>

  2397.         </tr>

  2398.         <tr>

  2399.           <td class="paramkey"></td>

  2400.           <td></td>

  2401.           <td class="paramtype">const char *&#160;</td>

  2402.           <td class="paramname"><em>newPath</em>&#160;</td>

  2403.         </tr>

  2404.         <tr>

  2405.           <td></td>

  2406.           <td>)</td>

  2407.           <td></td><td></td>

  2408.         </tr>

  2409.       </table>

  2410. </div><div class="memdoc">

  2411. <p>Rename a file or subdirectory.</p>

  2412. <dl class="params"><dt>Parameters</dt><dd>

  2413.   <table class="params">

  2414.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2415.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2416.   </table>

  2417.   </dd>

  2418. </dl>

  2419. <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>

  2420. 

  2421. </div>

  2422. </div>

  2423. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2424. <div class="memitem">

  2425. <div class="memproto">

  2426. <table class="mlabels">

  2427.   <tr>

  2428.   <td class="mlabels-left">

  2429.       <table class="memname">

  2430.         <tr>

  2431.           <td class="memname">void FatFile::rewind </td>

  2432.           <td>(</td>

  2433.           <td class="paramname"></td><td>)</td>

  2434.           <td></td>

  2435.         </tr>

  2436.       </table>

  2437.   </td>

  2438.   <td class="mlabels-right">

  2439. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2440.   </tr>

  2441. </table>

  2442. </div><div class="memdoc">

  2443. <p>Set the file's current position to zero. </p>

  2444. 

  2445. </div>

  2446. </div>

  2447. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2448. <div class="memitem">

  2449. <div class="memproto">

  2450.       <table class="memname">

  2451.         <tr>

  2452.           <td class="memname">bool FatFile::rmdir </td>

  2453.           <td>(</td>

  2454.           <td class="paramname"></td><td>)</td>

  2455.           <td></td>

  2456.         </tr>

  2457.       </table>

  2458. </div><div class="memdoc">

  2459. <p>Remove a directory file.</p>

  2460. <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>

  2461. <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>

  2462. <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>

  2463. 

  2464. </div>

  2465. </div>

  2466. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2467. <div class="memitem">

  2468. <div class="memproto">

  2469.       <table class="memname">

  2470.         <tr>

  2471.           <td class="memname">bool FatFile::rmRfStar </td>

  2472.           <td>(</td>

  2473.           <td class="paramname"></td><td>)</td>

  2474.           <td></td>

  2475.         </tr>

  2476.       </table>

  2477. </div><div class="memdoc">

  2478. <p>Recursively delete a directory and all contained files.</p>

  2479. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2480. <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>

  2481. <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>

  2482. <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>

  2483. 

  2484. </div>

  2485. </div>

  2486. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2487. <div class="memitem">

  2488. <div class="memproto">

  2489. <table class="mlabels">

  2490.   <tr>

  2491.   <td class="mlabels-left">

  2492.       <table class="memname">

  2493.         <tr>

  2494.           <td class="memname">bool FatFile::seekCur </td>

  2495.           <td>(</td>

  2496.           <td class="paramtype">int32_t&#160;</td>

  2497.           <td class="paramname"><em>offset</em></td><td>)</td>

  2498.           <td></td>

  2499.         </tr>

  2500.       </table>

  2501.   </td>

  2502.   <td class="mlabels-right">

  2503. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2504.   </tr>

  2505. </table>

  2506. </div><div class="memdoc">

  2507. <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>

  2508.   <table class="params">

  2509.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2510.   </table>

  2511.   </dd>

  2512. </dl>

  2513. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2514. 

  2515. </div>

  2516. </div>

  2517. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2518. <div class="memitem">

  2519. <div class="memproto">

  2520. <table class="mlabels">

  2521.   <tr>

  2522.   <td class="mlabels-left">

  2523.       <table class="memname">

  2524.         <tr>

  2525.           <td class="memname">bool FatFile::seekEnd </td>

  2526.           <td>(</td>

  2527.           <td class="paramtype">int32_t&#160;</td>

  2528.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2529.           <td></td>

  2530.         </tr>

  2531.       </table>

  2532.   </td>

  2533.   <td class="mlabels-right">

  2534. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2535.   </tr>

  2536. </table>

  2537. </div><div class="memdoc">

  2538. <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>

  2539.   <table class="params">

  2540.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2541.   </table>

  2542.   </dd>

  2543. </dl>

  2544. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2545. 

  2546. </div>

  2547. </div>

  2548. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2549. <div class="memitem">

  2550. <div class="memproto">

  2551.       <table class="memname">

  2552.         <tr>

  2553.           <td class="memname">bool FatFile::seekSet </td>

  2554.           <td>(</td>

  2555.           <td class="paramtype">uint32_t&#160;</td>

  2556.           <td class="paramname"><em>pos</em></td><td>)</td>

  2557.           <td></td>

  2558.         </tr>

  2559.       </table>

  2560. </div><div class="memdoc">

  2561. <p>Sets a file's position.</p>

  2562. <dl class="params"><dt>Parameters</dt><dd>

  2563.   <table class="params">

  2564.     <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>

  2565.   </table>

  2566.   </dd>

  2567. </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="a360ef9c05e677271bed6c0a4d663634c"></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">static bool FatFile::setCwd </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>dir</em></td><td>)</td>

  2584.           <td></td>

  2585.         </tr>

  2586.       </table>

  2587.   </td>

  2588.   <td class="mlabels-right">

  2589. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  2590.   </tr>

  2591. </table>

  2592. </div><div class="memdoc">

  2593. <p>Set the current working directory.</p>

  2594. <dl class="params"><dt>Parameters</dt><dd>

  2595.   <table class="params">

  2596.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2597.   </table>

  2598.   </dd>

  2599. </dl>

  2600. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2601. 

  2602. </div>

  2603. </div>

  2604. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2605. <div class="memitem">

  2606. <div class="memproto">

  2607.       <table class="memname">

  2608.         <tr>

  2609.           <td class="memname">void FatFile::setpos </td>

  2610.           <td>(</td>

  2611.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2612.           <td class="paramname"><em>pos</em></td><td>)</td>

  2613.           <td></td>

  2614.         </tr>

  2615.       </table>

  2616. </div><div class="memdoc">

  2617. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2618.   <table class="params">

  2619.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2620.   </table>

  2621.   </dd>

  2622. </dl>

  2623. 

  2624. </div>

  2625. </div>

  2626. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2627. <div class="memitem">

  2628. <div class="memproto">

  2629.       <table class="memname">

  2630.         <tr>

  2631.           <td class="memname">bool FatFile::sync </td>

  2632.           <td>(</td>

  2633.           <td class="paramname"></td><td>)</td>

  2634.           <td></td>

  2635.         </tr>

  2636.       </table>

  2637. </div><div class="memdoc">

  2638. <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>

  2639. <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>

  2640. 

  2641. </div>

  2642. </div>

  2643. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2644. <div class="memitem">

  2645. <div class="memproto">

  2646.       <table class="memname">

  2647.         <tr>

  2648.           <td class="memname">bool FatFile::timestamp </td>

  2649.           <td>(</td>

  2650.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2651.           <td class="paramname"><em>file</em></td><td>)</td>

  2652.           <td></td>

  2653.         </tr>

  2654.       </table>

  2655. </div><div class="memdoc">

  2656. <p>Copy a file's timestamps</p>

  2657. <dl class="params"><dt>Parameters</dt><dd>

  2658.   <table class="params">

  2659.     <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>

  2660.   </table>

  2661.   </dd>

  2662. </dl>

  2663. <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>

  2664. <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>

  2665. 

  2666. </div>

  2667. </div>

  2668. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2669. <div class="memitem">

  2670. <div class="memproto">

  2671.       <table class="memname">

  2672.         <tr>

  2673.           <td class="memname">bool FatFile::timestamp </td>

  2674.           <td>(</td>

  2675.           <td class="paramtype">uint8_t&#160;</td>

  2676.           <td class="paramname"><em>flags</em>, </td>

  2677.         </tr>

  2678.         <tr>

  2679.           <td class="paramkey"></td>

  2680.           <td></td>

  2681.           <td class="paramtype">uint16_t&#160;</td>

  2682.           <td class="paramname"><em>year</em>, </td>

  2683.         </tr>

  2684.         <tr>

  2685.           <td class="paramkey"></td>

  2686.           <td></td>

  2687.           <td class="paramtype">uint8_t&#160;</td>

  2688.           <td class="paramname"><em>month</em>, </td>

  2689.         </tr>

  2690.         <tr>

  2691.           <td class="paramkey"></td>

  2692.           <td></td>

  2693.           <td class="paramtype">uint8_t&#160;</td>

  2694.           <td class="paramname"><em>day</em>, </td>

  2695.         </tr>

  2696.         <tr>

  2697.           <td class="paramkey"></td>

  2698.           <td></td>

  2699.           <td class="paramtype">uint8_t&#160;</td>

  2700.           <td class="paramname"><em>hour</em>, </td>

  2701.         </tr>

  2702.         <tr>

  2703.           <td class="paramkey"></td>

  2704.           <td></td>

  2705.           <td class="paramtype">uint8_t&#160;</td>

  2706.           <td class="paramname"><em>minute</em>, </td>

  2707.         </tr>

  2708.         <tr>

  2709.           <td class="paramkey"></td>

  2710.           <td></td>

  2711.           <td class="paramtype">uint8_t&#160;</td>

  2712.           <td class="paramname"><em>second</em>&#160;</td>

  2713.         </tr>

  2714.         <tr>

  2715.           <td></td>

  2716.           <td>)</td>

  2717.           <td></td><td></td>

  2718.         </tr>

  2719.       </table>

  2720. </div><div class="memdoc">

  2721. <p>Set a file's timestamps in its directory entry.</p>

  2722. <dl class="params"><dt>Parameters</dt><dd>

  2723.   <table class="params">

  2724.     <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>

  2725.   </table>

  2726.   </dd>

  2727. </dl>

  2728. <p>T_ACCESS - Set the file's last access date.</p>

  2729. <p>T_CREATE - Set the file's creation date and time.</p>

  2730. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2731. <dl class="params"><dt>Parameters</dt><dd>

  2732.   <table class="params">

  2733.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2734.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2735.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2736.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2737.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2738.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2739.   </table>

  2740.   </dd>

  2741. </dl>

  2742. <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>

  2743. <dd>

  2744. 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>

  2745. <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>

  2746. 

  2747. </div>

  2748. </div>

  2749. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  2750. <div class="memitem">

  2751. <div class="memproto">

  2752.       <table class="memname">

  2753.         <tr>

  2754.           <td class="memname">bool FatFile::truncate </td>

  2755.           <td>(</td>

  2756.           <td class="paramtype">uint32_t&#160;</td>

  2757.           <td class="paramname"><em>length</em></td><td>)</td>

  2758.           <td></td>

  2759.         </tr>

  2760.       </table>

  2761. </div><div class="memdoc">

  2762. <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>

  2763. <dl class="params"><dt>Parameters</dt><dd>

  2764.   <table class="params">

  2765.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2766.   </table>

  2767.   </dd>

  2768. </dl>

  2769. <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>

  2770. 

  2771. </div>

  2772. </div>

  2773. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  2774. <div class="memitem">

  2775. <div class="memproto">

  2776. <table class="mlabels">

  2777.   <tr>

  2778.   <td class="mlabels-left">

  2779.       <table class="memname">

  2780.         <tr>

  2781.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  2782.           <td>(</td>

  2783.           <td class="paramname"></td><td>)</td>

  2784.           <td> const</td>

  2785.         </tr>

  2786.       </table>

  2787.   </td>

  2788.   <td class="mlabels-right">

  2789. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2790.   </tr>

  2791. </table>

  2792. </div><div class="memdoc">

  2793. <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>

  2794. 

  2795. </div>

  2796. </div>

  2797. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  2798. <div class="memitem">

  2799. <div class="memproto">

  2800. <table class="mlabels">

  2801.   <tr>

  2802.   <td class="mlabels-left">

  2803.       <table class="memname">

  2804.         <tr>

  2805.           <td class="memname">int FatFile::write </td>

  2806.           <td>(</td>

  2807.           <td class="paramtype">const char *&#160;</td>

  2808.           <td class="paramname"><em>str</em></td><td>)</td>

  2809.           <td></td>

  2810.         </tr>

  2811.       </table>

  2812.   </td>

  2813.   <td class="mlabels-right">

  2814. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2815.   </tr>

  2816. </table>

  2817. </div><div class="memdoc">

  2818. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2819.   <table class="params">

  2820.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2821.   </table>

  2822.   </dd>

  2823. </dl>

  2824. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2825. 

  2826. </div>

  2827. </div>

  2828. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  2829. <div class="memitem">

  2830. <div class="memproto">

  2831. <table class="mlabels">

  2832.   <tr>

  2833.   <td class="mlabels-left">

  2834.       <table class="memname">

  2835.         <tr>

  2836.           <td class="memname">int FatFile::write </td>

  2837.           <td>(</td>

  2838.           <td class="paramtype">uint8_t&#160;</td>

  2839.           <td class="paramname"><em>b</em></td><td>)</td>

  2840.           <td></td>

  2841.         </tr>

  2842.       </table>

  2843.   </td>

  2844.   <td class="mlabels-right">

  2845. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2846.   </tr>

  2847. </table>

  2848. </div><div class="memdoc">

  2849. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2850.   <table class="params">

  2851.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2852.   </table>

  2853.   </dd>

  2854. </dl>

  2855. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2856. 

  2857. </div>

  2858. </div>

  2859. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  2860. <div class="memitem">

  2861. <div class="memproto">

  2862.       <table class="memname">

  2863.         <tr>

  2864.           <td class="memname">int FatFile::write </td>

  2865.           <td>(</td>

  2866.           <td class="paramtype">const void *&#160;</td>

  2867.           <td class="paramname"><em>buf</em>, </td>

  2868.         </tr>

  2869.         <tr>

  2870.           <td class="paramkey"></td>

  2871.           <td></td>

  2872.           <td class="paramtype">size_t&#160;</td>

  2873.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2874.         </tr>

  2875.         <tr>

  2876.           <td></td>

  2877.           <td>)</td>

  2878.           <td></td><td></td>

  2879.         </tr>

  2880.       </table>

  2881. </div><div class="memdoc">

  2882. <p>Write data to an open file.</p>

  2883. <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>

  2884. <dl class="params"><dt>Parameters</dt><dd>

  2885.   <table class="params">

  2886.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2887.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  2888.   </table>

  2889.   </dd>

  2890. </dl>

  2891. <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>

  2892. 

  2893. </div>

  2894. </div>

  2895. <hr/>The documentation for this class was generated from the following files:<ul>

  2896. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  2897. <li>Arduino/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  2898. <li>Arduino/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  2899. <li>Arduino/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  2900. <li>Arduino/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  2901. </ul>

  2902. </div><!-- contents -->

  2903. <!-- start footer part -->

  2904. <hr class="footer"/><address class="footer"><small>

  2905. Generated on Sun Jul 19 2015 10:15:53 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2906. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2907. </a> 1.8.8

  2908. </small></address>

  2909. </body>

  2910. </html>