visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
26 Commits
1 Branch
Tree: 6ac05353a6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6ac05353a6'
${ noResults }
teensy-sdfat/html/class_file.html

3516 lines
154KB
Raw Blame History 

  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><a href="modules.html"><span>Modules</span></a></li>

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

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

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

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

  89.   <div class="headertitle">

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

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

  92. <div class="contents">

  93. 

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

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

  96. 

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

  98. <div class="dynheader">

  99. Inheritance diagram for File:</div>

  100. <div class="dyncontent">

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

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

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

  104. </map>

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

  106. <div class="dynheader">

  107. Collaboration diagram for File:</div>

  108. <div class="dyncontent">

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

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

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

  112. </map>

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

  114. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  312. </table>

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

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

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

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

  317. <div class="memitem">

  318. <div class="memproto">

  319. <table class="mlabels">

  320.   <tr>

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

  322.       <table class="memname">

  323.         <tr>

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

  325.           <td>(</td>

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

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

  328.         </tr>

  329.         <tr>

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

  331.           <td></td>

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

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

  334.         </tr>

  335.         <tr>

  336.           <td></td>

  337.           <td>)</td>

  338.           <td></td><td></td>

  339.         </tr>

  340.       </table>

  341.   </td>

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

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

  344.   </tr>

  345. </table>

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

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

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

  349.   <table class="params">

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

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

  352.   </table>

  353.   </dd>

  354. </dl>

  355. 

  356. </div>

  357. </div>

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

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

  360. <div class="memitem">

  361. <div class="memproto">

  362. <table class="mlabels">

  363.   <tr>

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

  365.       <table class="memname">

  366.         <tr>

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

  368.           <td>(</td>

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

  370.           <td></td>

  371.         </tr>

  372.       </table>

  373.   </td>

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

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

  376.   </tr>

  377. </table>

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

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

  380. 

  381. </div>

  382. </div>

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

  384. <div class="memitem">

  385. <div class="memproto">

  386. <table class="mlabels">

  387.   <tr>

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

  389.       <table class="memname">

  390.         <tr>

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

  392.           <td>(</td>

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

  394.           <td></td>

  395.         </tr>

  396.       </table>

  397.   </td>

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

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

  400.   </tr>

  401. </table>

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

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

  404. 

  405. </div>

  406. </div>

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

  408. <div class="memitem">

  409. <div class="memproto">

  410. <table class="mlabels">

  411.   <tr>

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

  413.       <table class="memname">

  414.         <tr>

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

  416.           <td>(</td>

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

  418.           <td></td>

  419.         </tr>

  420.       </table>

  421.   </td>

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

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

  424.   </tr>

  425. </table>

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

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

  428. 

  429. </div>

  430. </div>

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

  432. <div class="memitem">

  433. <div class="memproto">

  434. <table class="mlabels">

  435.   <tr>

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

  437.       <table class="memname">

  438.         <tr>

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

  440.           <td>(</td>

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

  442.           <td></td>

  443.         </tr>

  444.       </table>

  445.   </td>

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

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

  448.   </tr>

  449. </table>

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

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

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

  453. 

  454. </div>

  455. </div>

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

  457. <div class="memitem">

  458. <div class="memproto">

  459. <table class="mlabels">

  460.   <tr>

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

  462.       <table class="memname">

  463.         <tr>

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

  465.           <td>(</td>

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

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

  468.         </tr>

  469.         <tr>

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

  471.           <td></td>

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

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

  474.         </tr>

  475.         <tr>

  476.           <td></td>

  477.           <td>)</td>

  478.           <td></td><td></td>

  479.         </tr>

  480.       </table>

  481.   </td>

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

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

  484.   </tr>

  485. </table>

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

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

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

  489.   <table class="params">

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

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

  492.   </table>

  493.   </dd>

  494. </dl>

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

  496. 

  497. </div>

  498. </div>

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

  500. <div class="memitem">

  501. <div class="memproto">

  502. <table class="mlabels">

  503.   <tr>

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

  505.       <table class="memname">

  506.         <tr>

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

  508.           <td>(</td>

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

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

  511.         </tr>

  512.         <tr>

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

  514.           <td></td>

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

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

  517.         </tr>

  518.         <tr>

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

  520.           <td></td>

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

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

  523.         </tr>

  524.         <tr>

  525.           <td></td>

  526.           <td>)</td>

  527.           <td></td><td></td>

  528.         </tr>

  529.       </table>

  530.   </td>

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

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

  533.   </tr>

  534. </table>

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

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

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

  538.   <table class="params">

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

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

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

  542.   </table>

  543.   </dd>

  544. </dl>

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

  546. 

  547. </div>

  548. </div>

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

  550. <div class="memitem">

  551. <div class="memproto">

  552. <table class="mlabels">

  553.   <tr>

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

  555.       <table class="memname">

  556.         <tr>

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

  558.           <td>(</td>

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

  560.           <td> const</td>

  561.         </tr>

  562.       </table>

  563.   </td>

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

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

  566.   </tr>

  567. </table>

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

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

  570. 

  571. </div>

  572. </div>

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

  574. <div class="memitem">

  575. <div class="memproto">

  576. <table class="mlabels">

  577.   <tr>

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

  579.       <table class="memname">

  580.         <tr>

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

  582.           <td>(</td>

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

  584.           <td> const</td>

  585.         </tr>

  586.       </table>

  587.   </td>

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

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

  590.   </tr>

  591. </table>

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

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

  594. 

  595. </div>

  596. </div>

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

  598. <div class="memitem">

  599. <div class="memproto">

  600. <table class="mlabels">

  601.   <tr>

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

  603.       <table class="memname">

  604.         <tr>

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

  606.           <td>(</td>

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

  608.           <td></td>

  609.         </tr>

  610.       </table>

  611.   </td>

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

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

  614.   </tr>

  615. </table>

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

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

  618. 

  619. </div>

  620. </div>

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

  622. <div class="memitem">

  623. <div class="memproto">

  624. <table class="mlabels">

  625.   <tr>

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

  627.       <table class="memname">

  628.         <tr>

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

  630.           <td>(</td>

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

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

  633.           <td></td>

  634.         </tr>

  635.       </table>

  636.   </td>

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

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

  639.   </tr>

  640. </table>

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

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

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

  644.   <table class="params">

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

  646.   </table>

  647.   </dd>

  648. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  663. 

  664. </div>

  665. </div>

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

  667. <div class="memitem">

  668. <div class="memproto">

  669. <table class="mlabels">

  670.   <tr>

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

  672.       <table class="memname">

  673.         <tr>

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

  675.           <td>(</td>

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

  677.           <td></td>

  678.         </tr>

  679.       </table>

  680.   </td>

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

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

  683.   </tr>

  684. </table>

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

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

  687. 

  688. </div>

  689. </div>

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

  691. <div class="memitem">

  692. <div class="memproto">

  693. <table class="mlabels">

  694.   <tr>

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

  696.       <table class="memname">

  697.         <tr>

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

  699.           <td>(</td>

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

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

  702.           <td></td>

  703.         </tr>

  704.       </table>

  705.   </td>

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

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

  708.   </tr>

  709. </table>

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

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

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

  713.   <table class="params">

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

  715.   </table>

  716.   </dd>

  717. </dl>

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

  719. 

  720. </div>

  721. </div>

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

  723. <div class="memitem">

  724. <div class="memproto">

  725. <table class="mlabels">

  726.   <tr>

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

  728.       <table class="memname">

  729.         <tr>

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

  731.           <td>(</td>

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

  733.           <td></td>

  734.         </tr>

  735.       </table>

  736.   </td>

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

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

  739.   </tr>

  740. </table>

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

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

  743. 

  744. </div>

  745. </div>

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

  747. <div class="memitem">

  748. <div class="memproto">

  749. <table class="mlabels">

  750.   <tr>

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

  752.       <table class="memname">

  753.         <tr>

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

  755.           <td>(</td>

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

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

  758.         </tr>

  759.         <tr>

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

  761.           <td></td>

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

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

  764.         </tr>

  765.         <tr>

  766.           <td></td>

  767.           <td>)</td>

  768.           <td></td><td></td>

  769.         </tr>

  770.       </table>

  771.   </td>

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

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

  774.   </tr>

  775. </table>

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

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

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

  779.   <table class="params">

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

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

  782.   </table>

  783.   </dd>

  784. </dl>

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

  786. 

  787. </div>

  788. </div>

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

  790. <div class="memitem">

  791. <div class="memproto">

  792. <table class="mlabels">

  793.   <tr>

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

  795.       <table class="memname">

  796.         <tr>

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

  798.           <td>(</td>

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

  800.           <td></td>

  801.         </tr>

  802.       </table>

  803.   </td>

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

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

  806.   </tr>

  807. </table>

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

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

  810. 

  811. </div>

  812. </div>

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

  814. <div class="memitem">

  815. <div class="memproto">

  816. <table class="mlabels">

  817.   <tr>

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

  819.       <table class="memname">

  820.         <tr>

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

  822.           <td>(</td>

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

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

  825.         </tr>

  826.         <tr>

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

  828.           <td></td>

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

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

  831.         </tr>

  832.         <tr>

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

  834.           <td></td>

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

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

  837.         </tr>

  838.         <tr>

  839.           <td></td>

  840.           <td>)</td>

  841.           <td></td><td></td>

  842.         </tr>

  843.       </table>

  844.   </td>

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

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

  847.   </tr>

  848. </table>

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

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

  851.   <table class="params">

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

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

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

  855.   </table>

  856.   </dd>

  857. </dl>

  858. 

  859. </div>

  860. </div>

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

  862. <div class="memitem">

  863. <div class="memproto">

  864. <table class="mlabels">

  865.   <tr>

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

  867.       <table class="memname">

  868.         <tr>

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

  870.           <td>(</td>

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

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

  873.           <td></td>

  874.         </tr>

  875.       </table>

  876.   </td>

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

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

  879.   </tr>

  880. </table>

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

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

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

  884.   <table class="params">

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

  886.   </table>

  887.   </dd>

  888. </dl>

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

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

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

  892. 

  893. </div>

  894. </div>

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

  896. <div class="memitem">

  897. <div class="memproto">

  898. <table class="mlabels">

  899.   <tr>

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

  901.       <table class="memname">

  902.         <tr>

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

  904.           <td>(</td>

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

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

  907.         </tr>

  908.         <tr>

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

  910.           <td></td>

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

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

  913.         </tr>

  914.         <tr>

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

  916.           <td></td>

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

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

  919.         </tr>

  920.         <tr>

  921.           <td></td>

  922.           <td>)</td>

  923.           <td></td><td></td>

  924.         </tr>

  925.       </table>

  926.   </td>

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

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

  929.   </tr>

  930. </table>

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

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

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

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

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

  936.   <table class="params">

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

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

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

  940.   </table>

  941.   </dd>

  942. </dl>

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

  944. 

  945. </div>

  946. </div>

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

  948. <div class="memitem">

  949. <div class="memproto">

  950. <table class="mlabels">

  951.   <tr>

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

  953.       <table class="memname">

  954.         <tr>

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

  956.           <td>(</td>

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

  958.           <td> const</td>

  959.         </tr>

  960.       </table>

  961.   </td>

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

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

  964.   </tr>

  965. </table>

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

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

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

  969. 

  970. </div>

  971. </div>

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

  973. <div class="memitem">

  974. <div class="memproto">

  975. <table class="mlabels">

  976.   <tr>

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

  978.       <table class="memname">

  979.         <tr>

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

  981.           <td>(</td>

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

  983.           <td> const</td>

  984.         </tr>

  985.       </table>

  986.   </td>

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

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

  989.   </tr>

  990. </table>

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

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

  993. 

  994. </div>

  995. </div>

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

  997. <div class="memitem">

  998. <div class="memproto">

  999. <table class="mlabels">

  1000.   <tr>

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

  1002.       <table class="memname">

  1003.         <tr>

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

  1005.           <td>(</td>

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

  1007.           <td> const</td>

  1008.         </tr>

  1009.       </table>

  1010.   </td>

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

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

  1013.   </tr>

  1014. </table>

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

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

  1017. 

  1018. </div>

  1019. </div>

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

  1021. <div class="memitem">

  1022. <div class="memproto">

  1023. <table class="mlabels">

  1024.   <tr>

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

  1026.       <table class="memname">

  1027.         <tr>

  1028.           <td class="memname">void File::flush </td>

  1029.           <td>(</td>

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

  1031.           <td></td>

  1032.         </tr>

  1033.       </table>

  1034.   </td>

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

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

  1037.   </tr>

  1038. </table>

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

  1040. <p>Ensure that any bytes written to the file are saved to the SD card. </p>

  1041. 

  1042. </div>

  1043. </div>

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

  1045. <div class="memitem">

  1046. <div class="memproto">

  1047. <table class="mlabels">

  1048.   <tr>

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

  1050.       <table class="memname">

  1051.         <tr>

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

  1053.           <td>(</td>

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

  1055.           <td></td>

  1056.         </tr>

  1057.       </table>

  1058.   </td>

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

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

  1061.   </tr>

  1062. </table>

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

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

  1065. 

  1066. </div>

  1067. </div>

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

  1069. <div class="memitem">

  1070. <div class="memproto">

  1071. <table class="mlabels">

  1072.   <tr>

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

  1074.       <table class="memname">

  1075.         <tr>

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

  1077.           <td>(</td>

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

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

  1080.         </tr>

  1081.         <tr>

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

  1083.           <td></td>

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

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

  1086.         </tr>

  1087.         <tr>

  1088.           <td></td>

  1089.           <td>)</td>

  1090.           <td></td><td></td>

  1091.         </tr>

  1092.       </table>

  1093.   </td>

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

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

  1096.   </tr>

  1097. </table>

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

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

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

  1101.   <table class="params">

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

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

  1104.   </table>

  1105.   </dd>

  1106. </dl>

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

  1108. 

  1109. </div>

  1110. </div>

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

  1112. <div class="memitem">

  1113. <div class="memproto">

  1114. <table class="mlabels">

  1115.   <tr>

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

  1117.       <table class="memname">

  1118.         <tr>

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

  1120.           <td>(</td>

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

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

  1123.           <td></td>

  1124.         </tr>

  1125.       </table>

  1126.   </td>

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

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

  1129.   </tr>

  1130. </table>

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

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

  1133.   <table class="params">

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

  1135.   </table>

  1136.   </dd>

  1137. </dl>

  1138. 

  1139. </div>

  1140. </div>

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

  1142. <div class="memitem">

  1143. <div class="memproto">

  1144. <table class="mlabels">

  1145.   <tr>

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

  1147.       <table class="memname">

  1148.         <tr>

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

  1150.           <td>(</td>

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

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

  1153.           <td></td>

  1154.         </tr>

  1155.       </table>

  1156.   </td>

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

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

  1159.   </tr>

  1160. </table>

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

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

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

  1164.   <table class="params">

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

  1166.   </table>

  1167.   </dd>

  1168. </dl>

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

  1170. 

  1171. </div>

  1172. </div>

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

  1174. <div class="memitem">

  1175. <div class="memproto">

  1176. <table class="mlabels">

  1177.   <tr>

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

  1179.       <table class="memname">

  1180.         <tr>

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

  1182.           <td>(</td>

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

  1184.           <td></td>

  1185.         </tr>

  1186.       </table>

  1187.   </td>

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

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

  1190.   </tr>

  1191. </table>

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

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

  1194. 

  1195. </div>

  1196. </div>

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

  1198. <div class="memitem">

  1199. <div class="memproto">

  1200. <table class="mlabels">

  1201.   <tr>

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

  1203.       <table class="memname">

  1204.         <tr>

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

  1206.           <td>(</td>

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

  1208.           <td> const</td>

  1209.         </tr>

  1210.       </table>

  1211.   </td>

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

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

  1214.   </tr>

  1215. </table>

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

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

  1218. 

  1219. </div>

  1220. </div>

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

  1222. <div class="memitem">

  1223. <div class="memproto">

  1224. <table class="mlabels">

  1225.   <tr>

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

  1227.       <table class="memname">

  1228.         <tr>

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

  1230.           <td>(</td>

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

  1232.           <td></td>

  1233.         </tr>

  1234.       </table>

  1235.   </td>

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

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

  1238.   </tr>

  1239. </table>

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

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

  1242. 

  1243. </div>

  1244. </div>

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

  1246. <div class="memitem">

  1247. <div class="memproto">

  1248. <table class="mlabels">

  1249.   <tr>

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

  1251.       <table class="memname">

  1252.         <tr>

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

  1254.           <td>(</td>

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

  1256.           <td> const</td>

  1257.         </tr>

  1258.       </table>

  1259.   </td>

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

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

  1262.   </tr>

  1263. </table>

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

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

  1266. 

  1267. </div>

  1268. </div>

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

  1270. <div class="memitem">

  1271. <div class="memproto">

  1272. <table class="mlabels">

  1273.   <tr>

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

  1275.       <table class="memname">

  1276.         <tr>

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

  1278.           <td>(</td>

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

  1280.           <td> const</td>

  1281.         </tr>

  1282.       </table>

  1283.   </td>

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

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

  1286.   </tr>

  1287. </table>

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

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

  1290. 

  1291. </div>

  1292. </div>

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

  1294. <div class="memitem">

  1295. <div class="memproto">

  1296. <table class="mlabels">

  1297.   <tr>

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

  1299.       <table class="memname">

  1300.         <tr>

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

  1302.           <td>(</td>

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

  1304.           <td> const</td>

  1305.         </tr>

  1306.       </table>

  1307.   </td>

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

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

  1310.   </tr>

  1311. </table>

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

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

  1314. 

  1315. </div>

  1316. </div>

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

  1318. <div class="memitem">

  1319. <div class="memproto">

  1320. <table class="mlabels">

  1321.   <tr>

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

  1323.       <table class="memname">

  1324.         <tr>

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

  1326.           <td>(</td>

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

  1328.           <td> const</td>

  1329.         </tr>

  1330.       </table>

  1331.   </td>

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

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

  1334.   </tr>

  1335. </table>

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

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

  1338. 

  1339. </div>

  1340. </div>

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

  1342. <div class="memitem">

  1343. <div class="memproto">

  1344. <table class="mlabels">

  1345.   <tr>

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

  1347.       <table class="memname">

  1348.         <tr>

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

  1350.           <td>(</td>

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

  1352.           <td> const</td>

  1353.         </tr>

  1354.       </table>

  1355.   </td>

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

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

  1358.   </tr>

  1359. </table>

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

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

  1362. 

  1363. </div>

  1364. </div>

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

  1366. <div class="memitem">

  1367. <div class="memproto">

  1368. <table class="mlabels">

  1369.   <tr>

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

  1371.       <table class="memname">

  1372.         <tr>

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

  1374.           <td>(</td>

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

  1376.           <td> const</td>

  1377.         </tr>

  1378.       </table>

  1379.   </td>

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

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

  1382.   </tr>

  1383. </table>

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

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

  1386. 

  1387. </div>

  1388. </div>

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

  1390. <div class="memitem">

  1391. <div class="memproto">

  1392. <table class="mlabels">

  1393.   <tr>

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

  1395.       <table class="memname">

  1396.         <tr>

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

  1398.           <td>(</td>

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

  1400.           <td> const</td>

  1401.         </tr>

  1402.       </table>

  1403.   </td>

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

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

  1406.   </tr>

  1407. </table>

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

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

  1410. 

  1411. </div>

  1412. </div>

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

  1414. <div class="memitem">

  1415. <div class="memproto">

  1416. <table class="mlabels">

  1417.   <tr>

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

  1419.       <table class="memname">

  1420.         <tr>

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

  1422.           <td>(</td>

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

  1424.           <td> const</td>

  1425.         </tr>

  1426.       </table>

  1427.   </td>

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

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

  1430.   </tr>

  1431. </table>

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

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

  1434. 

  1435. </div>

  1436. </div>

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

  1438. <div class="memitem">

  1439. <div class="memproto">

  1440. <table class="mlabels">

  1441.   <tr>

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

  1443.       <table class="memname">

  1444.         <tr>

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

  1446.           <td>(</td>

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

  1448.           <td> const</td>

  1449.         </tr>

  1450.       </table>

  1451.   </td>

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

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

  1454.   </tr>

  1455. </table>

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

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

  1458. 

  1459. </div>

  1460. </div>

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

  1462. <div class="memitem">

  1463. <div class="memproto">

  1464. <table class="mlabels">

  1465.   <tr>

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

  1467.       <table class="memname">

  1468.         <tr>

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

  1470.           <td>(</td>

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

  1472.           <td> const</td>

  1473.         </tr>

  1474.       </table>

  1475.   </td>

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

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

  1478.   </tr>

  1479. </table>

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

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

  1482. 

  1483. </div>

  1484. </div>

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

  1486. <div class="memitem">

  1487. <div class="memproto">

  1488. <table class="mlabels">

  1489.   <tr>

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

  1491.       <table class="memname">

  1492.         <tr>

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

  1494.           <td>(</td>

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

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

  1497.           <td></td>

  1498.         </tr>

  1499.       </table>

  1500.   </td>

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

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

  1503.   </tr>

  1504. </table>

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

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

  1507.   <table class="params">

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

  1509.   </table>

  1510.   </dd>

  1511. </dl>

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

  1513. 

  1514. </div>

  1515. </div>

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

  1517. <div class="memitem">

  1518. <div class="memproto">

  1519. <table class="mlabels">

  1520.   <tr>

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

  1522.       <table class="memname">

  1523.         <tr>

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

  1525.           <td>(</td>

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

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

  1528.           <td></td>

  1529.         </tr>

  1530.       </table>

  1531.   </td>

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

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

  1534.   </tr>

  1535. </table>

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

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

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

  1539.   <table class="params">

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

  1541.   </table>

  1542.   </dd>

  1543. </dl>

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

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

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

  1547. 

  1548. </div>

  1549. </div>

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

  1551. <div class="memitem">

  1552. <div class="memproto">

  1553. <table class="mlabels">

  1554.   <tr>

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

  1556.       <table class="memname">

  1557.         <tr>

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

  1559.           <td>(</td>

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

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

  1562.         </tr>

  1563.         <tr>

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

  1565.           <td></td>

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

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

  1568.         </tr>

  1569.         <tr>

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

  1571.           <td></td>

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

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

  1574.         </tr>

  1575.         <tr>

  1576.           <td></td>

  1577.           <td>)</td>

  1578.           <td></td><td></td>

  1579.         </tr>

  1580.       </table>

  1581.   </td>

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

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

  1584.   </tr>

  1585. </table>

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

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

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

  1589.   <table class="params">

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

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

  1592.   </table>

  1593.   </dd>

  1594. </dl>

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

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

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

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

  1599.   <table class="params">

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

  1601.   </table>

  1602.   </dd>

  1603. </dl>

  1604. 

  1605. </div>

  1606. </div>

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

  1608. <div class="memitem">

  1609. <div class="memproto">

  1610. <table class="mlabels">

  1611.   <tr>

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

  1613.       <table class="memname">

  1614.         <tr>

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

  1616.           <td>(</td>

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

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

  1619.         </tr>

  1620.         <tr>

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

  1622.           <td></td>

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

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

  1625.         </tr>

  1626.         <tr>

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

  1628.           <td></td>

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

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

  1631.         </tr>

  1632.         <tr>

  1633.           <td></td>

  1634.           <td>)</td>

  1635.           <td></td><td></td>

  1636.         </tr>

  1637.       </table>

  1638.   </td>

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

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

  1641.   </tr>

  1642. </table>

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

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

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

  1646.   <table class="params">

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

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

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

  1650.   </table>

  1651.   </dd>

  1652. </dl>

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

  1654. 

  1655. </div>

  1656. </div>

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

  1658. <div class="memitem">

  1659. <div class="memproto">

  1660. <table class="mlabels">

  1661.   <tr>

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

  1663.       <table class="memname">

  1664.         <tr>

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

  1666.           <td>(</td>

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

  1668.           <td> const</td>

  1669.         </tr>

  1670.       </table>

  1671.   </td>

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

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

  1674.   </tr>

  1675. </table>

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

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

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

  1679. 

  1680. </div>

  1681. </div>

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

  1683. <div class="memitem">

  1684. <div class="memproto">

  1685. <table class="mlabels">

  1686.   <tr>

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

  1688.       <table class="memname">

  1689.         <tr>

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

  1691.           <td>(</td>

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

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

  1694.         </tr>

  1695.         <tr>

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

  1697.           <td></td>

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

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

  1700.         </tr>

  1701.         <tr>

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

  1703.           <td></td>

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

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

  1706.         </tr>

  1707.         <tr>

  1708.           <td></td>

  1709.           <td>)</td>

  1710.           <td></td><td></td>

  1711.         </tr>

  1712.       </table>

  1713.   </td>

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

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

  1716.   </tr>

  1717. </table>

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

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

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

  1721.   <table class="params">

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

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

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

  1725.   </table>

  1726.   </dd>

  1727. </dl>

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

  1729. 

  1730. </div>

  1731. </div>

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

  1733. <div class="memitem">

  1734. <div class="memproto">

  1735. <table class="mlabels">

  1736.   <tr>

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

  1738.       <table class="memname">

  1739.         <tr>

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

  1741.           <td>(</td>

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

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

  1744.         </tr>

  1745.         <tr>

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

  1747.           <td></td>

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

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

  1750.         </tr>

  1751.         <tr>

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

  1753.           <td></td>

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

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

  1756.         </tr>

  1757.         <tr>

  1758.           <td></td>

  1759.           <td>)</td>

  1760.           <td></td><td></td>

  1761.         </tr>

  1762.       </table>

  1763.   </td>

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

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

  1766.   </tr>

  1767. </table>

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

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

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

  1771.   <table class="params">

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

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

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

  1775.   </table>

  1776.   </dd>

  1777. </dl>

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

  1779. 

  1780. </div>

  1781. </div>

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

  1783. <div class="memitem">

  1784. <div class="memproto">

  1785. <table class="mlabels">

  1786.   <tr>

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

  1788.       <table class="memname">

  1789.         <tr>

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

  1791.           <td>(</td>

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

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

  1794.         </tr>

  1795.         <tr>

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

  1797.           <td></td>

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

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

  1800.         </tr>

  1801.         <tr>

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

  1803.           <td></td>

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

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

  1806.         </tr>

  1807.         <tr>

  1808.           <td></td>

  1809.           <td>)</td>

  1810.           <td></td><td></td>

  1811.         </tr>

  1812.       </table>

  1813.   </td>

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

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

  1816.   </tr>

  1817. </table>

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

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

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

  1821.   <table class="params">

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

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

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

  1825.   </table>

  1826.   </dd>

  1827. </dl>

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

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

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

  1831. <p>O_WRONLY - Same as O_WRITE.</p>

  1832. <p>O_RDWR - Open for reading and writing.</p>

  1833. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1834. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1835. <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>

  1836. <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>

  1837. <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>

  1838. <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>

  1839. <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>

  1840. <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>

  1841. <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>

  1842. 

  1843. </div>

  1844. </div>

  1845. <a class="anchor" id="ab0e7075062c89f356441f80fc64d03e6"></a>

  1846. <div class="memitem">

  1847. <div class="memproto">

  1848. <table class="mlabels">

  1849.   <tr>

  1850.   <td class="mlabels-left">

  1851.       <table class="memname">

  1852.         <tr>

  1853.           <td class="memname">bool FatFile::open </td>

  1854.           <td>(</td>

  1855.           <td class="paramtype">const char *&#160;</td>

  1856.           <td class="paramname"><em>path</em>, </td>

  1857.         </tr>

  1858.         <tr>

  1859.           <td class="paramkey"></td>

  1860.           <td></td>

  1861.           <td class="paramtype">uint8_t&#160;</td>

  1862.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1863.         </tr>

  1864.         <tr>

  1865.           <td></td>

  1866.           <td>)</td>

  1867.           <td></td><td></td>

  1868.         </tr>

  1869.       </table>

  1870.   </td>

  1871.   <td class="mlabels-right">

  1872. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1873.   </tr>

  1874. </table>

  1875. </div><div class="memdoc">

  1876. <p>Open a file in the current working directory.</p>

  1877. <dl class="params"><dt>Parameters</dt><dd>

  1878.   <table class="params">

  1879.     <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>

  1880.     <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>

  1881.   </table>

  1882.   </dd>

  1883. </dl>

  1884. <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>

  1885. 

  1886. </div>

  1887. </div>

  1888. <a class="anchor" id="a8034c4649eb0d26715b1a8a69e73d9d0"></a>

  1889. <div class="memitem">

  1890. <div class="memproto">

  1891. <table class="mlabels">

  1892.   <tr>

  1893.   <td class="mlabels-left">

  1894.       <table class="memname">

  1895.         <tr>

  1896.           <td class="memname">bool FatFile::openNext </td>

  1897.           <td>(</td>

  1898.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1899.           <td class="paramname"><em>dirFile</em>, </td>

  1900.         </tr>

  1901.         <tr>

  1902.           <td class="paramkey"></td>

  1903.           <td></td>

  1904.           <td class="paramtype">uint8_t&#160;</td>

  1905.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1906.         </tr>

  1907.         <tr>

  1908.           <td></td>

  1909.           <td>)</td>

  1910.           <td></td><td></td>

  1911.         </tr>

  1912.       </table>

  1913.   </td>

  1914.   <td class="mlabels-right">

  1915. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1916.   </tr>

  1917. </table>

  1918. </div><div class="memdoc">

  1919. <p>Open the next file or subdirectory in a directory.</p>

  1920. <dl class="params"><dt>Parameters</dt><dd>

  1921.   <table class="params">

  1922.     <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>

  1923.     <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>

  1924.   </table>

  1925.   </dd>

  1926. </dl>

  1927. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1928. 

  1929. </div>

  1930. </div>

  1931. <a class="anchor" id="acd72000ab1f6a1ce73ac8fbdc854ae0c"></a>

  1932. <div class="memitem">

  1933. <div class="memproto">

  1934. <table class="mlabels">

  1935.   <tr>

  1936.   <td class="mlabels-left">

  1937.       <table class="memname">

  1938.         <tr>

  1939.           <td class="memname"><a class="el" href="class_file.html">File</a> File::openNextFile </td>

  1940.           <td>(</td>

  1941.           <td class="paramtype">uint8_t&#160;</td>

  1942.           <td class="paramname"><em>mode</em> = <code>O_READ</code></td><td>)</td>

  1943.           <td></td>

  1944.         </tr>

  1945.       </table>

  1946.   </td>

  1947.   <td class="mlabels-right">

  1948. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1949.   </tr>

  1950. </table>

  1951. </div><div class="memdoc">

  1952. <p>Opens the next file or folder in a directory.</p>

  1953. <dl class="params"><dt>Parameters</dt><dd>

  1954.   <table class="params">

  1955.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>

  1956.   </table>

  1957.   </dd>

  1958. </dl>

  1959. <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>

  1960. 

  1961. </div>

  1962. </div>

  1963. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1964. <div class="memitem">

  1965. <div class="memproto">

  1966. <table class="mlabels">

  1967.   <tr>

  1968.   <td class="mlabels-left">

  1969.       <table class="memname">

  1970.         <tr>

  1971.           <td class="memname">bool FatFile::openRoot </td>

  1972.           <td>(</td>

  1973.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1974.           <td class="paramname"><em>vol</em></td><td>)</td>

  1975.           <td></td>

  1976.         </tr>

  1977.       </table>

  1978.   </td>

  1979.   <td class="mlabels-right">

  1980. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1981.   </tr>

  1982. </table>

  1983. </div><div class="memdoc">

  1984. <p>Open a volume's root directory.</p>

  1985. <dl class="params"><dt>Parameters</dt><dd>

  1986.   <table class="params">

  1987.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1988.   </table>

  1989.   </dd>

  1990. </dl>

  1991. <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>

  1992. 

  1993. </div>

  1994. </div>

  1995. <a class="anchor" id="af171fbf441c899cf71d88b8b0b83d38b"></a>

  1996. <div class="memitem">

  1997. <div class="memproto">

  1998. <table class="mlabels">

  1999.   <tr>

  2000.   <td class="mlabels-left">

  2001.       <table class="memname">

  2002.         <tr>

  2003.           <td class="memname">File::operator bool </td>

  2004.           <td>(</td>

  2005.           <td class="paramname"></td><td>)</td>

  2006.           <td></td>

  2007.         </tr>

  2008.       </table>

  2009.   </td>

  2010.   <td class="mlabels-right">

  2011. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2012.   </tr>

  2013. </table>

  2014. </div><div class="memdoc">

  2015. <p>The parenthesis operator.</p>

  2016. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2017. 

  2018. </div>

  2019. </div>

  2020. <a class="anchor" id="a0e5025f39bd584563bfe4b05fc1db268"></a>

  2021. <div class="memitem">

  2022. <div class="memproto">

  2023. <table class="mlabels">

  2024.   <tr>

  2025.   <td class="mlabels-left">

  2026.       <table class="memname">

  2027.         <tr>

  2028.           <td class="memname">int File::peek </td>

  2029.           <td>(</td>

  2030.           <td class="paramname"></td><td>)</td>

  2031.           <td></td>

  2032.         </tr>

  2033.       </table>

  2034.   </td>

  2035.   <td class="mlabels-right">

  2036. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2037.   </tr>

  2038. </table>

  2039. </div><div class="memdoc">

  2040. <p>Return the next available byte without consuming it.</p>

  2041. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2042. 

  2043. </div>

  2044. </div>

  2045. <a class="anchor" id="aae991c597c0bc4c5eb44c1f3b06a21ec"></a>

  2046. <div class="memitem">

  2047. <div class="memproto">

  2048. <table class="mlabels">

  2049.   <tr>

  2050.   <td class="mlabels-left">

  2051.       <table class="memname">

  2052.         <tr>

  2053.           <td class="memname">uint32_t File::position </td>

  2054.           <td>(</td>

  2055.           <td class="paramname"></td><td>)</td>

  2056.           <td></td>

  2057.         </tr>

  2058.       </table>

  2059.   </td>

  2060.   <td class="mlabels-right">

  2061. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2062.   </tr>

  2063. </table>

  2064. </div><div class="memdoc">

  2065. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2066. 

  2067. </div>

  2068. </div>

  2069. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  2070. <div class="memitem">

  2071. <div class="memproto">

  2072. <table class="mlabels">

  2073.   <tr>

  2074.   <td class="mlabels-left">

  2075.       <table class="memname">

  2076.         <tr>

  2077.           <td class="memname">bool FatFile::printCreateDateTime </td>

  2078.           <td>(</td>

  2079.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2080.           <td class="paramname"><em>pr</em></td><td>)</td>

  2081.           <td></td>

  2082.         </tr>

  2083.       </table>

  2084.   </td>

  2085.   <td class="mlabels-right">

  2086. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2087.   </tr>

  2088. </table>

  2089. </div><div class="memdoc">

  2090. <p>Print a file's creation date and time</p>

  2091. <dl class="params"><dt>Parameters</dt><dd>

  2092.   <table class="params">

  2093.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2094.   </table>

  2095.   </dd>

  2096. </dl>

  2097. <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>

  2098. 

  2099. </div>

  2100. </div>

  2101. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  2102. <div class="memitem">

  2103. <div class="memproto">

  2104. <table class="mlabels">

  2105.   <tr>

  2106.   <td class="mlabels-left">

  2107.       <table class="memname">

  2108.         <tr>

  2109.           <td class="memname">static void FatFile::printFatDate </td>

  2110.           <td>(</td>

  2111.           <td class="paramtype">uint16_t&#160;</td>

  2112.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  2113.           <td></td>

  2114.         </tr>

  2115.       </table>

  2116.   </td>

  2117.   <td class="mlabels-right">

  2118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2119.   </tr>

  2120. </table>

  2121. </div><div class="memdoc">

  2122. <p>Print a directory date field.</p>

  2123. <p>Format is yyyy-mm-dd.</p>

  2124. <dl class="params"><dt>Parameters</dt><dd>

  2125.   <table class="params">

  2126.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2127.   </table>

  2128.   </dd>

  2129. </dl>

  2130. 

  2131. </div>

  2132. </div>

  2133. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  2134. <div class="memitem">

  2135. <div class="memproto">

  2136. <table class="mlabels">

  2137.   <tr>

  2138.   <td class="mlabels-left">

  2139.       <table class="memname">

  2140.         <tr>

  2141.           <td class="memname">void FatFile::printFatDate </td>

  2142.           <td>(</td>

  2143.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2144.           <td class="paramname"><em>pr</em>, </td>

  2145.         </tr>

  2146.         <tr>

  2147.           <td class="paramkey"></td>

  2148.           <td></td>

  2149.           <td class="paramtype">uint16_t&#160;</td>

  2150.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2151.         </tr>

  2152.         <tr>

  2153.           <td></td>

  2154.           <td>)</td>

  2155.           <td></td><td></td>

  2156.         </tr>

  2157.       </table>

  2158.   </td>

  2159.   <td class="mlabels-right">

  2160. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2161.   </tr>

  2162. </table>

  2163. </div><div class="memdoc">

  2164. <p>Print a directory date field.</p>

  2165. <p>Format is yyyy-mm-dd.</p>

  2166. <dl class="params"><dt>Parameters</dt><dd>

  2167.   <table class="params">

  2168.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2169.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2170.   </table>

  2171.   </dd>

  2172. </dl>

  2173. 

  2174. </div>

  2175. </div>

  2176. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  2177. <div class="memitem">

  2178. <div class="memproto">

  2179. <table class="mlabels">

  2180.   <tr>

  2181.   <td class="mlabels-left">

  2182.       <table class="memname">

  2183.         <tr>

  2184.           <td class="memname">static void FatFile::printFatTime </td>

  2185.           <td>(</td>

  2186.           <td class="paramtype">uint16_t&#160;</td>

  2187.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2188.           <td></td>

  2189.         </tr>

  2190.       </table>

  2191.   </td>

  2192.   <td class="mlabels-right">

  2193. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2194.   </tr>

  2195. </table>

  2196. </div><div class="memdoc">

  2197. <p>Print a directory time field.</p>

  2198. <p>Format is hh:mm:ss.</p>

  2199. <dl class="params"><dt>Parameters</dt><dd>

  2200.   <table class="params">

  2201.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2202.   </table>

  2203.   </dd>

  2204. </dl>

  2205. 

  2206. </div>

  2207. </div>

  2208. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2209. <div class="memitem">

  2210. <div class="memproto">

  2211. <table class="mlabels">

  2212.   <tr>

  2213.   <td class="mlabels-left">

  2214.       <table class="memname">

  2215.         <tr>

  2216.           <td class="memname">void FatFile::printFatTime </td>

  2217.           <td>(</td>

  2218.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2219.           <td class="paramname"><em>pr</em>, </td>

  2220.         </tr>

  2221.         <tr>

  2222.           <td class="paramkey"></td>

  2223.           <td></td>

  2224.           <td class="paramtype">uint16_t&#160;</td>

  2225.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2226.         </tr>

  2227.         <tr>

  2228.           <td></td>

  2229.           <td>)</td>

  2230.           <td></td><td></td>

  2231.         </tr>

  2232.       </table>

  2233.   </td>

  2234.   <td class="mlabels-right">

  2235. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2236.   </tr>

  2237. </table>

  2238. </div><div class="memdoc">

  2239. <p>Print a directory time field.</p>

  2240. <p>Format is hh:mm:ss.</p>

  2241. <dl class="params"><dt>Parameters</dt><dd>

  2242.   <table class="params">

  2243.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2244.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2245.   </table>

  2246.   </dd>

  2247. </dl>

  2248. 

  2249. </div>

  2250. </div>

  2251. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2252. <div class="memitem">

  2253. <div class="memproto">

  2254. <table class="mlabels">

  2255.   <tr>

  2256.   <td class="mlabels-left">

  2257.       <table class="memname">

  2258.         <tr>

  2259.           <td class="memname">int FatFile::printField </td>

  2260.           <td>(</td>

  2261.           <td class="paramtype">float&#160;</td>

  2262.           <td class="paramname"><em>value</em>, </td>

  2263.         </tr>

  2264.         <tr>

  2265.           <td class="paramkey"></td>

  2266.           <td></td>

  2267.           <td class="paramtype">char&#160;</td>

  2268.           <td class="paramname"><em>term</em>, </td>

  2269.         </tr>

  2270.         <tr>

  2271.           <td class="paramkey"></td>

  2272.           <td></td>

  2273.           <td class="paramtype">uint8_t&#160;</td>

  2274.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2275.         </tr>

  2276.         <tr>

  2277.           <td></td>

  2278.           <td>)</td>

  2279.           <td></td><td></td>

  2280.         </tr>

  2281.       </table>

  2282.   </td>

  2283.   <td class="mlabels-right">

  2284. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2285.   </tr>

  2286. </table>

  2287. </div><div class="memdoc">

  2288. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2289.   <table class="params">

  2290.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2291.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2292.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2293.   </table>

  2294.   </dd>

  2295. </dl>

  2296. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2297. 

  2298. </div>

  2299. </div>

  2300. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2301. <div class="memitem">

  2302. <div class="memproto">

  2303. <table class="mlabels">

  2304.   <tr>

  2305.   <td class="mlabels-left">

  2306.       <table class="memname">

  2307.         <tr>

  2308.           <td class="memname">int FatFile::printField </td>

  2309.           <td>(</td>

  2310.           <td class="paramtype">int16_t&#160;</td>

  2311.           <td class="paramname"><em>value</em>, </td>

  2312.         </tr>

  2313.         <tr>

  2314.           <td class="paramkey"></td>

  2315.           <td></td>

  2316.           <td class="paramtype">char&#160;</td>

  2317.           <td class="paramname"><em>term</em>&#160;</td>

  2318.         </tr>

  2319.         <tr>

  2320.           <td></td>

  2321.           <td>)</td>

  2322.           <td></td><td></td>

  2323.         </tr>

  2324.       </table>

  2325.   </td>

  2326.   <td class="mlabels-right">

  2327. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2328.   </tr>

  2329. </table>

  2330. </div><div class="memdoc">

  2331. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2332.   <table class="params">

  2333.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2334.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2335.   </table>

  2336.   </dd>

  2337. </dl>

  2338. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2339. 

  2340. </div>

  2341. </div>

  2342. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2343. <div class="memitem">

  2344. <div class="memproto">

  2345. <table class="mlabels">

  2346.   <tr>

  2347.   <td class="mlabels-left">

  2348.       <table class="memname">

  2349.         <tr>

  2350.           <td class="memname">int FatFile::printField </td>

  2351.           <td>(</td>

  2352.           <td class="paramtype">uint16_t&#160;</td>

  2353.           <td class="paramname"><em>value</em>, </td>

  2354.         </tr>

  2355.         <tr>

  2356.           <td class="paramkey"></td>

  2357.           <td></td>

  2358.           <td class="paramtype">char&#160;</td>

  2359.           <td class="paramname"><em>term</em>&#160;</td>

  2360.         </tr>

  2361.         <tr>

  2362.           <td></td>

  2363.           <td>)</td>

  2364.           <td></td><td></td>

  2365.         </tr>

  2366.       </table>

  2367.   </td>

  2368.   <td class="mlabels-right">

  2369. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2370.   </tr>

  2371. </table>

  2372. </div><div class="memdoc">

  2373. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2374.   <table class="params">

  2375.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2376.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2377.   </table>

  2378.   </dd>

  2379. </dl>

  2380. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2381. 

  2382. </div>

  2383. </div>

  2384. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2385. <div class="memitem">

  2386. <div class="memproto">

  2387. <table class="mlabels">

  2388.   <tr>

  2389.   <td class="mlabels-left">

  2390.       <table class="memname">

  2391.         <tr>

  2392.           <td class="memname">int FatFile::printField </td>

  2393.           <td>(</td>

  2394.           <td class="paramtype">int32_t&#160;</td>

  2395.           <td class="paramname"><em>value</em>, </td>

  2396.         </tr>

  2397.         <tr>

  2398.           <td class="paramkey"></td>

  2399.           <td></td>

  2400.           <td class="paramtype">char&#160;</td>

  2401.           <td class="paramname"><em>term</em>&#160;</td>

  2402.         </tr>

  2403.         <tr>

  2404.           <td></td>

  2405.           <td>)</td>

  2406.           <td></td><td></td>

  2407.         </tr>

  2408.       </table>

  2409.   </td>

  2410.   <td class="mlabels-right">

  2411. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2412.   </tr>

  2413. </table>

  2414. </div><div class="memdoc">

  2415. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2416.   <table class="params">

  2417.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2418.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2419.   </table>

  2420.   </dd>

  2421. </dl>

  2422. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2423. 

  2424. </div>

  2425. </div>

  2426. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2427. <div class="memitem">

  2428. <div class="memproto">

  2429. <table class="mlabels">

  2430.   <tr>

  2431.   <td class="mlabels-left">

  2432.       <table class="memname">

  2433.         <tr>

  2434.           <td class="memname">int FatFile::printField </td>

  2435.           <td>(</td>

  2436.           <td class="paramtype">uint32_t&#160;</td>

  2437.           <td class="paramname"><em>value</em>, </td>

  2438.         </tr>

  2439.         <tr>

  2440.           <td class="paramkey"></td>

  2441.           <td></td>

  2442.           <td class="paramtype">char&#160;</td>

  2443.           <td class="paramname"><em>term</em>&#160;</td>

  2444.         </tr>

  2445.         <tr>

  2446.           <td></td>

  2447.           <td>)</td>

  2448.           <td></td><td></td>

  2449.         </tr>

  2450.       </table>

  2451.   </td>

  2452.   <td class="mlabels-right">

  2453. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2454.   </tr>

  2455. </table>

  2456. </div><div class="memdoc">

  2457. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2458.   <table class="params">

  2459.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2460.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2461.   </table>

  2462.   </dd>

  2463. </dl>

  2464. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2465. 

  2466. </div>

  2467. </div>

  2468. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2469. <div class="memitem">

  2470. <div class="memproto">

  2471. <table class="mlabels">

  2472.   <tr>

  2473.   <td class="mlabels-left">

  2474.       <table class="memname">

  2475.         <tr>

  2476.           <td class="memname">size_t FatFile::printFileSize </td>

  2477.           <td>(</td>

  2478.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2479.           <td class="paramname"><em>pr</em></td><td>)</td>

  2480.           <td></td>

  2481.         </tr>

  2482.       </table>

  2483.   </td>

  2484.   <td class="mlabels-right">

  2485. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2486.   </tr>

  2487. </table>

  2488. </div><div class="memdoc">

  2489. <p>Print a file's size.</p>

  2490. <dl class="params"><dt>Parameters</dt><dd>

  2491.   <table class="params">

  2492.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2493.   </table>

  2494.   </dd>

  2495. </dl>

  2496. <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>

  2497. 

  2498. </div>

  2499. </div>

  2500. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2501. <div class="memitem">

  2502. <div class="memproto">

  2503. <table class="mlabels">

  2504.   <tr>

  2505.   <td class="mlabels-left">

  2506.       <table class="memname">

  2507.         <tr>

  2508.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2509.           <td>(</td>

  2510.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2511.           <td class="paramname"><em>pr</em></td><td>)</td>

  2512.           <td></td>

  2513.         </tr>

  2514.       </table>

  2515.   </td>

  2516.   <td class="mlabels-right">

  2517. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2518.   </tr>

  2519. </table>

  2520. </div><div class="memdoc">

  2521. <p>Print a file's modify date and time</p>

  2522. <dl class="params"><dt>Parameters</dt><dd>

  2523.   <table class="params">

  2524.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2525.   </table>

  2526.   </dd>

  2527. </dl>

  2528. <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>

  2529. 

  2530. </div>

  2531. </div>

  2532. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2533. <div class="memitem">

  2534. <div class="memproto">

  2535. <table class="mlabels">

  2536.   <tr>

  2537.   <td class="mlabels-left">

  2538.       <table class="memname">

  2539.         <tr>

  2540.           <td class="memname">size_t FatFile::printName </td>

  2541.           <td>(</td>

  2542.           <td class="paramname"></td><td>)</td>

  2543.           <td></td>

  2544.         </tr>

  2545.       </table>

  2546.   </td>

  2547.   <td class="mlabels-right">

  2548. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2549.   </tr>

  2550. </table>

  2551. </div><div class="memdoc">

  2552. <p>Print a file's name.</p>

  2553. <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>

  2554. 

  2555. </div>

  2556. </div>

  2557. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2558. <div class="memitem">

  2559. <div class="memproto">

  2560. <table class="mlabels">

  2561.   <tr>

  2562.   <td class="mlabels-left">

  2563.       <table class="memname">

  2564.         <tr>

  2565.           <td class="memname">size_t FatFile::printName </td>

  2566.           <td>(</td>

  2567.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2568.           <td class="paramname"><em>pr</em></td><td>)</td>

  2569.           <td></td>

  2570.         </tr>

  2571.       </table>

  2572.   </td>

  2573.   <td class="mlabels-right">

  2574. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2575.   </tr>

  2576. </table>

  2577. </div><div class="memdoc">

  2578. <p>Print a file's name</p>

  2579. <dl class="params"><dt>Parameters</dt><dd>

  2580.   <table class="params">

  2581.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2582.   </table>

  2583.   </dd>

  2584. </dl>

  2585. <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>

  2586. 

  2587. </div>

  2588. </div>

  2589. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2590. <div class="memitem">

  2591. <div class="memproto">

  2592. <table class="mlabels">

  2593.   <tr>

  2594.   <td class="mlabels-left">

  2595.       <table class="memname">

  2596.         <tr>

  2597.           <td class="memname">size_t FatFile::printSFN </td>

  2598.           <td>(</td>

  2599.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2600.           <td class="paramname"><em>pr</em></td><td>)</td>

  2601.           <td></td>

  2602.         </tr>

  2603.       </table>

  2604.   </td>

  2605.   <td class="mlabels-right">

  2606. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2607.   </tr>

  2608. </table>

  2609. </div><div class="memdoc">

  2610. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2611. <dl class="params"><dt>Parameters</dt><dd>

  2612.   <table class="params">

  2613.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2614.   </table>

  2615.   </dd>

  2616. </dl>

  2617. <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>

  2618. 

  2619. </div>

  2620. </div>

  2621. <a class="anchor" id="a4c46a1975e66c37977bf07c58ec10b4e"></a>

  2622. <div class="memitem">

  2623. <div class="memproto">

  2624. <table class="mlabels">

  2625.   <tr>

  2626.   <td class="mlabels-left">

  2627.       <table class="memname">

  2628.         <tr>

  2629.           <td class="memname">int File::read </td>

  2630.           <td>(</td>

  2631.           <td class="paramname"></td><td>)</td>

  2632.           <td></td>

  2633.         </tr>

  2634.       </table>

  2635.   </td>

  2636.   <td class="mlabels-right">

  2637. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2638.   </tr>

  2639. </table>

  2640. </div><div class="memdoc">

  2641. <p>Read the next byte from a file.</p>

  2642. <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>

  2643. 

  2644. </div>

  2645. </div>

  2646. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2647. <div class="memitem">

  2648. <div class="memproto">

  2649. <table class="mlabels">

  2650.   <tr>

  2651.   <td class="mlabels-left">

  2652.       <table class="memname">

  2653.         <tr>

  2654.           <td class="memname">int FatFile::read </td>

  2655.           <td>(</td>

  2656.           <td class="paramtype">void *&#160;</td>

  2657.           <td class="paramname"><em>buf</em>, </td>

  2658.         </tr>

  2659.         <tr>

  2660.           <td class="paramkey"></td>

  2661.           <td></td>

  2662.           <td class="paramtype">size_t&#160;</td>

  2663.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2664.         </tr>

  2665.         <tr>

  2666.           <td></td>

  2667.           <td>)</td>

  2668.           <td></td><td></td>

  2669.         </tr>

  2670.       </table>

  2671.   </td>

  2672.   <td class="mlabels-right">

  2673. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2674.   </tr>

  2675. </table>

  2676. </div><div class="memdoc">

  2677. <p>Read data from a file starting at the current position.</p>

  2678. <dl class="params"><dt>Parameters</dt><dd>

  2679.   <table class="params">

  2680.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2681.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2682.   </table>

  2683.   </dd>

  2684. </dl>

  2685. <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>

  2686. 

  2687. </div>

  2688. </div>

  2689. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2690. <div class="memitem">

  2691. <div class="memproto">

  2692. <table class="mlabels">

  2693.   <tr>

  2694.   <td class="mlabels-left">

  2695.       <table class="memname">

  2696.         <tr>

  2697.           <td class="memname">int8_t FatFile::readDir </td>

  2698.           <td>(</td>

  2699.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2700.           <td class="paramname"><em>dir</em></td><td>)</td>

  2701.           <td></td>

  2702.         </tr>

  2703.       </table>

  2704.   </td>

  2705.   <td class="mlabels-right">

  2706. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2707.   </tr>

  2708. </table>

  2709. </div><div class="memdoc">

  2710. <p>Read the next directory entry from a directory file.</p>

  2711. <dl class="params"><dt>Parameters</dt><dd>

  2712.   <table class="params">

  2713.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2714.   </table>

  2715.   </dd>

  2716. </dl>

  2717. <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>

  2718. 

  2719. </div>

  2720. </div>

  2721. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2722. <div class="memitem">

  2723. <div class="memproto">

  2724. <table class="mlabels">

  2725.   <tr>

  2726.   <td class="mlabels-left">

  2727.       <table class="memname">

  2728.         <tr>

  2729.           <td class="memname">bool FatFile::remove </td>

  2730.           <td>(</td>

  2731.           <td class="paramname"></td><td>)</td>

  2732.           <td></td>

  2733.         </tr>

  2734.       </table>

  2735.   </td>

  2736.   <td class="mlabels-right">

  2737. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2738.   </tr>

  2739. </table>

  2740. </div><div class="memdoc">

  2741. <p>Remove a file.</p>

  2742. <p>The directory entry and all data for the file are deleted.</p>

  2743. <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>

  2744. <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>

  2745. 

  2746. </div>

  2747. </div>

  2748. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2749. <div class="memitem">

  2750. <div class="memproto">

  2751. <table class="mlabels">

  2752.   <tr>

  2753.   <td class="mlabels-left">

  2754.       <table class="memname">

  2755.         <tr>

  2756.           <td class="memname">bool FatFile::remove </td>

  2757.           <td>(</td>

  2758.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2759.           <td class="paramname"><em>dirFile</em>, </td>

  2760.         </tr>

  2761.         <tr>

  2762.           <td class="paramkey"></td>

  2763.           <td></td>

  2764.           <td class="paramtype">const char *&#160;</td>

  2765.           <td class="paramname"><em>path</em>&#160;</td>

  2766.         </tr>

  2767.         <tr>

  2768.           <td></td>

  2769.           <td>)</td>

  2770.           <td></td><td></td>

  2771.         </tr>

  2772.       </table>

  2773.   </td>

  2774.   <td class="mlabels-right">

  2775. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2776.   </tr>

  2777. </table>

  2778. </div><div class="memdoc">

  2779. <p>Remove a file.</p>

  2780. <p>The directory entry and all data for the file are deleted.</p>

  2781. <dl class="params"><dt>Parameters</dt><dd>

  2782.   <table class="params">

  2783.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2784.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2785.   </table>

  2786.   </dd>

  2787. </dl>

  2788. <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>

  2789. <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>

  2790. 

  2791. </div>

  2792. </div>

  2793. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2794. <div class="memitem">

  2795. <div class="memproto">

  2796. <table class="mlabels">

  2797.   <tr>

  2798.   <td class="mlabels-left">

  2799.       <table class="memname">

  2800.         <tr>

  2801.           <td class="memname">bool FatFile::rename </td>

  2802.           <td>(</td>

  2803.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2804.           <td class="paramname"><em>dirFile</em>, </td>

  2805.         </tr>

  2806.         <tr>

  2807.           <td class="paramkey"></td>

  2808.           <td></td>

  2809.           <td class="paramtype">const char *&#160;</td>

  2810.           <td class="paramname"><em>newPath</em>&#160;</td>

  2811.         </tr>

  2812.         <tr>

  2813.           <td></td>

  2814.           <td>)</td>

  2815.           <td></td><td></td>

  2816.         </tr>

  2817.       </table>

  2818.   </td>

  2819.   <td class="mlabels-right">

  2820. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2821.   </tr>

  2822. </table>

  2823. </div><div class="memdoc">

  2824. <p>Rename a file or subdirectory.</p>

  2825. <dl class="params"><dt>Parameters</dt><dd>

  2826.   <table class="params">

  2827.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2828.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2829.   </table>

  2830.   </dd>

  2831. </dl>

  2832. <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>

  2833. 

  2834. </div>

  2835. </div>

  2836. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2837. <div class="memitem">

  2838. <div class="memproto">

  2839. <table class="mlabels">

  2840.   <tr>

  2841.   <td class="mlabels-left">

  2842.       <table class="memname">

  2843.         <tr>

  2844.           <td class="memname">void FatFile::rewind </td>

  2845.           <td>(</td>

  2846.           <td class="paramname"></td><td>)</td>

  2847.           <td></td>

  2848.         </tr>

  2849.       </table>

  2850.   </td>

  2851.   <td class="mlabels-right">

  2852. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2853.   </tr>

  2854. </table>

  2855. </div><div class="memdoc">

  2856. <p>Set the file's current position to zero. </p>

  2857. 

  2858. </div>

  2859. </div>

  2860. <a class="anchor" id="ae1419603dea25a6c8480b941d7ac63a3"></a>

  2861. <div class="memitem">

  2862. <div class="memproto">

  2863. <table class="mlabels">

  2864.   <tr>

  2865.   <td class="mlabels-left">

  2866.       <table class="memname">

  2867.         <tr>

  2868.           <td class="memname">void File::rewindDirectory </td>

  2869.           <td>(</td>

  2870.           <td class="paramname"></td><td>)</td>

  2871.           <td></td>

  2872.         </tr>

  2873.       </table>

  2874.   </td>

  2875.   <td class="mlabels-right">

  2876. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2877.   </tr>

  2878. </table>

  2879. </div><div class="memdoc">

  2880. <p>Rewind a file if it is a directory </p>

  2881. 

  2882. </div>

  2883. </div>

  2884. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2885. <div class="memitem">

  2886. <div class="memproto">

  2887. <table class="mlabels">

  2888.   <tr>

  2889.   <td class="mlabels-left">

  2890.       <table class="memname">

  2891.         <tr>

  2892.           <td class="memname">bool FatFile::rmdir </td>

  2893.           <td>(</td>

  2894.           <td class="paramname"></td><td>)</td>

  2895.           <td></td>

  2896.         </tr>

  2897.       </table>

  2898.   </td>

  2899.   <td class="mlabels-right">

  2900. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2901.   </tr>

  2902. </table>

  2903. </div><div class="memdoc">

  2904. <p>Remove a directory file.</p>

  2905. <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>

  2906. <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>

  2907. <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>

  2908. 

  2909. </div>

  2910. </div>

  2911. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2912. <div class="memitem">

  2913. <div class="memproto">

  2914. <table class="mlabels">

  2915.   <tr>

  2916.   <td class="mlabels-left">

  2917.       <table class="memname">

  2918.         <tr>

  2919.           <td class="memname">bool FatFile::rmRfStar </td>

  2920.           <td>(</td>

  2921.           <td class="paramname"></td><td>)</td>

  2922.           <td></td>

  2923.         </tr>

  2924.       </table>

  2925.   </td>

  2926.   <td class="mlabels-right">

  2927. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2928.   </tr>

  2929. </table>

  2930. </div><div class="memdoc">

  2931. <p>Recursively delete a directory and all contained files.</p>

  2932. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2933. <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>

  2934. <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>

  2935. <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>

  2936. 

  2937. </div>

  2938. </div>

  2939. <a class="anchor" id="a2d41ea52356b769e05e1242685758c08"></a>

  2940. <div class="memitem">

  2941. <div class="memproto">

  2942. <table class="mlabels">

  2943.   <tr>

  2944.   <td class="mlabels-left">

  2945.       <table class="memname">

  2946.         <tr>

  2947.           <td class="memname">bool File::seek </td>

  2948.           <td>(</td>

  2949.           <td class="paramtype">uint32_t&#160;</td>

  2950.           <td class="paramname"><em>pos</em></td><td>)</td>

  2951.           <td></td>

  2952.         </tr>

  2953.       </table>

  2954.   </td>

  2955.   <td class="mlabels-right">

  2956. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2957.   </tr>

  2958. </table>

  2959. </div><div class="memdoc">

  2960. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  2961. <dl class="params"><dt>Parameters</dt><dd>

  2962.   <table class="params">

  2963.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2964.   </table>

  2965.   </dd>

  2966. </dl>

  2967. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2968. 

  2969. </div>

  2970. </div>

  2971. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2972. <div class="memitem">

  2973. <div class="memproto">

  2974. <table class="mlabels">

  2975.   <tr>

  2976.   <td class="mlabels-left">

  2977.       <table class="memname">

  2978.         <tr>

  2979.           <td class="memname">bool FatFile::seekCur </td>

  2980.           <td>(</td>

  2981.           <td class="paramtype">int32_t&#160;</td>

  2982.           <td class="paramname"><em>offset</em></td><td>)</td>

  2983.           <td></td>

  2984.         </tr>

  2985.       </table>

  2986.   </td>

  2987.   <td class="mlabels-right">

  2988. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2989.   </tr>

  2990. </table>

  2991. </div><div class="memdoc">

  2992. <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>

  2993.   <table class="params">

  2994.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2995.   </table>

  2996.   </dd>

  2997. </dl>

  2998. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2999. 

  3000. </div>

  3001. </div>

  3002. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3003. <div class="memitem">

  3004. <div class="memproto">

  3005. <table class="mlabels">

  3006.   <tr>

  3007.   <td class="mlabels-left">

  3008.       <table class="memname">

  3009.         <tr>

  3010.           <td class="memname">bool FatFile::seekEnd </td>

  3011.           <td>(</td>

  3012.           <td class="paramtype">int32_t&#160;</td>

  3013.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3014.           <td></td>

  3015.         </tr>

  3016.       </table>

  3017.   </td>

  3018.   <td class="mlabels-right">

  3019. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3020.   </tr>

  3021. </table>

  3022. </div><div class="memdoc">

  3023. <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>

  3024.   <table class="params">

  3025.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3026.   </table>

  3027.   </dd>

  3028. </dl>

  3029. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3030. 

  3031. </div>

  3032. </div>

  3033. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3034. <div class="memitem">

  3035. <div class="memproto">

  3036. <table class="mlabels">

  3037.   <tr>

  3038.   <td class="mlabels-left">

  3039.       <table class="memname">

  3040.         <tr>

  3041.           <td class="memname">bool FatFile::seekSet </td>

  3042.           <td>(</td>

  3043.           <td class="paramtype">uint32_t&#160;</td>

  3044.           <td class="paramname"><em>pos</em></td><td>)</td>

  3045.           <td></td>

  3046.         </tr>

  3047.       </table>

  3048.   </td>

  3049.   <td class="mlabels-right">

  3050. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3051.   </tr>

  3052. </table>

  3053. </div><div class="memdoc">

  3054. <p>Sets a file's position.</p>

  3055. <dl class="params"><dt>Parameters</dt><dd>

  3056.   <table class="params">

  3057.     <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>

  3058.   </table>

  3059.   </dd>

  3060. </dl>

  3061. <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>

  3062. 

  3063. </div>

  3064. </div>

  3065. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  3066. <div class="memitem">

  3067. <div class="memproto">

  3068. <table class="mlabels">

  3069.   <tr>

  3070.   <td class="mlabels-left">

  3071.       <table class="memname">

  3072.         <tr>

  3073.           <td class="memname">static bool FatFile::setCwd </td>

  3074.           <td>(</td>

  3075.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3076.           <td class="paramname"><em>dir</em></td><td>)</td>

  3077.           <td></td>

  3078.         </tr>

  3079.       </table>

  3080.   </td>

  3081.   <td class="mlabels-right">

  3082. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  3083.   </tr>

  3084. </table>

  3085. </div><div class="memdoc">

  3086. <p>Set the current working directory.</p>

  3087. <dl class="params"><dt>Parameters</dt><dd>

  3088.   <table class="params">

  3089.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  3090.   </table>

  3091.   </dd>

  3092. </dl>

  3093. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  3094. 

  3095. </div>

  3096. </div>

  3097. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  3098. <div class="memitem">

  3099. <div class="memproto">

  3100. <table class="mlabels">

  3101.   <tr>

  3102.   <td class="mlabels-left">

  3103.       <table class="memname">

  3104.         <tr>

  3105.           <td class="memname">void FatFile::setpos </td>

  3106.           <td>(</td>

  3107.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  3108.           <td class="paramname"><em>pos</em></td><td>)</td>

  3109.           <td></td>

  3110.         </tr>

  3111.       </table>

  3112.   </td>

  3113.   <td class="mlabels-right">

  3114. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3115.   </tr>

  3116. </table>

  3117. </div><div class="memdoc">

  3118. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  3119.   <table class="params">

  3120.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  3121.   </table>

  3122.   </dd>

  3123. </dl>

  3124. 

  3125. </div>

  3126. </div>

  3127. <a class="anchor" id="a603d3cd3319142d00a7ebd434970b017"></a>

  3128. <div class="memitem">

  3129. <div class="memproto">

  3130. <table class="mlabels">

  3131.   <tr>

  3132.   <td class="mlabels-left">

  3133.       <table class="memname">

  3134.         <tr>

  3135.           <td class="memname">uint32_t File::size </td>

  3136.           <td>(</td>

  3137.           <td class="paramname"></td><td>)</td>

  3138.           <td></td>

  3139.         </tr>

  3140.       </table>

  3141.   </td>

  3142.   <td class="mlabels-right">

  3143. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3144.   </tr>

  3145. </table>

  3146. </div><div class="memdoc">

  3147. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3148. 

  3149. </div>

  3150. </div>

  3151. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  3152. <div class="memitem">

  3153. <div class="memproto">

  3154. <table class="mlabels">

  3155.   <tr>

  3156.   <td class="mlabels-left">

  3157.       <table class="memname">

  3158.         <tr>

  3159.           <td class="memname">bool FatFile::sync </td>

  3160.           <td>(</td>

  3161.           <td class="paramname"></td><td>)</td>

  3162.           <td></td>

  3163.         </tr>

  3164.       </table>

  3165.   </td>

  3166.   <td class="mlabels-right">

  3167. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3168.   </tr>

  3169. </table>

  3170. </div><div class="memdoc">

  3171. <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>

  3172. <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>

  3173. 

  3174. </div>

  3175. </div>

  3176. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  3177. <div class="memitem">

  3178. <div class="memproto">

  3179. <table class="mlabels">

  3180.   <tr>

  3181.   <td class="mlabels-left">

  3182.       <table class="memname">

  3183.         <tr>

  3184.           <td class="memname">bool FatFile::timestamp </td>

  3185.           <td>(</td>

  3186.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3187.           <td class="paramname"><em>file</em></td><td>)</td>

  3188.           <td></td>

  3189.         </tr>

  3190.       </table>

  3191.   </td>

  3192.   <td class="mlabels-right">

  3193. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3194.   </tr>

  3195. </table>

  3196. </div><div class="memdoc">

  3197. <p>Copy a file's timestamps</p>

  3198. <dl class="params"><dt>Parameters</dt><dd>

  3199.   <table class="params">

  3200.     <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>

  3201.   </table>

  3202.   </dd>

  3203. </dl>

  3204. <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>

  3205. <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>

  3206. 

  3207. </div>

  3208. </div>

  3209. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3210. <div class="memitem">

  3211. <div class="memproto">

  3212. <table class="mlabels">

  3213.   <tr>

  3214.   <td class="mlabels-left">

  3215.       <table class="memname">

  3216.         <tr>

  3217.           <td class="memname">bool FatFile::timestamp </td>

  3218.           <td>(</td>

  3219.           <td class="paramtype">uint8_t&#160;</td>

  3220.           <td class="paramname"><em>flags</em>, </td>

  3221.         </tr>

  3222.         <tr>

  3223.           <td class="paramkey"></td>

  3224.           <td></td>

  3225.           <td class="paramtype">uint16_t&#160;</td>

  3226.           <td class="paramname"><em>year</em>, </td>

  3227.         </tr>

  3228.         <tr>

  3229.           <td class="paramkey"></td>

  3230.           <td></td>

  3231.           <td class="paramtype">uint8_t&#160;</td>

  3232.           <td class="paramname"><em>month</em>, </td>

  3233.         </tr>

  3234.         <tr>

  3235.           <td class="paramkey"></td>

  3236.           <td></td>

  3237.           <td class="paramtype">uint8_t&#160;</td>

  3238.           <td class="paramname"><em>day</em>, </td>

  3239.         </tr>

  3240.         <tr>

  3241.           <td class="paramkey"></td>

  3242.           <td></td>

  3243.           <td class="paramtype">uint8_t&#160;</td>

  3244.           <td class="paramname"><em>hour</em>, </td>

  3245.         </tr>

  3246.         <tr>

  3247.           <td class="paramkey"></td>

  3248.           <td></td>

  3249.           <td class="paramtype">uint8_t&#160;</td>

  3250.           <td class="paramname"><em>minute</em>, </td>

  3251.         </tr>

  3252.         <tr>

  3253.           <td class="paramkey"></td>

  3254.           <td></td>

  3255.           <td class="paramtype">uint8_t&#160;</td>

  3256.           <td class="paramname"><em>second</em>&#160;</td>

  3257.         </tr>

  3258.         <tr>

  3259.           <td></td>

  3260.           <td>)</td>

  3261.           <td></td><td></td>

  3262.         </tr>

  3263.       </table>

  3264.   </td>

  3265.   <td class="mlabels-right">

  3266. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3267.   </tr>

  3268. </table>

  3269. </div><div class="memdoc">

  3270. <p>Set a file's timestamps in its directory entry.</p>

  3271. <dl class="params"><dt>Parameters</dt><dd>

  3272.   <table class="params">

  3273.     <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>

  3274.   </table>

  3275.   </dd>

  3276. </dl>

  3277. <p>T_ACCESS - Set the file's last access date.</p>

  3278. <p>T_CREATE - Set the file's creation date and time.</p>

  3279. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3280. <dl class="params"><dt>Parameters</dt><dd>

  3281.   <table class="params">

  3282.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3283.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3284.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3285.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3286.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3287.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3288.   </table>

  3289.   </dd>

  3290. </dl>

  3291. <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>

  3292. <dd>

  3293. 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>

  3294. <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>

  3295. 

  3296. </div>

  3297. </div>

  3298. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3299. <div class="memitem">

  3300. <div class="memproto">

  3301. <table class="mlabels">

  3302.   <tr>

  3303.   <td class="mlabels-left">

  3304.       <table class="memname">

  3305.         <tr>

  3306.           <td class="memname">bool FatFile::truncate </td>

  3307.           <td>(</td>

  3308.           <td class="paramtype">uint32_t&#160;</td>

  3309.           <td class="paramname"><em>length</em></td><td>)</td>

  3310.           <td></td>

  3311.         </tr>

  3312.       </table>

  3313.   </td>

  3314.   <td class="mlabels-right">

  3315. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3316.   </tr>

  3317. </table>

  3318. </div><div class="memdoc">

  3319. <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>

  3320. <dl class="params"><dt>Parameters</dt><dd>

  3321.   <table class="params">

  3322.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3323.   </table>

  3324.   </dd>

  3325. </dl>

  3326. <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>

  3327. 

  3328. </div>

  3329. </div>

  3330. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3331. <div class="memitem">

  3332. <div class="memproto">

  3333. <table class="mlabels">

  3334.   <tr>

  3335.   <td class="mlabels-left">

  3336.       <table class="memname">

  3337.         <tr>

  3338.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3339.           <td>(</td>

  3340.           <td class="paramname"></td><td>)</td>

  3341.           <td> const</td>

  3342.         </tr>

  3343.       </table>

  3344.   </td>

  3345.   <td class="mlabels-right">

  3346. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3347.   </tr>

  3348. </table>

  3349. </div><div class="memdoc">

  3350. <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>

  3351. 

  3352. </div>

  3353. </div>

  3354. <a class="anchor" id="a618a6b2b7e81bfb93e0d3c158f614f90"></a>

  3355. <div class="memitem">

  3356. <div class="memproto">

  3357. <table class="mlabels">

  3358.   <tr>

  3359.   <td class="mlabels-left">

  3360.       <table class="memname">

  3361.         <tr>

  3362.           <td class="memname">size_t File::write </td>

  3363.           <td>(</td>

  3364.           <td class="paramtype">uint8_t&#160;</td>

  3365.           <td class="paramname"><em>b</em></td><td>)</td>

  3366.           <td></td>

  3367.         </tr>

  3368.       </table>

  3369.   </td>

  3370.   <td class="mlabels-right">

  3371. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3372.   </tr>

  3373. </table>

  3374. </div><div class="memdoc">

  3375. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3376.   <table class="params">

  3377.     <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>

  3378.   </table>

  3379.   </dd>

  3380. </dl>

  3381. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3382. 

  3383. </div>

  3384. </div>

  3385. <a class="anchor" id="aa531c1641a2363e1f6b9d103f37433da"></a>

  3386. <div class="memitem">

  3387. <div class="memproto">

  3388. <table class="mlabels">

  3389.   <tr>

  3390.   <td class="mlabels-left">

  3391.       <table class="memname">

  3392.         <tr>

  3393.           <td class="memname">size_t File::write </td>

  3394.           <td>(</td>

  3395.           <td class="paramtype">const uint8_t *&#160;</td>

  3396.           <td class="paramname"><em>buf</em>, </td>

  3397.         </tr>

  3398.         <tr>

  3399.           <td class="paramkey"></td>

  3400.           <td></td>

  3401.           <td class="paramtype">size_t&#160;</td>

  3402.           <td class="paramname"><em>size</em>&#160;</td>

  3403.         </tr>

  3404.         <tr>

  3405.           <td></td>

  3406.           <td>)</td>

  3407.           <td></td><td></td>

  3408.         </tr>

  3409.       </table>

  3410.   </td>

  3411.   <td class="mlabels-right">

  3412. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3413.   </tr>

  3414. </table>

  3415. </div><div class="memdoc">

  3416. <p>Write data to an open file. Form required by Print.</p>

  3417. <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>

  3418. <dl class="params"><dt>Parameters</dt><dd>

  3419.   <table class="params">

  3420.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3421.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3422.   </table>

  3423.   </dd>

  3424. </dl>

  3425. <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>

  3426. 

  3427. </div>

  3428. </div>

  3429. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  3430. <div class="memitem">

  3431. <div class="memproto">

  3432. <table class="mlabels">

  3433.   <tr>

  3434.   <td class="mlabels-left">

  3435.       <table class="memname">

  3436.         <tr>

  3437.           <td class="memname">int FatFile::write </td>

  3438.           <td>(</td>

  3439.           <td class="paramtype">const char *&#160;</td>

  3440.           <td class="paramname"><em>str</em></td><td>)</td>

  3441.           <td></td>

  3442.         </tr>

  3443.       </table>

  3444.   </td>

  3445.   <td class="mlabels-right">

  3446. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3447.   </tr>

  3448. </table>

  3449. </div><div class="memdoc">

  3450. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3451.   <table class="params">

  3452.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3453.   </table>

  3454.   </dd>

  3455. </dl>

  3456. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3457. 

  3458. </div>

  3459. </div>

  3460. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3461. <div class="memitem">

  3462. <div class="memproto">

  3463. <table class="mlabels">

  3464.   <tr>

  3465.   <td class="mlabels-left">

  3466.       <table class="memname">

  3467.         <tr>

  3468.           <td class="memname">int FatFile::write </td>

  3469.           <td>(</td>

  3470.           <td class="paramtype">const void *&#160;</td>

  3471.           <td class="paramname"><em>buf</em>, </td>

  3472.         </tr>

  3473.         <tr>

  3474.           <td class="paramkey"></td>

  3475.           <td></td>

  3476.           <td class="paramtype">size_t&#160;</td>

  3477.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3478.         </tr>

  3479.         <tr>

  3480.           <td></td>

  3481.           <td>)</td>

  3482.           <td></td><td></td>

  3483.         </tr>

  3484.       </table>

  3485.   </td>

  3486.   <td class="mlabels-right">

  3487. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3488.   </tr>

  3489. </table>

  3490. </div><div class="memdoc">

  3491. <p>Write data to an open file.</p>

  3492. <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>

  3493. <dl class="params"><dt>Parameters</dt><dd>

  3494.   <table class="params">

  3495.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3496.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3497.   </table>

  3498.   </dd>

  3499. </dl>

  3500. <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>

  3501. 

  3502. </div>

  3503. </div>

  3504. <hr/>The documentation for this class was generated from the following file:<ul>

  3505. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_arduino_files_8h.html">ArduinoFiles.h</a></li>

  3506. </ul>

  3507. </div><!-- contents -->

  3508. <!-- start footer part -->

  3509. <hr class="footer"/><address class="footer"><small>

  3510. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3511. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3512. </a> 1.8.10

  3513. </small></address>

  3514. </body>

  3515. </html>