visus
/
teensy-sdfat
Beobachten 1
Favorisieren 0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
42 Commits
1 Branch
Struktur: 7871875f5c
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „7871875f5c“
${ noResults }
teensy-sdfat/extras/html/class_file.html

3586 Zeilen
157KB
Originalformat Blame Verlauf 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.10"/>

  7. <title>SdFat: File Class Reference</title>

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

  73. </div>

  74. 

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

  76. <div id="MSearchResultsWindow">

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

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

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Arduino SD.h style <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> API.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for File:</div>

  99. <div class="dyncontent">

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

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

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

  103. </map>

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

  105. <div class="dynheader">

  106. Collaboration diagram for File:</div>

  107. <div class="dyncontent">

  108. <div class="center"><img src="class_file__coll__graph.png" border="0" usemap="#_file_coll__map" alt="Collaboration graph"/></div>

  109. <map name="_file_coll__map" id="_file_coll__map">

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

  111. </map>

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

  113. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  156. <tr class="memitem:af87fa862de707575b8badd044a5af80e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#af87fa862de707575b8badd044a5af80e">flush</a> ()</td></tr>

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

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

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

  160. <tr class="memitem:aafa565e286440aab612cdb430fc01da5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aafa565e286440aab612cdb430fc01da5">getName</a> (char *<a class="el" href="class_file.html#a7ca23d8d3997c10c221977c64736f575">name</a>, size_t <a class="el" href="class_file.html#a603d3cd3319142d00a7ebd434970b017">size</a>)</td></tr>

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

  162. <tr class="memitem:aaa4f9886887947815a61eaf015996932"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aaa4f9886887947815a61eaf015996932">getpos</a> (<a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *pos)</td></tr>

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

  164. <tr class="memitem:aba30e92a66f8e0d2f815c85662772a58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aba30e92a66f8e0d2f815c85662772a58">getSFN</a> (char *<a class="el" href="class_file.html#a7ca23d8d3997c10c221977c64736f575">name</a>)</td></tr>

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

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

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

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

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

  170. <tr class="memitem:a6ba5bdb943363cda56649238ccb18c27"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a6ba5bdb943363cda56649238ccb18c27">isDirectory</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  198. <tr class="memitem:a7ca23d8d3997c10c221977c64736f575"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a7ca23d8d3997c10c221977c64736f575">name</a> () const </td></tr>

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

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

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

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

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

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

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

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

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

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

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

  210. <tr class="memitem:acd72000ab1f6a1ce73ac8fbdc854ae0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#acd72000ab1f6a1ce73ac8fbdc854ae0c">openNextFile</a> (uint8_t mode=O_READ)</td></tr>

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

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

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

  214. <tr class="memitem:af171fbf441c899cf71d88b8b0b83d38b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#af171fbf441c899cf71d88b8b0b83d38b">operator bool</a> ()</td></tr>

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

  216. <tr class="memitem:a0e5025f39bd584563bfe4b05fc1db268"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a0e5025f39bd584563bfe4b05fc1db268">peek</a> ()</td></tr>

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

  218. <tr class="memitem:aae991c597c0bc4c5eb44c1f3b06a21ec"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#aae991c597c0bc4c5eb44c1f3b06a21ec">position</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  242. <tr class="memitem:a4c46a1975e66c37977bf07c58ec10b4e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a4c46a1975e66c37977bf07c58ec10b4e">read</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  254. <tr class="memitem:ae1419603dea25a6c8480b941d7ac63a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#ae1419603dea25a6c8480b941d7ac63a3">rewindDirectory</a> ()</td></tr>

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

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

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

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

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

  260. <tr class="memitem:a2d41ea52356b769e05e1242685758c08"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a2d41ea52356b769e05e1242685758c08">seek</a> (uint32_t pos)</td></tr>

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

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

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

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

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

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

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

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

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

  270. <tr class="memitem:a603d3cd3319142d00a7ebd434970b017"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a603d3cd3319142d00a7ebd434970b017">size</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  282. <tr class="memitem:a618a6b2b7e81bfb93e0d3c158f614f90"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a618a6b2b7e81bfb93e0d3c158f614f90">write</a> (uint8_t b)</td></tr>

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

  284. <tr class="memitem:aa531c1641a2363e1f6b9d103f37433da"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#aa531c1641a2363e1f6b9d103f37433da">write</a> (const uint8_t *buf, size_t <a class="el" href="class_file.html#a603d3cd3319142d00a7ebd434970b017">size</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  299. <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 *<a class="el" href="class_file.html#a7ca23d8d3997c10c221977c64736f575">name</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  315. </table>

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

  317. <div class="textblock"><p>Arduino SD.h style <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> API. </p>

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

  319. <a class="anchor" id="a9ecb14efb960d1369926182479f56213"></a>

  320. <div class="memitem">

  321. <div class="memproto">

  322. <table class="mlabels">

  323.   <tr>

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

  325.       <table class="memname">

  326.         <tr>

  327.           <td class="memname">File::File </td>

  328.           <td>(</td>

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

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

  331.         </tr>

  332.         <tr>

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

  334.           <td></td>

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

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

  337.         </tr>

  338.         <tr>

  339.           <td></td>

  340.           <td>)</td>

  341.           <td></td><td></td>

  342.         </tr>

  343.       </table>

  344.   </td>

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

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

  347.   </tr>

  348. </table>

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

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

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

  352.   <table class="params">

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

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

  355.   </table>

  356.   </dd>

  357. </dl>

  358. 

  359. </div>

  360. </div>

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

  362. <a class="anchor" id="acf613c4e75bae85f543b30e701ebcc44"></a>

  363. <div class="memitem">

  364. <div class="memproto">

  365. <table class="mlabels">

  366.   <tr>

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

  368.       <table class="memname">

  369.         <tr>

  370.           <td class="memname">int File::available </td>

  371.           <td>(</td>

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

  373.           <td></td>

  374.         </tr>

  375.       </table>

  376.   </td>

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

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

  379.   </tr>

  380. </table>

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

  382. <dl class="section return"><dt>Returns</dt><dd>number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available. </dd></dl>

  383. 

  384. </div>

  385. </div>

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

  387. <div class="memitem">

  388. <div class="memproto">

  389. <table class="mlabels">

  390.   <tr>

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

  392.       <table class="memname">

  393.         <tr>

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

  395.           <td>(</td>

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

  397.           <td></td>

  398.         </tr>

  399.       </table>

  400.   </td>

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

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

  403.   </tr>

  404. </table>

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

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

  407. 

  408. </div>

  409. </div>

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

  411. <div class="memitem">

  412. <div class="memproto">

  413. <table class="mlabels">

  414.   <tr>

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

  416.       <table class="memname">

  417.         <tr>

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

  419.           <td>(</td>

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

  421.           <td></td>

  422.         </tr>

  423.       </table>

  424.   </td>

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

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

  427.   </tr>

  428. </table>

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

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

  431. 

  432. </div>

  433. </div>

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

  435. <div class="memitem">

  436. <div class="memproto">

  437. <table class="mlabels">

  438.   <tr>

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

  440.       <table class="memname">

  441.         <tr>

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

  443.           <td>(</td>

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

  445.           <td></td>

  446.         </tr>

  447.       </table>

  448.   </td>

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

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

  451.   </tr>

  452. </table>

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

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

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

  456. 

  457. </div>

  458. </div>

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

  460. <div class="memitem">

  461. <div class="memproto">

  462. <table class="mlabels">

  463.   <tr>

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

  465.       <table class="memname">

  466.         <tr>

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

  468.           <td>(</td>

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

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

  471.         </tr>

  472.         <tr>

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

  474.           <td></td>

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

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

  477.         </tr>

  478.         <tr>

  479.           <td></td>

  480.           <td>)</td>

  481.           <td></td><td></td>

  482.         </tr>

  483.       </table>

  484.   </td>

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

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

  487.   </tr>

  488. </table>

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

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

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

  492.   <table class="params">

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

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

  495.   </table>

  496.   </dd>

  497. </dl>

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

  499. 

  500. </div>

  501. </div>

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

  503. <div class="memitem">

  504. <div class="memproto">

  505. <table class="mlabels">

  506.   <tr>

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

  508.       <table class="memname">

  509.         <tr>

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

  511.           <td>(</td>

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

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

  514.         </tr>

  515.         <tr>

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

  517.           <td></td>

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

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

  520.         </tr>

  521.         <tr>

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

  523.           <td></td>

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

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

  526.         </tr>

  527.         <tr>

  528.           <td></td>

  529.           <td>)</td>

  530.           <td></td><td></td>

  531.         </tr>

  532.       </table>

  533.   </td>

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

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

  536.   </tr>

  537. </table>

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

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

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

  541.   <table class="params">

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

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

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

  545.   </table>

  546.   </dd>

  547. </dl>

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

  549. 

  550. </div>

  551. </div>

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

  553. <div class="memitem">

  554. <div class="memproto">

  555. <table class="mlabels">

  556.   <tr>

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

  558.       <table class="memname">

  559.         <tr>

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

  561.           <td>(</td>

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

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

  564.         </tr>

  565.         <tr>

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

  567.           <td></td>

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

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

  570.         </tr>

  571.         <tr>

  572.           <td></td>

  573.           <td>)</td>

  574.           <td></td><td></td>

  575.         </tr>

  576.       </table>

  577.   </td>

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

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

  580.   </tr>

  581. </table>

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

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

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

  585.   <table class="params">

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

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

  588.   </table>

  589.   </dd>

  590. </dl>

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

  592. 

  593. </div>

  594. </div>

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

  596. <div class="memitem">

  597. <div class="memproto">

  598. <table class="mlabels">

  599.   <tr>

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

  601.       <table class="memname">

  602.         <tr>

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

  604.           <td>(</td>

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

  606.           <td> const</td>

  607.         </tr>

  608.       </table>

  609.   </td>

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

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

  612.   </tr>

  613. </table>

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

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

  616. 

  617. </div>

  618. </div>

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

  620. <div class="memitem">

  621. <div class="memproto">

  622. <table class="mlabels">

  623.   <tr>

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

  625.       <table class="memname">

  626.         <tr>

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

  628.           <td>(</td>

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

  630.           <td> const</td>

  631.         </tr>

  632.       </table>

  633.   </td>

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

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

  636.   </tr>

  637. </table>

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

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

  640. 

  641. </div>

  642. </div>

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

  644. <div class="memitem">

  645. <div class="memproto">

  646. <table class="mlabels">

  647.   <tr>

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

  649.       <table class="memname">

  650.         <tr>

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

  652.           <td>(</td>

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

  654.           <td></td>

  655.         </tr>

  656.       </table>

  657.   </td>

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

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

  660.   </tr>

  661. </table>

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

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

  664. 

  665. </div>

  666. </div>

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

  668. <div class="memitem">

  669. <div class="memproto">

  670. <table class="mlabels">

  671.   <tr>

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

  673.       <table class="memname">

  674.         <tr>

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

  676.           <td>(</td>

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

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

  679.           <td></td>

  680.         </tr>

  681.       </table>

  682.   </td>

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

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

  685.   </tr>

  686. </table>

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

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

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

  690.   <table class="params">

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

  692.   </table>

  693.   </dd>

  694. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  709. 

  710. </div>

  711. </div>

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

  713. <div class="memitem">

  714. <div class="memproto">

  715. <table class="mlabels">

  716.   <tr>

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

  718.       <table class="memname">

  719.         <tr>

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

  721.           <td>(</td>

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

  723.           <td></td>

  724.         </tr>

  725.       </table>

  726.   </td>

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

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

  729.   </tr>

  730. </table>

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

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

  733. 

  734. </div>

  735. </div>

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

  737. <div class="memitem">

  738. <div class="memproto">

  739. <table class="mlabels">

  740.   <tr>

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

  742.       <table class="memname">

  743.         <tr>

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

  745.           <td>(</td>

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

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

  748.           <td></td>

  749.         </tr>

  750.       </table>

  751.   </td>

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

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

  754.   </tr>

  755. </table>

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

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

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

  759.   <table class="params">

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

  761.   </table>

  762.   </dd>

  763. </dl>

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

  765. 

  766. </div>

  767. </div>

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

  769. <div class="memitem">

  770. <div class="memproto">

  771. <table class="mlabels">

  772.   <tr>

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

  774.       <table class="memname">

  775.         <tr>

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

  777.           <td>(</td>

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

  779.           <td></td>

  780.         </tr>

  781.       </table>

  782.   </td>

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

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

  785.   </tr>

  786. </table>

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

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

  789. 

  790. </div>

  791. </div>

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

  793. <div class="memitem">

  794. <div class="memproto">

  795. <table class="mlabels">

  796.   <tr>

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

  798.       <table class="memname">

  799.         <tr>

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

  801.           <td>(</td>

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

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

  804.         </tr>

  805.         <tr>

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

  807.           <td></td>

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

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

  810.         </tr>

  811.         <tr>

  812.           <td></td>

  813.           <td>)</td>

  814.           <td></td><td></td>

  815.         </tr>

  816.       </table>

  817.   </td>

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

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

  820.   </tr>

  821. </table>

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

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

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

  825.   <table class="params">

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

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

  828.   </table>

  829.   </dd>

  830. </dl>

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

  832. 

  833. </div>

  834. </div>

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

  836. <div class="memitem">

  837. <div class="memproto">

  838. <table class="mlabels">

  839.   <tr>

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

  841.       <table class="memname">

  842.         <tr>

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

  844.           <td>(</td>

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

  846.           <td></td>

  847.         </tr>

  848.       </table>

  849.   </td>

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

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

  852.   </tr>

  853. </table>

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

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

  856. 

  857. </div>

  858. </div>

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

  860. <div class="memitem">

  861. <div class="memproto">

  862. <table class="mlabels">

  863.   <tr>

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

  865.       <table class="memname">

  866.         <tr>

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

  868.           <td>(</td>

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

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

  871.         </tr>

  872.         <tr>

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

  874.           <td></td>

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

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

  877.         </tr>

  878.         <tr>

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

  880.           <td></td>

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

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

  883.         </tr>

  884.         <tr>

  885.           <td></td>

  886.           <td>)</td>

  887.           <td></td><td></td>

  888.         </tr>

  889.       </table>

  890.   </td>

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

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

  893.   </tr>

  894. </table>

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

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

  897.   <table class="params">

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

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

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

  901.   </table>

  902.   </dd>

  903. </dl>

  904. 

  905. </div>

  906. </div>

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

  908. <div class="memitem">

  909. <div class="memproto">

  910. <table class="mlabels">

  911.   <tr>

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

  913.       <table class="memname">

  914.         <tr>

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

  916.           <td>(</td>

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

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

  919.           <td></td>

  920.         </tr>

  921.       </table>

  922.   </td>

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

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

  925.   </tr>

  926. </table>

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

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

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

  930.   <table class="params">

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

  932.   </table>

  933.   </dd>

  934. </dl>

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

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

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

  938. 

  939. </div>

  940. </div>

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

  942. <div class="memitem">

  943. <div class="memproto">

  944. <table class="mlabels">

  945.   <tr>

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

  947.       <table class="memname">

  948.         <tr>

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

  950.           <td>(</td>

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

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

  953.         </tr>

  954.         <tr>

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

  956.           <td></td>

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

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

  959.         </tr>

  960.         <tr>

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

  962.           <td></td>

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

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

  965.         </tr>

  966.         <tr>

  967.           <td></td>

  968.           <td>)</td>

  969.           <td></td><td></td>

  970.         </tr>

  971.       </table>

  972.   </td>

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

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

  975.   </tr>

  976. </table>

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

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

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

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

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

  982.   <table class="params">

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

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

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

  986.   </table>

  987.   </dd>

  988. </dl>

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

  990. 

  991. </div>

  992. </div>

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

  994. <div class="memitem">

  995. <div class="memproto">

  996. <table class="mlabels">

  997.   <tr>

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

  999.       <table class="memname">

  1000.         <tr>

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

  1002.           <td>(</td>

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

  1004.           <td> const</td>

  1005.         </tr>

  1006.       </table>

  1007.   </td>

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

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

  1010.   </tr>

  1011. </table>

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

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

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

  1015. 

  1016. </div>

  1017. </div>

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

  1019. <div class="memitem">

  1020. <div class="memproto">

  1021. <table class="mlabels">

  1022.   <tr>

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

  1024.       <table class="memname">

  1025.         <tr>

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

  1027.           <td>(</td>

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

  1029.           <td> const</td>

  1030.         </tr>

  1031.       </table>

  1032.   </td>

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

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

  1035.   </tr>

  1036. </table>

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

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

  1039. 

  1040. </div>

  1041. </div>

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

  1043. <div class="memitem">

  1044. <div class="memproto">

  1045. <table class="mlabels">

  1046.   <tr>

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

  1048.       <table class="memname">

  1049.         <tr>

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

  1051.           <td>(</td>

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

  1053.           <td></td>

  1054.         </tr>

  1055.       </table>

  1056.   </td>

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

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

  1059.   </tr>

  1060. </table>

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

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

  1063. 

  1064. </div>

  1065. </div>

  1066. <a class="anchor" id="a1057bc23b92a074539f661e896e79a09"></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">uint32_t FatFile::firstCluster </td>

  1075.           <td>(</td>

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

  1077.           <td> const</td>

  1078.         </tr>

  1079.       </table>

  1080.   </td>

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

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

  1083.   </tr>

  1084. </table>

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

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

  1087. 

  1088. </div>

  1089. </div>

  1090. <a class="anchor" id="af87fa862de707575b8badd044a5af80e"></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">void File::flush </td>

  1099.           <td>(</td>

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

  1101.           <td></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. <p>Ensure that any bytes written to the file are saved to the SD card. </p>

  1111. 

  1112. </div>

  1113. </div>

  1114. <a class="anchor" id="ad0dbbd083180f44c7a3ce7124d4ce19c"></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">uint8_t FatFile::getError </td>

  1123.           <td>(</td>

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

  1125.           <td></td>

  1126.         </tr>

  1127.       </table>

  1128.   </td>

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

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

  1131.   </tr>

  1132. </table>

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

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

  1135. 

  1136. </div>

  1137. </div>

  1138. <a class="anchor" id="aafa565e286440aab612cdb430fc01da5"></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::getName </td>

  1147.           <td>(</td>

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

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

  1150.         </tr>

  1151.         <tr>

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

  1153.           <td></td>

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

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

  1156.         </tr>

  1157.         <tr>

  1158.           <td></td>

  1159.           <td>)</td>

  1160.           <td></td><td></td>

  1161.         </tr>

  1162.       </table>

  1163.   </td>

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

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

  1166.   </tr>

  1167. </table>

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

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

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

  1171.   <table class="params">

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

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

  1174.   </table>

  1175.   </dd>

  1176. </dl>

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

  1178. 

  1179. </div>

  1180. </div>

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

  1182. <div class="memitem">

  1183. <div class="memproto">

  1184. <table class="mlabels">

  1185.   <tr>

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

  1187.       <table class="memname">

  1188.         <tr>

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

  1190.           <td>(</td>

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

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

  1193.           <td></td>

  1194.         </tr>

  1195.       </table>

  1196.   </td>

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

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

  1199.   </tr>

  1200. </table>

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

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

  1203.   <table class="params">

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

  1205.   </table>

  1206.   </dd>

  1207. </dl>

  1208. 

  1209. </div>

  1210. </div>

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

  1212. <div class="memitem">

  1213. <div class="memproto">

  1214. <table class="mlabels">

  1215.   <tr>

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

  1217.       <table class="memname">

  1218.         <tr>

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

  1220.           <td>(</td>

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

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

  1223.           <td></td>

  1224.         </tr>

  1225.       </table>

  1226.   </td>

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

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

  1229.   </tr>

  1230. </table>

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

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

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

  1234.   <table class="params">

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

  1236.   </table>

  1237.   </dd>

  1238. </dl>

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

  1240. 

  1241. </div>

  1242. </div>

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

  1244. <div class="memitem">

  1245. <div class="memproto">

  1246. <table class="mlabels">

  1247.   <tr>

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

  1249.       <table class="memname">

  1250.         <tr>

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

  1252.           <td>(</td>

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

  1254.           <td></td>

  1255.         </tr>

  1256.       </table>

  1257.   </td>

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

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

  1260.   </tr>

  1261. </table>

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

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

  1264. 

  1265. </div>

  1266. </div>

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

  1268. <div class="memitem">

  1269. <div class="memproto">

  1270. <table class="mlabels">

  1271.   <tr>

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

  1273.       <table class="memname">

  1274.         <tr>

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

  1276.           <td>(</td>

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

  1278.           <td> const</td>

  1279.         </tr>

  1280.       </table>

  1281.   </td>

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

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

  1284.   </tr>

  1285. </table>

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

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

  1288. 

  1289. </div>

  1290. </div>

  1291. <a class="anchor" id="a6ba5bdb943363cda56649238ccb18c27"></a>

  1292. <div class="memitem">

  1293. <div class="memproto">

  1294. <table class="mlabels">

  1295.   <tr>

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

  1297.       <table class="memname">

  1298.         <tr>

  1299.           <td class="memname">bool File::isDirectory </td>

  1300.           <td>(</td>

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

  1302.           <td></td>

  1303.         </tr>

  1304.       </table>

  1305.   </td>

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

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

  1308.   </tr>

  1309. </table>

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

  1311. <p>This function reports if the current file is a directory or not. </p><dl class="section return"><dt>Returns</dt><dd>true if the file is a directory. </dd></dl>

  1312. 

  1313. </div>

  1314. </div>

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

  1316. <div class="memitem">

  1317. <div class="memproto">

  1318. <table class="mlabels">

  1319.   <tr>

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

  1321.       <table class="memname">

  1322.         <tr>

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

  1324.           <td>(</td>

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

  1326.           <td> const</td>

  1327.         </tr>

  1328.       </table>

  1329.   </td>

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

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

  1332.   </tr>

  1333. </table>

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

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

  1336. 

  1337. </div>

  1338. </div>

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

  1340. <div class="memitem">

  1341. <div class="memproto">

  1342. <table class="mlabels">

  1343.   <tr>

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

  1345.       <table class="memname">

  1346.         <tr>

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

  1348.           <td>(</td>

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

  1350.           <td> const</td>

  1351.         </tr>

  1352.       </table>

  1353.   </td>

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

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

  1356.   </tr>

  1357. </table>

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

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

  1360. 

  1361. </div>

  1362. </div>

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

  1364. <div class="memitem">

  1365. <div class="memproto">

  1366. <table class="mlabels">

  1367.   <tr>

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

  1369.       <table class="memname">

  1370.         <tr>

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

  1372.           <td>(</td>

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

  1374.           <td> const</td>

  1375.         </tr>

  1376.       </table>

  1377.   </td>

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

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

  1380.   </tr>

  1381. </table>

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

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

  1384. 

  1385. </div>

  1386. </div>

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

  1388. <div class="memitem">

  1389. <div class="memproto">

  1390. <table class="mlabels">

  1391.   <tr>

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

  1393.       <table class="memname">

  1394.         <tr>

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

  1396.           <td>(</td>

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

  1398.           <td> const</td>

  1399.         </tr>

  1400.       </table>

  1401.   </td>

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

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

  1404.   </tr>

  1405. </table>

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

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

  1408. 

  1409. </div>

  1410. </div>

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

  1412. <div class="memitem">

  1413. <div class="memproto">

  1414. <table class="mlabels">

  1415.   <tr>

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

  1417.       <table class="memname">

  1418.         <tr>

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

  1420.           <td>(</td>

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

  1422.           <td> const</td>

  1423.         </tr>

  1424.       </table>

  1425.   </td>

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

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

  1428.   </tr>

  1429. </table>

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

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

  1432. 

  1433. </div>

  1434. </div>

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

  1436. <div class="memitem">

  1437. <div class="memproto">

  1438. <table class="mlabels">

  1439.   <tr>

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

  1441.       <table class="memname">

  1442.         <tr>

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

  1444.           <td>(</td>

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

  1446.           <td> const</td>

  1447.         </tr>

  1448.       </table>

  1449.   </td>

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

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

  1452.   </tr>

  1453. </table>

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

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

  1456. 

  1457. </div>

  1458. </div>

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

  1460. <div class="memitem">

  1461. <div class="memproto">

  1462. <table class="mlabels">

  1463.   <tr>

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

  1465.       <table class="memname">

  1466.         <tr>

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

  1468.           <td>(</td>

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

  1470.           <td> const</td>

  1471.         </tr>

  1472.       </table>

  1473.   </td>

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

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

  1476.   </tr>

  1477. </table>

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

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

  1480. 

  1481. </div>

  1482. </div>

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

  1484. <div class="memitem">

  1485. <div class="memproto">

  1486. <table class="mlabels">

  1487.   <tr>

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

  1489.       <table class="memname">

  1490.         <tr>

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

  1492.           <td>(</td>

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

  1494.           <td> const</td>

  1495.         </tr>

  1496.       </table>

  1497.   </td>

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

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

  1500.   </tr>

  1501. </table>

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

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

  1504. 

  1505. </div>

  1506. </div>

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

  1508. <div class="memitem">

  1509. <div class="memproto">

  1510. <table class="mlabels">

  1511.   <tr>

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

  1513.       <table class="memname">

  1514.         <tr>

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

  1516.           <td>(</td>

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

  1518.           <td> const</td>

  1519.         </tr>

  1520.       </table>

  1521.   </td>

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

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

  1524.   </tr>

  1525. </table>

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

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

  1528. 

  1529. </div>

  1530. </div>

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

  1532. <div class="memitem">

  1533. <div class="memproto">

  1534. <table class="mlabels">

  1535.   <tr>

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

  1537.       <table class="memname">

  1538.         <tr>

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

  1540.           <td>(</td>

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

  1542.           <td> const</td>

  1543.         </tr>

  1544.       </table>

  1545.   </td>

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

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

  1548.   </tr>

  1549. </table>

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

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

  1552. 

  1553. </div>

  1554. </div>

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

  1556. <div class="memitem">

  1557. <div class="memproto">

  1558. <table class="mlabels">

  1559.   <tr>

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

  1561.       <table class="memname">

  1562.         <tr>

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

  1564.           <td>(</td>

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

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

  1567.           <td></td>

  1568.         </tr>

  1569.       </table>

  1570.   </td>

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

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

  1573.   </tr>

  1574. </table>

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

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

  1577.   <table class="params">

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

  1579.   </table>

  1580.   </dd>

  1581. </dl>

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

  1583. 

  1584. </div>

  1585. </div>

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

  1587. <div class="memitem">

  1588. <div class="memproto">

  1589. <table class="mlabels">

  1590.   <tr>

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

  1592.       <table class="memname">

  1593.         <tr>

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

  1595.           <td>(</td>

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

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

  1598.           <td></td>

  1599.         </tr>

  1600.       </table>

  1601.   </td>

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

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

  1604.   </tr>

  1605. </table>

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

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

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

  1609.   <table class="params">

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

  1611.   </table>

  1612.   </dd>

  1613. </dl>

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

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

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

  1617. 

  1618. </div>

  1619. </div>

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

  1621. <div class="memitem">

  1622. <div class="memproto">

  1623. <table class="mlabels">

  1624.   <tr>

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

  1626.       <table class="memname">

  1627.         <tr>

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

  1629.           <td>(</td>

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

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

  1632.         </tr>

  1633.         <tr>

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

  1635.           <td></td>

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

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

  1638.         </tr>

  1639.         <tr>

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

  1641.           <td></td>

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

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

  1644.         </tr>

  1645.         <tr>

  1646.           <td></td>

  1647.           <td>)</td>

  1648.           <td></td><td></td>

  1649.         </tr>

  1650.       </table>

  1651.   </td>

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

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

  1654.   </tr>

  1655. </table>

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

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

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

  1659.   <table class="params">

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

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

  1662.   </table>

  1663.   </dd>

  1664. </dl>

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

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

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

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

  1669.   <table class="params">

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

  1671.   </table>

  1672.   </dd>

  1673. </dl>

  1674. 

  1675. </div>

  1676. </div>

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

  1678. <div class="memitem">

  1679. <div class="memproto">

  1680. <table class="mlabels">

  1681.   <tr>

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

  1683.       <table class="memname">

  1684.         <tr>

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

  1686.           <td>(</td>

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

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

  1689.         </tr>

  1690.         <tr>

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

  1692.           <td></td>

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

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

  1695.         </tr>

  1696.         <tr>

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

  1698.           <td></td>

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

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

  1701.         </tr>

  1702.         <tr>

  1703.           <td></td>

  1704.           <td>)</td>

  1705.           <td></td><td></td>

  1706.         </tr>

  1707.       </table>

  1708.   </td>

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

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

  1711.   </tr>

  1712. </table>

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

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

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

  1716.   <table class="params">

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

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

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

  1720.   </table>

  1721.   </dd>

  1722. </dl>

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

  1724. 

  1725. </div>

  1726. </div>

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

  1728. <div class="memitem">

  1729. <div class="memproto">

  1730. <table class="mlabels">

  1731.   <tr>

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

  1733.       <table class="memname">

  1734.         <tr>

  1735.           <td class="memname">const char* File::name </td>

  1736.           <td>(</td>

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

  1738.           <td> const</td>

  1739.         </tr>

  1740.       </table>

  1741.   </td>

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

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

  1744.   </tr>

  1745. </table>

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

  1747. <p>No longer implemented due to Long <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Names.</p>

  1748. <p>Use <a class="el" href="class_fat_file.html#aafa565e286440aab612cdb430fc01da5">getName(char* name, size_t size)</a>. </p><dl class="section return"><dt>Returns</dt><dd>a pointer to replacement suggestion. </dd></dl>

  1749. 

  1750. </div>

  1751. </div>

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

  1753. <div class="memitem">

  1754. <div class="memproto">

  1755. <table class="mlabels">

  1756.   <tr>

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

  1758.       <table class="memname">

  1759.         <tr>

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

  1761.           <td>(</td>

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

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

  1764.         </tr>

  1765.         <tr>

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

  1767.           <td></td>

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

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

  1770.         </tr>

  1771.         <tr>

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

  1773.           <td></td>

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

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

  1776.         </tr>

  1777.         <tr>

  1778.           <td></td>

  1779.           <td>)</td>

  1780.           <td></td><td></td>

  1781.         </tr>

  1782.       </table>

  1783.   </td>

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

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

  1786.   </tr>

  1787. </table>

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

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

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

  1791.   <table class="params">

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

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

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

  1795.   </table>

  1796.   </dd>

  1797. </dl>

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

  1799. 

  1800. </div>

  1801. </div>

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

  1803. <div class="memitem">

  1804. <div class="memproto">

  1805. <table class="mlabels">

  1806.   <tr>

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

  1808.       <table class="memname">

  1809.         <tr>

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

  1811.           <td>(</td>

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

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

  1814.         </tr>

  1815.         <tr>

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

  1817.           <td></td>

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

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

  1820.         </tr>

  1821.         <tr>

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

  1823.           <td></td>

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

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

  1826.         </tr>

  1827.         <tr>

  1828.           <td></td>

  1829.           <td>)</td>

  1830.           <td></td><td></td>

  1831.         </tr>

  1832.       </table>

  1833.   </td>

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

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

  1836.   </tr>

  1837. </table>

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

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

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

  1841.   <table class="params">

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

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

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

  1845.   </table>

  1846.   </dd>

  1847. </dl>

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

  1849. 

  1850. </div>

  1851. </div>

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

  1853. <div class="memitem">

  1854. <div class="memproto">

  1855. <table class="mlabels">

  1856.   <tr>

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

  1858.       <table class="memname">

  1859.         <tr>

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

  1861.           <td>(</td>

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

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

  1864.         </tr>

  1865.         <tr>

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

  1867.           <td></td>

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

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

  1870.         </tr>

  1871.         <tr>

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

  1873.           <td></td>

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

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

  1876.         </tr>

  1877.         <tr>

  1878.           <td></td>

  1879.           <td>)</td>

  1880.           <td></td><td></td>

  1881.         </tr>

  1882.       </table>

  1883.   </td>

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

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

  1886.   </tr>

  1887. </table>

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

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

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

  1891.   <table class="params">

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

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

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

  1895.   </table>

  1896.   </dd>

  1897. </dl>

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

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

  1900. <p>O_WRITE - Open for writing.</p>

  1901. <p>O_WRONLY - Same as O_WRITE.</p>

  1902. <p>O_RDWR - Open for reading and writing.</p>

  1903. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1904. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1905. <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>

  1906. <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>

  1907. <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>

  1908. <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>

  1909. <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>

  1910. <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>

  1911. <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>

  1912. 

  1913. </div>

  1914. </div>

  1915. <a class="anchor" id="ab0e7075062c89f356441f80fc64d03e6"></a>

  1916. <div class="memitem">

  1917. <div class="memproto">

  1918. <table class="mlabels">

  1919.   <tr>

  1920.   <td class="mlabels-left">

  1921.       <table class="memname">

  1922.         <tr>

  1923.           <td class="memname">bool FatFile::open </td>

  1924.           <td>(</td>

  1925.           <td class="paramtype">const char *&#160;</td>

  1926.           <td class="paramname"><em>path</em>, </td>

  1927.         </tr>

  1928.         <tr>

  1929.           <td class="paramkey"></td>

  1930.           <td></td>

  1931.           <td class="paramtype">uint8_t&#160;</td>

  1932.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1933.         </tr>

  1934.         <tr>

  1935.           <td></td>

  1936.           <td>)</td>

  1937.           <td></td><td></td>

  1938.         </tr>

  1939.       </table>

  1940.   </td>

  1941.   <td class="mlabels-right">

  1942. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1943.   </tr>

  1944. </table>

  1945. </div><div class="memdoc">

  1946. <p>Open a file in the current working directory.</p>

  1947. <dl class="params"><dt>Parameters</dt><dd>

  1948.   <table class="params">

  1949.     <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>

  1950.     <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>

  1951.   </table>

  1952.   </dd>

  1953. </dl>

  1954. <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>

  1955. 

  1956. </div>

  1957. </div>

  1958. <a class="anchor" id="a8034c4649eb0d26715b1a8a69e73d9d0"></a>

  1959. <div class="memitem">

  1960. <div class="memproto">

  1961. <table class="mlabels">

  1962.   <tr>

  1963.   <td class="mlabels-left">

  1964.       <table class="memname">

  1965.         <tr>

  1966.           <td class="memname">bool FatFile::openNext </td>

  1967.           <td>(</td>

  1968.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1969.           <td class="paramname"><em>dirFile</em>, </td>

  1970.         </tr>

  1971.         <tr>

  1972.           <td class="paramkey"></td>

  1973.           <td></td>

  1974.           <td class="paramtype">uint8_t&#160;</td>

  1975.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1976.         </tr>

  1977.         <tr>

  1978.           <td></td>

  1979.           <td>)</td>

  1980.           <td></td><td></td>

  1981.         </tr>

  1982.       </table>

  1983.   </td>

  1984.   <td class="mlabels-right">

  1985. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1986.   </tr>

  1987. </table>

  1988. </div><div class="memdoc">

  1989. <p>Open the next file or subdirectory in a directory.</p>

  1990. <dl class="params"><dt>Parameters</dt><dd>

  1991.   <table class="params">

  1992.     <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>

  1993.     <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>

  1994.   </table>

  1995.   </dd>

  1996. </dl>

  1997. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1998. 

  1999. </div>

  2000. </div>

  2001. <a class="anchor" id="acd72000ab1f6a1ce73ac8fbdc854ae0c"></a>

  2002. <div class="memitem">

  2003. <div class="memproto">

  2004. <table class="mlabels">

  2005.   <tr>

  2006.   <td class="mlabels-left">

  2007.       <table class="memname">

  2008.         <tr>

  2009.           <td class="memname"><a class="el" href="class_file.html">File</a> File::openNextFile </td>

  2010.           <td>(</td>

  2011.           <td class="paramtype">uint8_t&#160;</td>

  2012.           <td class="paramname"><em>mode</em> = <code>O_READ</code></td><td>)</td>

  2013.           <td></td>

  2014.         </tr>

  2015.       </table>

  2016.   </td>

  2017.   <td class="mlabels-right">

  2018. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2019.   </tr>

  2020. </table>

  2021. </div><div class="memdoc">

  2022. <p>Opens the next file or folder in a directory.</p>

  2023. <dl class="params"><dt>Parameters</dt><dd>

  2024.   <table class="params">

  2025.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>

  2026.   </table>

  2027.   </dd>

  2028. </dl>

  2029. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>

  2030. 

  2031. </div>

  2032. </div>

  2033. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  2034. <div class="memitem">

  2035. <div class="memproto">

  2036. <table class="mlabels">

  2037.   <tr>

  2038.   <td class="mlabels-left">

  2039.       <table class="memname">

  2040.         <tr>

  2041.           <td class="memname">bool FatFile::openRoot </td>

  2042.           <td>(</td>

  2043.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  2044.           <td class="paramname"><em>vol</em></td><td>)</td>

  2045.           <td></td>

  2046.         </tr>

  2047.       </table>

  2048.   </td>

  2049.   <td class="mlabels-right">

  2050. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2051.   </tr>

  2052. </table>

  2053. </div><div class="memdoc">

  2054. <p>Open a volume's root directory.</p>

  2055. <dl class="params"><dt>Parameters</dt><dd>

  2056.   <table class="params">

  2057.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  2058.   </table>

  2059.   </dd>

  2060. </dl>

  2061. <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>

  2062. 

  2063. </div>

  2064. </div>

  2065. <a class="anchor" id="af171fbf441c899cf71d88b8b0b83d38b"></a>

  2066. <div class="memitem">

  2067. <div class="memproto">

  2068. <table class="mlabels">

  2069.   <tr>

  2070.   <td class="mlabels-left">

  2071.       <table class="memname">

  2072.         <tr>

  2073.           <td class="memname">File::operator bool </td>

  2074.           <td>(</td>

  2075.           <td class="paramname"></td><td>)</td>

  2076.           <td></td>

  2077.         </tr>

  2078.       </table>

  2079.   </td>

  2080.   <td class="mlabels-right">

  2081. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2082.   </tr>

  2083. </table>

  2084. </div><div class="memdoc">

  2085. <p>The parenthesis operator.</p>

  2086. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2087. 

  2088. </div>

  2089. </div>

  2090. <a class="anchor" id="a0e5025f39bd584563bfe4b05fc1db268"></a>

  2091. <div class="memitem">

  2092. <div class="memproto">

  2093. <table class="mlabels">

  2094.   <tr>

  2095.   <td class="mlabels-left">

  2096.       <table class="memname">

  2097.         <tr>

  2098.           <td class="memname">int File::peek </td>

  2099.           <td>(</td>

  2100.           <td class="paramname"></td><td>)</td>

  2101.           <td></td>

  2102.         </tr>

  2103.       </table>

  2104.   </td>

  2105.   <td class="mlabels-right">

  2106. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2107.   </tr>

  2108. </table>

  2109. </div><div class="memdoc">

  2110. <p>Return the next available byte without consuming it.</p>

  2111. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2112. 

  2113. </div>

  2114. </div>

  2115. <a class="anchor" id="aae991c597c0bc4c5eb44c1f3b06a21ec"></a>

  2116. <div class="memitem">

  2117. <div class="memproto">

  2118. <table class="mlabels">

  2119.   <tr>

  2120.   <td class="mlabels-left">

  2121.       <table class="memname">

  2122.         <tr>

  2123.           <td class="memname">uint32_t File::position </td>

  2124.           <td>(</td>

  2125.           <td class="paramname"></td><td>)</td>

  2126.           <td></td>

  2127.         </tr>

  2128.       </table>

  2129.   </td>

  2130.   <td class="mlabels-right">

  2131. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2132.   </tr>

  2133. </table>

  2134. </div><div class="memdoc">

  2135. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2136. 

  2137. </div>

  2138. </div>

  2139. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  2140. <div class="memitem">

  2141. <div class="memproto">

  2142. <table class="mlabels">

  2143.   <tr>

  2144.   <td class="mlabels-left">

  2145.       <table class="memname">

  2146.         <tr>

  2147.           <td class="memname">bool FatFile::printCreateDateTime </td>

  2148.           <td>(</td>

  2149.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2150.           <td class="paramname"><em>pr</em></td><td>)</td>

  2151.           <td></td>

  2152.         </tr>

  2153.       </table>

  2154.   </td>

  2155.   <td class="mlabels-right">

  2156. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2157.   </tr>

  2158. </table>

  2159. </div><div class="memdoc">

  2160. <p>Print a file's creation date and time</p>

  2161. <dl class="params"><dt>Parameters</dt><dd>

  2162.   <table class="params">

  2163.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2164.   </table>

  2165.   </dd>

  2166. </dl>

  2167. <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>

  2168. 

  2169. </div>

  2170. </div>

  2171. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  2172. <div class="memitem">

  2173. <div class="memproto">

  2174. <table class="mlabels">

  2175.   <tr>

  2176.   <td class="mlabels-left">

  2177.       <table class="memname">

  2178.         <tr>

  2179.           <td class="memname">static void FatFile::printFatDate </td>

  2180.           <td>(</td>

  2181.           <td class="paramtype">uint16_t&#160;</td>

  2182.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  2183.           <td></td>

  2184.         </tr>

  2185.       </table>

  2186.   </td>

  2187.   <td class="mlabels-right">

  2188. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2189.   </tr>

  2190. </table>

  2191. </div><div class="memdoc">

  2192. <p>Print a directory date field.</p>

  2193. <p>Format is yyyy-mm-dd.</p>

  2194. <dl class="params"><dt>Parameters</dt><dd>

  2195.   <table class="params">

  2196.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2197.   </table>

  2198.   </dd>

  2199. </dl>

  2200. 

  2201. </div>

  2202. </div>

  2203. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  2204. <div class="memitem">

  2205. <div class="memproto">

  2206. <table class="mlabels">

  2207.   <tr>

  2208.   <td class="mlabels-left">

  2209.       <table class="memname">

  2210.         <tr>

  2211.           <td class="memname">void FatFile::printFatDate </td>

  2212.           <td>(</td>

  2213.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2214.           <td class="paramname"><em>pr</em>, </td>

  2215.         </tr>

  2216.         <tr>

  2217.           <td class="paramkey"></td>

  2218.           <td></td>

  2219.           <td class="paramtype">uint16_t&#160;</td>

  2220.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2221.         </tr>

  2222.         <tr>

  2223.           <td></td>

  2224.           <td>)</td>

  2225.           <td></td><td></td>

  2226.         </tr>

  2227.       </table>

  2228.   </td>

  2229.   <td class="mlabels-right">

  2230. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2231.   </tr>

  2232. </table>

  2233. </div><div class="memdoc">

  2234. <p>Print a directory date field.</p>

  2235. <p>Format is yyyy-mm-dd.</p>

  2236. <dl class="params"><dt>Parameters</dt><dd>

  2237.   <table class="params">

  2238.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2239.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2240.   </table>

  2241.   </dd>

  2242. </dl>

  2243. 

  2244. </div>

  2245. </div>

  2246. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2247. <div class="memitem">

  2248. <div class="memproto">

  2249. <table class="mlabels">

  2250.   <tr>

  2251.   <td class="mlabels-left">

  2252.       <table class="memname">

  2253.         <tr>

  2254.           <td class="memname">static void FatFile::printFatTime </td>

  2255.           <td>(</td>

  2256.           <td class="paramtype">uint16_t&#160;</td>

  2257.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2258.           <td></td>

  2259.         </tr>

  2260.       </table>

  2261.   </td>

  2262.   <td class="mlabels-right">

  2263. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2264.   </tr>

  2265. </table>

  2266. </div><div class="memdoc">

  2267. <p>Print a directory time field.</p>

  2268. <p>Format is hh:mm:ss.</p>

  2269. <dl class="params"><dt>Parameters</dt><dd>

  2270.   <table class="params">

  2271.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2272.   </table>

  2273.   </dd>

  2274. </dl>

  2275. 

  2276. </div>

  2277. </div>

  2278. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2279. <div class="memitem">

  2280. <div class="memproto">

  2281. <table class="mlabels">

  2282.   <tr>

  2283.   <td class="mlabels-left">

  2284.       <table class="memname">

  2285.         <tr>

  2286.           <td class="memname">void FatFile::printFatTime </td>

  2287.           <td>(</td>

  2288.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2289.           <td class="paramname"><em>pr</em>, </td>

  2290.         </tr>

  2291.         <tr>

  2292.           <td class="paramkey"></td>

  2293.           <td></td>

  2294.           <td class="paramtype">uint16_t&#160;</td>

  2295.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2296.         </tr>

  2297.         <tr>

  2298.           <td></td>

  2299.           <td>)</td>

  2300.           <td></td><td></td>

  2301.         </tr>

  2302.       </table>

  2303.   </td>

  2304.   <td class="mlabels-right">

  2305. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2306.   </tr>

  2307. </table>

  2308. </div><div class="memdoc">

  2309. <p>Print a directory time field.</p>

  2310. <p>Format is hh:mm:ss.</p>

  2311. <dl class="params"><dt>Parameters</dt><dd>

  2312.   <table class="params">

  2313.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2314.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2315.   </table>

  2316.   </dd>

  2317. </dl>

  2318. 

  2319. </div>

  2320. </div>

  2321. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2322. <div class="memitem">

  2323. <div class="memproto">

  2324. <table class="mlabels">

  2325.   <tr>

  2326.   <td class="mlabels-left">

  2327.       <table class="memname">

  2328.         <tr>

  2329.           <td class="memname">int FatFile::printField </td>

  2330.           <td>(</td>

  2331.           <td class="paramtype">float&#160;</td>

  2332.           <td class="paramname"><em>value</em>, </td>

  2333.         </tr>

  2334.         <tr>

  2335.           <td class="paramkey"></td>

  2336.           <td></td>

  2337.           <td class="paramtype">char&#160;</td>

  2338.           <td class="paramname"><em>term</em>, </td>

  2339.         </tr>

  2340.         <tr>

  2341.           <td class="paramkey"></td>

  2342.           <td></td>

  2343.           <td class="paramtype">uint8_t&#160;</td>

  2344.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2345.         </tr>

  2346.         <tr>

  2347.           <td></td>

  2348.           <td>)</td>

  2349.           <td></td><td></td>

  2350.         </tr>

  2351.       </table>

  2352.   </td>

  2353.   <td class="mlabels-right">

  2354. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2355.   </tr>

  2356. </table>

  2357. </div><div class="memdoc">

  2358. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2359.   <table class="params">

  2360.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2361.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2362.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2363.   </table>

  2364.   </dd>

  2365. </dl>

  2366. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2367. 

  2368. </div>

  2369. </div>

  2370. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2371. <div class="memitem">

  2372. <div class="memproto">

  2373. <table class="mlabels">

  2374.   <tr>

  2375.   <td class="mlabels-left">

  2376.       <table class="memname">

  2377.         <tr>

  2378.           <td class="memname">int FatFile::printField </td>

  2379.           <td>(</td>

  2380.           <td class="paramtype">int16_t&#160;</td>

  2381.           <td class="paramname"><em>value</em>, </td>

  2382.         </tr>

  2383.         <tr>

  2384.           <td class="paramkey"></td>

  2385.           <td></td>

  2386.           <td class="paramtype">char&#160;</td>

  2387.           <td class="paramname"><em>term</em>&#160;</td>

  2388.         </tr>

  2389.         <tr>

  2390.           <td></td>

  2391.           <td>)</td>

  2392.           <td></td><td></td>

  2393.         </tr>

  2394.       </table>

  2395.   </td>

  2396.   <td class="mlabels-right">

  2397. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2398.   </tr>

  2399. </table>

  2400. </div><div class="memdoc">

  2401. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2402.   <table class="params">

  2403.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2404.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2405.   </table>

  2406.   </dd>

  2407. </dl>

  2408. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2409. 

  2410. </div>

  2411. </div>

  2412. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2413. <div class="memitem">

  2414. <div class="memproto">

  2415. <table class="mlabels">

  2416.   <tr>

  2417.   <td class="mlabels-left">

  2418.       <table class="memname">

  2419.         <tr>

  2420.           <td class="memname">int FatFile::printField </td>

  2421.           <td>(</td>

  2422.           <td class="paramtype">uint16_t&#160;</td>

  2423.           <td class="paramname"><em>value</em>, </td>

  2424.         </tr>

  2425.         <tr>

  2426.           <td class="paramkey"></td>

  2427.           <td></td>

  2428.           <td class="paramtype">char&#160;</td>

  2429.           <td class="paramname"><em>term</em>&#160;</td>

  2430.         </tr>

  2431.         <tr>

  2432.           <td></td>

  2433.           <td>)</td>

  2434.           <td></td><td></td>

  2435.         </tr>

  2436.       </table>

  2437.   </td>

  2438.   <td class="mlabels-right">

  2439. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2440.   </tr>

  2441. </table>

  2442. </div><div class="memdoc">

  2443. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2444.   <table class="params">

  2445.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2446.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2447.   </table>

  2448.   </dd>

  2449. </dl>

  2450. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2451. 

  2452. </div>

  2453. </div>

  2454. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2455. <div class="memitem">

  2456. <div class="memproto">

  2457. <table class="mlabels">

  2458.   <tr>

  2459.   <td class="mlabels-left">

  2460.       <table class="memname">

  2461.         <tr>

  2462.           <td class="memname">int FatFile::printField </td>

  2463.           <td>(</td>

  2464.           <td class="paramtype">int32_t&#160;</td>

  2465.           <td class="paramname"><em>value</em>, </td>

  2466.         </tr>

  2467.         <tr>

  2468.           <td class="paramkey"></td>

  2469.           <td></td>

  2470.           <td class="paramtype">char&#160;</td>

  2471.           <td class="paramname"><em>term</em>&#160;</td>

  2472.         </tr>

  2473.         <tr>

  2474.           <td></td>

  2475.           <td>)</td>

  2476.           <td></td><td></td>

  2477.         </tr>

  2478.       </table>

  2479.   </td>

  2480.   <td class="mlabels-right">

  2481. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2482.   </tr>

  2483. </table>

  2484. </div><div class="memdoc">

  2485. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2486.   <table class="params">

  2487.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2488.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2489.   </table>

  2490.   </dd>

  2491. </dl>

  2492. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2493. 

  2494. </div>

  2495. </div>

  2496. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2497. <div class="memitem">

  2498. <div class="memproto">

  2499. <table class="mlabels">

  2500.   <tr>

  2501.   <td class="mlabels-left">

  2502.       <table class="memname">

  2503.         <tr>

  2504.           <td class="memname">int FatFile::printField </td>

  2505.           <td>(</td>

  2506.           <td class="paramtype">uint32_t&#160;</td>

  2507.           <td class="paramname"><em>value</em>, </td>

  2508.         </tr>

  2509.         <tr>

  2510.           <td class="paramkey"></td>

  2511.           <td></td>

  2512.           <td class="paramtype">char&#160;</td>

  2513.           <td class="paramname"><em>term</em>&#160;</td>

  2514.         </tr>

  2515.         <tr>

  2516.           <td></td>

  2517.           <td>)</td>

  2518.           <td></td><td></td>

  2519.         </tr>

  2520.       </table>

  2521.   </td>

  2522.   <td class="mlabels-right">

  2523. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2524.   </tr>

  2525. </table>

  2526. </div><div class="memdoc">

  2527. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2528.   <table class="params">

  2529.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2530.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2531.   </table>

  2532.   </dd>

  2533. </dl>

  2534. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2535. 

  2536. </div>

  2537. </div>

  2538. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2539. <div class="memitem">

  2540. <div class="memproto">

  2541. <table class="mlabels">

  2542.   <tr>

  2543.   <td class="mlabels-left">

  2544.       <table class="memname">

  2545.         <tr>

  2546.           <td class="memname">size_t FatFile::printFileSize </td>

  2547.           <td>(</td>

  2548.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2549.           <td class="paramname"><em>pr</em></td><td>)</td>

  2550.           <td></td>

  2551.         </tr>

  2552.       </table>

  2553.   </td>

  2554.   <td class="mlabels-right">

  2555. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2556.   </tr>

  2557. </table>

  2558. </div><div class="memdoc">

  2559. <p>Print a file's size.</p>

  2560. <dl class="params"><dt>Parameters</dt><dd>

  2561.   <table class="params">

  2562.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2563.   </table>

  2564.   </dd>

  2565. </dl>

  2566. <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>

  2567. 

  2568. </div>

  2569. </div>

  2570. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2571. <div class="memitem">

  2572. <div class="memproto">

  2573. <table class="mlabels">

  2574.   <tr>

  2575.   <td class="mlabels-left">

  2576.       <table class="memname">

  2577.         <tr>

  2578.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2579.           <td>(</td>

  2580.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2581.           <td class="paramname"><em>pr</em></td><td>)</td>

  2582.           <td></td>

  2583.         </tr>

  2584.       </table>

  2585.   </td>

  2586.   <td class="mlabels-right">

  2587. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2588.   </tr>

  2589. </table>

  2590. </div><div class="memdoc">

  2591. <p>Print a file's modify date and time</p>

  2592. <dl class="params"><dt>Parameters</dt><dd>

  2593.   <table class="params">

  2594.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2595.   </table>

  2596.   </dd>

  2597. </dl>

  2598. <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>

  2599. 

  2600. </div>

  2601. </div>

  2602. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2603. <div class="memitem">

  2604. <div class="memproto">

  2605. <table class="mlabels">

  2606.   <tr>

  2607.   <td class="mlabels-left">

  2608.       <table class="memname">

  2609.         <tr>

  2610.           <td class="memname">size_t FatFile::printName </td>

  2611.           <td>(</td>

  2612.           <td class="paramname"></td><td>)</td>

  2613.           <td></td>

  2614.         </tr>

  2615.       </table>

  2616.   </td>

  2617.   <td class="mlabels-right">

  2618. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2619.   </tr>

  2620. </table>

  2621. </div><div class="memdoc">

  2622. <p>Print a file's name.</p>

  2623. <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>

  2624. 

  2625. </div>

  2626. </div>

  2627. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2628. <div class="memitem">

  2629. <div class="memproto">

  2630. <table class="mlabels">

  2631.   <tr>

  2632.   <td class="mlabels-left">

  2633.       <table class="memname">

  2634.         <tr>

  2635.           <td class="memname">size_t FatFile::printName </td>

  2636.           <td>(</td>

  2637.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2638.           <td class="paramname"><em>pr</em></td><td>)</td>

  2639.           <td></td>

  2640.         </tr>

  2641.       </table>

  2642.   </td>

  2643.   <td class="mlabels-right">

  2644. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2645.   </tr>

  2646. </table>

  2647. </div><div class="memdoc">

  2648. <p>Print a file's name</p>

  2649. <dl class="params"><dt>Parameters</dt><dd>

  2650.   <table class="params">

  2651.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2652.   </table>

  2653.   </dd>

  2654. </dl>

  2655. <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>

  2656. 

  2657. </div>

  2658. </div>

  2659. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2660. <div class="memitem">

  2661. <div class="memproto">

  2662. <table class="mlabels">

  2663.   <tr>

  2664.   <td class="mlabels-left">

  2665.       <table class="memname">

  2666.         <tr>

  2667.           <td class="memname">size_t FatFile::printSFN </td>

  2668.           <td>(</td>

  2669.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2670.           <td class="paramname"><em>pr</em></td><td>)</td>

  2671.           <td></td>

  2672.         </tr>

  2673.       </table>

  2674.   </td>

  2675.   <td class="mlabels-right">

  2676. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2677.   </tr>

  2678. </table>

  2679. </div><div class="memdoc">

  2680. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2681. <dl class="params"><dt>Parameters</dt><dd>

  2682.   <table class="params">

  2683.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2684.   </table>

  2685.   </dd>

  2686. </dl>

  2687. <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>

  2688. 

  2689. </div>

  2690. </div>

  2691. <a class="anchor" id="a4c46a1975e66c37977bf07c58ec10b4e"></a>

  2692. <div class="memitem">

  2693. <div class="memproto">

  2694. <table class="mlabels">

  2695.   <tr>

  2696.   <td class="mlabels-left">

  2697.       <table class="memname">

  2698.         <tr>

  2699.           <td class="memname">int File::read </td>

  2700.           <td>(</td>

  2701.           <td class="paramname"></td><td>)</td>

  2702.           <td></td>

  2703.         </tr>

  2704.       </table>

  2705.   </td>

  2706.   <td class="mlabels-right">

  2707. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2708.   </tr>

  2709. </table>

  2710. </div><div class="memdoc">

  2711. <p>Read the next byte from a file.</p>

  2712. <dl class="section return"><dt>Returns</dt><dd>For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1. </dd></dl>

  2713. 

  2714. </div>

  2715. </div>

  2716. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2717. <div class="memitem">

  2718. <div class="memproto">

  2719. <table class="mlabels">

  2720.   <tr>

  2721.   <td class="mlabels-left">

  2722.       <table class="memname">

  2723.         <tr>

  2724.           <td class="memname">int FatFile::read </td>

  2725.           <td>(</td>

  2726.           <td class="paramtype">void *&#160;</td>

  2727.           <td class="paramname"><em>buf</em>, </td>

  2728.         </tr>

  2729.         <tr>

  2730.           <td class="paramkey"></td>

  2731.           <td></td>

  2732.           <td class="paramtype">size_t&#160;</td>

  2733.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2734.         </tr>

  2735.         <tr>

  2736.           <td></td>

  2737.           <td>)</td>

  2738.           <td></td><td></td>

  2739.         </tr>

  2740.       </table>

  2741.   </td>

  2742.   <td class="mlabels-right">

  2743. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2744.   </tr>

  2745. </table>

  2746. </div><div class="memdoc">

  2747. <p>Read data from a file starting at the current position.</p>

  2748. <dl class="params"><dt>Parameters</dt><dd>

  2749.   <table class="params">

  2750.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2751.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2752.   </table>

  2753.   </dd>

  2754. </dl>

  2755. <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>

  2756. 

  2757. </div>

  2758. </div>

  2759. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2760. <div class="memitem">

  2761. <div class="memproto">

  2762. <table class="mlabels">

  2763.   <tr>

  2764.   <td class="mlabels-left">

  2765.       <table class="memname">

  2766.         <tr>

  2767.           <td class="memname">int8_t FatFile::readDir </td>

  2768.           <td>(</td>

  2769.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2770.           <td class="paramname"><em>dir</em></td><td>)</td>

  2771.           <td></td>

  2772.         </tr>

  2773.       </table>

  2774.   </td>

  2775.   <td class="mlabels-right">

  2776. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2777.   </tr>

  2778. </table>

  2779. </div><div class="memdoc">

  2780. <p>Read the next directory entry from a directory file.</p>

  2781. <dl class="params"><dt>Parameters</dt><dd>

  2782.   <table class="params">

  2783.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2784.   </table>

  2785.   </dd>

  2786. </dl>

  2787. <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>

  2788. 

  2789. </div>

  2790. </div>

  2791. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2792. <div class="memitem">

  2793. <div class="memproto">

  2794. <table class="mlabels">

  2795.   <tr>

  2796.   <td class="mlabels-left">

  2797.       <table class="memname">

  2798.         <tr>

  2799.           <td class="memname">bool FatFile::remove </td>

  2800.           <td>(</td>

  2801.           <td class="paramname"></td><td>)</td>

  2802.           <td></td>

  2803.         </tr>

  2804.       </table>

  2805.   </td>

  2806.   <td class="mlabels-right">

  2807. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2808.   </tr>

  2809. </table>

  2810. </div><div class="memdoc">

  2811. <p>Remove a file.</p>

  2812. <p>The directory entry and all data for the file are deleted.</p>

  2813. <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>

  2814. <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>

  2815. 

  2816. </div>

  2817. </div>

  2818. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2819. <div class="memitem">

  2820. <div class="memproto">

  2821. <table class="mlabels">

  2822.   <tr>

  2823.   <td class="mlabels-left">

  2824.       <table class="memname">

  2825.         <tr>

  2826.           <td class="memname">bool FatFile::remove </td>

  2827.           <td>(</td>

  2828.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2829.           <td class="paramname"><em>dirFile</em>, </td>

  2830.         </tr>

  2831.         <tr>

  2832.           <td class="paramkey"></td>

  2833.           <td></td>

  2834.           <td class="paramtype">const char *&#160;</td>

  2835.           <td class="paramname"><em>path</em>&#160;</td>

  2836.         </tr>

  2837.         <tr>

  2838.           <td></td>

  2839.           <td>)</td>

  2840.           <td></td><td></td>

  2841.         </tr>

  2842.       </table>

  2843.   </td>

  2844.   <td class="mlabels-right">

  2845. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2846.   </tr>

  2847. </table>

  2848. </div><div class="memdoc">

  2849. <p>Remove a file.</p>

  2850. <p>The directory entry and all data for the file are deleted.</p>

  2851. <dl class="params"><dt>Parameters</dt><dd>

  2852.   <table class="params">

  2853.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2854.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2855.   </table>

  2856.   </dd>

  2857. </dl>

  2858. <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>

  2859. <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>

  2860. 

  2861. </div>

  2862. </div>

  2863. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2864. <div class="memitem">

  2865. <div class="memproto">

  2866. <table class="mlabels">

  2867.   <tr>

  2868.   <td class="mlabels-left">

  2869.       <table class="memname">

  2870.         <tr>

  2871.           <td class="memname">bool FatFile::rename </td>

  2872.           <td>(</td>

  2873.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2874.           <td class="paramname"><em>dirFile</em>, </td>

  2875.         </tr>

  2876.         <tr>

  2877.           <td class="paramkey"></td>

  2878.           <td></td>

  2879.           <td class="paramtype">const char *&#160;</td>

  2880.           <td class="paramname"><em>newPath</em>&#160;</td>

  2881.         </tr>

  2882.         <tr>

  2883.           <td></td>

  2884.           <td>)</td>

  2885.           <td></td><td></td>

  2886.         </tr>

  2887.       </table>

  2888.   </td>

  2889.   <td class="mlabels-right">

  2890. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2891.   </tr>

  2892. </table>

  2893. </div><div class="memdoc">

  2894. <p>Rename a file or subdirectory.</p>

  2895. <dl class="params"><dt>Parameters</dt><dd>

  2896.   <table class="params">

  2897.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2898.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2899.   </table>

  2900.   </dd>

  2901. </dl>

  2902. <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>

  2903. 

  2904. </div>

  2905. </div>

  2906. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2907. <div class="memitem">

  2908. <div class="memproto">

  2909. <table class="mlabels">

  2910.   <tr>

  2911.   <td class="mlabels-left">

  2912.       <table class="memname">

  2913.         <tr>

  2914.           <td class="memname">void FatFile::rewind </td>

  2915.           <td>(</td>

  2916.           <td class="paramname"></td><td>)</td>

  2917.           <td></td>

  2918.         </tr>

  2919.       </table>

  2920.   </td>

  2921.   <td class="mlabels-right">

  2922. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2923.   </tr>

  2924. </table>

  2925. </div><div class="memdoc">

  2926. <p>Set the file's current position to zero. </p>

  2927. 

  2928. </div>

  2929. </div>

  2930. <a class="anchor" id="ae1419603dea25a6c8480b941d7ac63a3"></a>

  2931. <div class="memitem">

  2932. <div class="memproto">

  2933. <table class="mlabels">

  2934.   <tr>

  2935.   <td class="mlabels-left">

  2936.       <table class="memname">

  2937.         <tr>

  2938.           <td class="memname">void File::rewindDirectory </td>

  2939.           <td>(</td>

  2940.           <td class="paramname"></td><td>)</td>

  2941.           <td></td>

  2942.         </tr>

  2943.       </table>

  2944.   </td>

  2945.   <td class="mlabels-right">

  2946. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2947.   </tr>

  2948. </table>

  2949. </div><div class="memdoc">

  2950. <p>Rewind a file if it is a directory </p>

  2951. 

  2952. </div>

  2953. </div>

  2954. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2955. <div class="memitem">

  2956. <div class="memproto">

  2957. <table class="mlabels">

  2958.   <tr>

  2959.   <td class="mlabels-left">

  2960.       <table class="memname">

  2961.         <tr>

  2962.           <td class="memname">bool FatFile::rmdir </td>

  2963.           <td>(</td>

  2964.           <td class="paramname"></td><td>)</td>

  2965.           <td></td>

  2966.         </tr>

  2967.       </table>

  2968.   </td>

  2969.   <td class="mlabels-right">

  2970. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2971.   </tr>

  2972. </table>

  2973. </div><div class="memdoc">

  2974. <p>Remove a directory file.</p>

  2975. <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>

  2976. <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>

  2977. <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>

  2978. 

  2979. </div>

  2980. </div>

  2981. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2982. <div class="memitem">

  2983. <div class="memproto">

  2984. <table class="mlabels">

  2985.   <tr>

  2986.   <td class="mlabels-left">

  2987.       <table class="memname">

  2988.         <tr>

  2989.           <td class="memname">bool FatFile::rmRfStar </td>

  2990.           <td>(</td>

  2991.           <td class="paramname"></td><td>)</td>

  2992.           <td></td>

  2993.         </tr>

  2994.       </table>

  2995.   </td>

  2996.   <td class="mlabels-right">

  2997. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2998.   </tr>

  2999. </table>

  3000. </div><div class="memdoc">

  3001. <p>Recursively delete a directory and all contained files.</p>

  3002. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  3003. <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>

  3004. <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>

  3005. <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>

  3006. 

  3007. </div>

  3008. </div>

  3009. <a class="anchor" id="a2d41ea52356b769e05e1242685758c08"></a>

  3010. <div class="memitem">

  3011. <div class="memproto">

  3012. <table class="mlabels">

  3013.   <tr>

  3014.   <td class="mlabels-left">

  3015.       <table class="memname">

  3016.         <tr>

  3017.           <td class="memname">bool File::seek </td>

  3018.           <td>(</td>

  3019.           <td class="paramtype">uint32_t&#160;</td>

  3020.           <td class="paramname"><em>pos</em></td><td>)</td>

  3021.           <td></td>

  3022.         </tr>

  3023.       </table>

  3024.   </td>

  3025.   <td class="mlabels-right">

  3026. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3027.   </tr>

  3028. </table>

  3029. </div><div class="memdoc">

  3030. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  3031. <dl class="params"><dt>Parameters</dt><dd>

  3032.   <table class="params">

  3033.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  3034.   </table>

  3035.   </dd>

  3036. </dl>

  3037. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  3038. 

  3039. </div>

  3040. </div>

  3041. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  3042. <div class="memitem">

  3043. <div class="memproto">

  3044. <table class="mlabels">

  3045.   <tr>

  3046.   <td class="mlabels-left">

  3047.       <table class="memname">

  3048.         <tr>

  3049.           <td class="memname">bool FatFile::seekCur </td>

  3050.           <td>(</td>

  3051.           <td class="paramtype">int32_t&#160;</td>

  3052.           <td class="paramname"><em>offset</em></td><td>)</td>

  3053.           <td></td>

  3054.         </tr>

  3055.       </table>

  3056.   </td>

  3057.   <td class="mlabels-right">

  3058. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3059.   </tr>

  3060. </table>

  3061. </div><div class="memdoc">

  3062. <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>

  3063.   <table class="params">

  3064.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  3065.   </table>

  3066.   </dd>

  3067. </dl>

  3068. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3069. 

  3070. </div>

  3071. </div>

  3072. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3073. <div class="memitem">

  3074. <div class="memproto">

  3075. <table class="mlabels">

  3076.   <tr>

  3077.   <td class="mlabels-left">

  3078.       <table class="memname">

  3079.         <tr>

  3080.           <td class="memname">bool FatFile::seekEnd </td>

  3081.           <td>(</td>

  3082.           <td class="paramtype">int32_t&#160;</td>

  3083.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3084.           <td></td>

  3085.         </tr>

  3086.       </table>

  3087.   </td>

  3088.   <td class="mlabels-right">

  3089. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3090.   </tr>

  3091. </table>

  3092. </div><div class="memdoc">

  3093. <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>

  3094.   <table class="params">

  3095.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3096.   </table>

  3097.   </dd>

  3098. </dl>

  3099. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3100. 

  3101. </div>

  3102. </div>

  3103. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3104. <div class="memitem">

  3105. <div class="memproto">

  3106. <table class="mlabels">

  3107.   <tr>

  3108.   <td class="mlabels-left">

  3109.       <table class="memname">

  3110.         <tr>

  3111.           <td class="memname">bool FatFile::seekSet </td>

  3112.           <td>(</td>

  3113.           <td class="paramtype">uint32_t&#160;</td>

  3114.           <td class="paramname"><em>pos</em></td><td>)</td>

  3115.           <td></td>

  3116.         </tr>

  3117.       </table>

  3118.   </td>

  3119.   <td class="mlabels-right">

  3120. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3121.   </tr>

  3122. </table>

  3123. </div><div class="memdoc">

  3124. <p>Sets a file's position.</p>

  3125. <dl class="params"><dt>Parameters</dt><dd>

  3126.   <table class="params">

  3127.     <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>

  3128.   </table>

  3129.   </dd>

  3130. </dl>

  3131. <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>

  3132. 

  3133. </div>

  3134. </div>

  3135. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  3136. <div class="memitem">

  3137. <div class="memproto">

  3138. <table class="mlabels">

  3139.   <tr>

  3140.   <td class="mlabels-left">

  3141.       <table class="memname">

  3142.         <tr>

  3143.           <td class="memname">static bool FatFile::setCwd </td>

  3144.           <td>(</td>

  3145.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3146.           <td class="paramname"><em>dir</em></td><td>)</td>

  3147.           <td></td>

  3148.         </tr>

  3149.       </table>

  3150.   </td>

  3151.   <td class="mlabels-right">

  3152. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  3153.   </tr>

  3154. </table>

  3155. </div><div class="memdoc">

  3156. <p>Set the current working directory.</p>

  3157. <dl class="params"><dt>Parameters</dt><dd>

  3158.   <table class="params">

  3159.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  3160.   </table>

  3161.   </dd>

  3162. </dl>

  3163. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  3164. 

  3165. </div>

  3166. </div>

  3167. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  3168. <div class="memitem">

  3169. <div class="memproto">

  3170. <table class="mlabels">

  3171.   <tr>

  3172.   <td class="mlabels-left">

  3173.       <table class="memname">

  3174.         <tr>

  3175.           <td class="memname">void FatFile::setpos </td>

  3176.           <td>(</td>

  3177.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  3178.           <td class="paramname"><em>pos</em></td><td>)</td>

  3179.           <td></td>

  3180.         </tr>

  3181.       </table>

  3182.   </td>

  3183.   <td class="mlabels-right">

  3184. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3185.   </tr>

  3186. </table>

  3187. </div><div class="memdoc">

  3188. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  3189.   <table class="params">

  3190.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  3191.   </table>

  3192.   </dd>

  3193. </dl>

  3194. 

  3195. </div>

  3196. </div>

  3197. <a class="anchor" id="a603d3cd3319142d00a7ebd434970b017"></a>

  3198. <div class="memitem">

  3199. <div class="memproto">

  3200. <table class="mlabels">

  3201.   <tr>

  3202.   <td class="mlabels-left">

  3203.       <table class="memname">

  3204.         <tr>

  3205.           <td class="memname">uint32_t File::size </td>

  3206.           <td>(</td>

  3207.           <td class="paramname"></td><td>)</td>

  3208.           <td></td>

  3209.         </tr>

  3210.       </table>

  3211.   </td>

  3212.   <td class="mlabels-right">

  3213. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3214.   </tr>

  3215. </table>

  3216. </div><div class="memdoc">

  3217. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3218. 

  3219. </div>

  3220. </div>

  3221. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  3222. <div class="memitem">

  3223. <div class="memproto">

  3224. <table class="mlabels">

  3225.   <tr>

  3226.   <td class="mlabels-left">

  3227.       <table class="memname">

  3228.         <tr>

  3229.           <td class="memname">bool FatFile::sync </td>

  3230.           <td>(</td>

  3231.           <td class="paramname"></td><td>)</td>

  3232.           <td></td>

  3233.         </tr>

  3234.       </table>

  3235.   </td>

  3236.   <td class="mlabels-right">

  3237. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3238.   </tr>

  3239. </table>

  3240. </div><div class="memdoc">

  3241. <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>

  3242. <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>

  3243. 

  3244. </div>

  3245. </div>

  3246. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  3247. <div class="memitem">

  3248. <div class="memproto">

  3249. <table class="mlabels">

  3250.   <tr>

  3251.   <td class="mlabels-left">

  3252.       <table class="memname">

  3253.         <tr>

  3254.           <td class="memname">bool FatFile::timestamp </td>

  3255.           <td>(</td>

  3256.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3257.           <td class="paramname"><em>file</em></td><td>)</td>

  3258.           <td></td>

  3259.         </tr>

  3260.       </table>

  3261.   </td>

  3262.   <td class="mlabels-right">

  3263. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3264.   </tr>

  3265. </table>

  3266. </div><div class="memdoc">

  3267. <p>Copy a file's timestamps</p>

  3268. <dl class="params"><dt>Parameters</dt><dd>

  3269.   <table class="params">

  3270.     <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>

  3271.   </table>

  3272.   </dd>

  3273. </dl>

  3274. <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>

  3275. <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>

  3276. 

  3277. </div>

  3278. </div>

  3279. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3280. <div class="memitem">

  3281. <div class="memproto">

  3282. <table class="mlabels">

  3283.   <tr>

  3284.   <td class="mlabels-left">

  3285.       <table class="memname">

  3286.         <tr>

  3287.           <td class="memname">bool FatFile::timestamp </td>

  3288.           <td>(</td>

  3289.           <td class="paramtype">uint8_t&#160;</td>

  3290.           <td class="paramname"><em>flags</em>, </td>

  3291.         </tr>

  3292.         <tr>

  3293.           <td class="paramkey"></td>

  3294.           <td></td>

  3295.           <td class="paramtype">uint16_t&#160;</td>

  3296.           <td class="paramname"><em>year</em>, </td>

  3297.         </tr>

  3298.         <tr>

  3299.           <td class="paramkey"></td>

  3300.           <td></td>

  3301.           <td class="paramtype">uint8_t&#160;</td>

  3302.           <td class="paramname"><em>month</em>, </td>

  3303.         </tr>

  3304.         <tr>

  3305.           <td class="paramkey"></td>

  3306.           <td></td>

  3307.           <td class="paramtype">uint8_t&#160;</td>

  3308.           <td class="paramname"><em>day</em>, </td>

  3309.         </tr>

  3310.         <tr>

  3311.           <td class="paramkey"></td>

  3312.           <td></td>

  3313.           <td class="paramtype">uint8_t&#160;</td>

  3314.           <td class="paramname"><em>hour</em>, </td>

  3315.         </tr>

  3316.         <tr>

  3317.           <td class="paramkey"></td>

  3318.           <td></td>

  3319.           <td class="paramtype">uint8_t&#160;</td>

  3320.           <td class="paramname"><em>minute</em>, </td>

  3321.         </tr>

  3322.         <tr>

  3323.           <td class="paramkey"></td>

  3324.           <td></td>

  3325.           <td class="paramtype">uint8_t&#160;</td>

  3326.           <td class="paramname"><em>second</em>&#160;</td>

  3327.         </tr>

  3328.         <tr>

  3329.           <td></td>

  3330.           <td>)</td>

  3331.           <td></td><td></td>

  3332.         </tr>

  3333.       </table>

  3334.   </td>

  3335.   <td class="mlabels-right">

  3336. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3337.   </tr>

  3338. </table>

  3339. </div><div class="memdoc">

  3340. <p>Set a file's timestamps in its directory entry.</p>

  3341. <dl class="params"><dt>Parameters</dt><dd>

  3342.   <table class="params">

  3343.     <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>

  3344.   </table>

  3345.   </dd>

  3346. </dl>

  3347. <p>T_ACCESS - Set the file's last access date.</p>

  3348. <p>T_CREATE - Set the file's creation date and time.</p>

  3349. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3350. <dl class="params"><dt>Parameters</dt><dd>

  3351.   <table class="params">

  3352.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3353.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3354.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3355.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3356.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3357.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3358.   </table>

  3359.   </dd>

  3360. </dl>

  3361. <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>

  3362. <dd>

  3363. 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>

  3364. <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>

  3365. 

  3366. </div>

  3367. </div>

  3368. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3369. <div class="memitem">

  3370. <div class="memproto">

  3371. <table class="mlabels">

  3372.   <tr>

  3373.   <td class="mlabels-left">

  3374.       <table class="memname">

  3375.         <tr>

  3376.           <td class="memname">bool FatFile::truncate </td>

  3377.           <td>(</td>

  3378.           <td class="paramtype">uint32_t&#160;</td>

  3379.           <td class="paramname"><em>length</em></td><td>)</td>

  3380.           <td></td>

  3381.         </tr>

  3382.       </table>

  3383.   </td>

  3384.   <td class="mlabels-right">

  3385. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3386.   </tr>

  3387. </table>

  3388. </div><div class="memdoc">

  3389. <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>

  3390. <dl class="params"><dt>Parameters</dt><dd>

  3391.   <table class="params">

  3392.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3393.   </table>

  3394.   </dd>

  3395. </dl>

  3396. <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>

  3397. 

  3398. </div>

  3399. </div>

  3400. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3401. <div class="memitem">

  3402. <div class="memproto">

  3403. <table class="mlabels">

  3404.   <tr>

  3405.   <td class="mlabels-left">

  3406.       <table class="memname">

  3407.         <tr>

  3408.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3409.           <td>(</td>

  3410.           <td class="paramname"></td><td>)</td>

  3411.           <td> const</td>

  3412.         </tr>

  3413.       </table>

  3414.   </td>

  3415.   <td class="mlabels-right">

  3416. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3417.   </tr>

  3418. </table>

  3419. </div><div class="memdoc">

  3420. <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>

  3421. 

  3422. </div>

  3423. </div>

  3424. <a class="anchor" id="a618a6b2b7e81bfb93e0d3c158f614f90"></a>

  3425. <div class="memitem">

  3426. <div class="memproto">

  3427. <table class="mlabels">

  3428.   <tr>

  3429.   <td class="mlabels-left">

  3430.       <table class="memname">

  3431.         <tr>

  3432.           <td class="memname">size_t File::write </td>

  3433.           <td>(</td>

  3434.           <td class="paramtype">uint8_t&#160;</td>

  3435.           <td class="paramname"><em>b</em></td><td>)</td>

  3436.           <td></td>

  3437.         </tr>

  3438.       </table>

  3439.   </td>

  3440.   <td class="mlabels-right">

  3441. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3442.   </tr>

  3443. </table>

  3444. </div><div class="memdoc">

  3445. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3446.   <table class="params">

  3447.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>the byte to be written. Use getWriteError to check for errors. </td></tr>

  3448.   </table>

  3449.   </dd>

  3450. </dl>

  3451. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3452. 

  3453. </div>

  3454. </div>

  3455. <a class="anchor" id="aa531c1641a2363e1f6b9d103f37433da"></a>

  3456. <div class="memitem">

  3457. <div class="memproto">

  3458. <table class="mlabels">

  3459.   <tr>

  3460.   <td class="mlabels-left">

  3461.       <table class="memname">

  3462.         <tr>

  3463.           <td class="memname">size_t File::write </td>

  3464.           <td>(</td>

  3465.           <td class="paramtype">const uint8_t *&#160;</td>

  3466.           <td class="paramname"><em>buf</em>, </td>

  3467.         </tr>

  3468.         <tr>

  3469.           <td class="paramkey"></td>

  3470.           <td></td>

  3471.           <td class="paramtype">size_t&#160;</td>

  3472.           <td class="paramname"><em>size</em>&#160;</td>

  3473.         </tr>

  3474.         <tr>

  3475.           <td></td>

  3476.           <td>)</td>

  3477.           <td></td><td></td>

  3478.         </tr>

  3479.       </table>

  3480.   </td>

  3481.   <td class="mlabels-right">

  3482. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3483.   </tr>

  3484. </table>

  3485. </div><div class="memdoc">

  3486. <p>Write data to an open file. Form required by Print.</p>

  3487. <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>

  3488. <dl class="params"><dt>Parameters</dt><dd>

  3489.   <table class="params">

  3490.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3491.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3492.   </table>

  3493.   </dd>

  3494. </dl>

  3495. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_file.html#a618a6b2b7e81bfb93e0d3c158f614f90">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_file.html#a618a6b2b7e81bfb93e0d3c158f614f90">write()</a> returns -1. Possible errors include <a class="el" href="class_file.html#a618a6b2b7e81bfb93e0d3c158f614f90">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>

  3496. 

  3497. </div>

  3498. </div>

  3499. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3500. <div class="memitem">

  3501. <div class="memproto">

  3502. <table class="mlabels">

  3503.   <tr>

  3504.   <td class="mlabels-left">

  3505.       <table class="memname">

  3506.         <tr>

  3507.           <td class="memname">int FatFile::write </td>

  3508.           <td>(</td>

  3509.           <td class="paramtype">const char *&#160;</td>

  3510.           <td class="paramname"><em>str</em></td><td>)</td>

  3511.           <td></td>

  3512.         </tr>

  3513.       </table>

  3514.   </td>

  3515.   <td class="mlabels-right">

  3516. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3517.   </tr>

  3518. </table>

  3519. </div><div class="memdoc">

  3520. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3521.   <table class="params">

  3522.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3523.   </table>

  3524.   </dd>

  3525. </dl>

  3526. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3527. 

  3528. </div>

  3529. </div>

  3530. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3531. <div class="memitem">

  3532. <div class="memproto">

  3533. <table class="mlabels">

  3534.   <tr>

  3535.   <td class="mlabels-left">

  3536.       <table class="memname">

  3537.         <tr>

  3538.           <td class="memname">int FatFile::write </td>

  3539.           <td>(</td>

  3540.           <td class="paramtype">const void *&#160;</td>

  3541.           <td class="paramname"><em>buf</em>, </td>

  3542.         </tr>

  3543.         <tr>

  3544.           <td class="paramkey"></td>

  3545.           <td></td>

  3546.           <td class="paramtype">size_t&#160;</td>

  3547.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3548.         </tr>

  3549.         <tr>

  3550.           <td></td>

  3551.           <td>)</td>

  3552.           <td></td><td></td>

  3553.         </tr>

  3554.       </table>

  3555.   </td>

  3556.   <td class="mlabels-right">

  3557. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3558.   </tr>

  3559. </table>

  3560. </div><div class="memdoc">

  3561. <p>Write data to an open file.</p>

  3562. <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>

  3563. <dl class="params"><dt>Parameters</dt><dd>

  3564.   <table class="params">

  3565.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3566.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3567.   </table>

  3568.   </dd>

  3569. </dl>

  3570. <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>

  3571. 

  3572. </div>

  3573. </div>

  3574. <hr/>The documentation for this class was generated from the following file:<ul>

  3575. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_arduino_files_8h.html">ArduinoFiles.h</a></li>

  3576. </ul>

  3577. </div><!-- contents -->

  3578. <!-- start footer part -->

  3579. <hr class="footer"/><address class="footer"><small>

  3580. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3581. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3582. </a> 1.8.10

  3583. </small></address>

  3584. </body>

  3585. </html>