visus
/
teensy-sdfat
Bevaka 1
Stjärnmärk 0
Förgrening 0
Kod Ärenden 0 Pull-förfrågningar 0 Släpp 0 Wiki Aktiviteter
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
12 Incheckningar
1 Gren
Träd: d60a3ab342
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från 'd60a3ab342'
${ noResults }
teensy-sdfat/html/class_file.html

3480 lines
154KB
Rå Blame Historik 

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

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

  3. <head>

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

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

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

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

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

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

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

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

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

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

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

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

  74. 

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

  76. <div id="MSearchResultsWindow">

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

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

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for File:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_sd_base_file.html" title="SdBaseFile base for SdFile and File. " alt="" coords="5,80,93,107"/>
<area shape="rect" id="node4" href="class_fat_file.html" title="Basic file class. " alt="" coords="18,5,80,32"/>
</map>

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

  104. <div class="dynheader">

  105. Collaboration diagram for File:</div>

  106. <div class="dyncontent">

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

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

  109. <area shape="rect" id="node2" href="class_sd_base_file.html" title="SdBaseFile base for SdFile and File. " alt="" coords="5,80,93,107"/>
<area shape="rect" id="node4" href="class_fat_file.html" title="Basic file class. " alt="" coords="18,5,80,32"/>
</map>

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

  111. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  158. <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#ac6cd06ab1b72eb2d22ef41a65eded00b">name</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  186. <tr class="memitem:a925b3badddc0f9472730a4ccd4ff7b67"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base_file.html#a925b3badddc0f9472730a4ccd4ff7b67">ls</a> (uint8_t flags=0)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  230. <tr class="memitem:add1a682e60aa3d8c030805122d5aa4e3"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base_file.html#add1a682e60aa3d8c030805122d5aa4e3">printName</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  291. <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#ac6cd06ab1b72eb2d22ef41a65eded00b">name</a>)</td></tr>

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

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

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

  295. <tr class="memitem:a9f73ca0c68654c3dc8fa7c818f2cfe9f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base_file.html#a9f73ca0c68654c3dc8fa7c818f2cfe9f">printFatDate</a> (uint16_t fatDate)</td></tr>

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

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

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

  299. <tr class="memitem:a9dbde542faa736b47c524205325463bb"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base_file.html#a9dbde542faa736b47c524205325463bb">printFatTime</a> (uint16_t fatTime)</td></tr>

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

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

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

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

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

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

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

  307. </table>

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

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

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

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

  312. <div class="memitem">

  313. <div class="memproto">

  314. <table class="mlabels">

  315.   <tr>

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

  317.       <table class="memname">

  318.         <tr>

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

  320.           <td>(</td>

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

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

  323.         </tr>

  324.         <tr>

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

  326.           <td></td>

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

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

  329.         </tr>

  330.         <tr>

  331.           <td></td>

  332.           <td>)</td>

  333.           <td></td><td></td>

  334.         </tr>

  335.       </table>

  336.   </td>

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

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

  339.   </tr>

  340. </table>

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

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

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

  344.   <table class="params">

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

  346.     <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 SdBaseFile::open(SdBaseFile*, const char*, uint8_t). </td></tr>

  347.   </table>

  348.   </dd>

  349. </dl>

  350. 

  351. </div>

  352. </div>

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

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

  355. <div class="memitem">

  356. <div class="memproto">

  357. <table class="mlabels">

  358.   <tr>

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

  360.       <table class="memname">

  361.         <tr>

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

  363.           <td>(</td>

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

  365.           <td></td>

  366.         </tr>

  367.       </table>

  368.   </td>

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

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

  371.   </tr>

  372. </table>

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

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

  375. 

  376. </div>

  377. </div>

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

  379. <div class="memitem">

  380. <div class="memproto">

  381. <table class="mlabels">

  382.   <tr>

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

  384.       <table class="memname">

  385.         <tr>

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

  387.           <td>(</td>

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

  389.           <td></td>

  390.         </tr>

  391.       </table>

  392.   </td>

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

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

  395.   </tr>

  396. </table>

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

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

  399. 

  400. </div>

  401. </div>

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

  403. <div class="memitem">

  404. <div class="memproto">

  405. <table class="mlabels">

  406.   <tr>

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

  408.       <table class="memname">

  409.         <tr>

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

  411.           <td>(</td>

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

  413.           <td></td>

  414.         </tr>

  415.       </table>

  416.   </td>

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

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

  419.   </tr>

  420. </table>

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

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

  423. 

  424. </div>

  425. </div>

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

  427. <div class="memitem">

  428. <div class="memproto">

  429. <table class="mlabels">

  430.   <tr>

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

  432.       <table class="memname">

  433.         <tr>

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

  435.           <td>(</td>

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

  437.           <td></td>

  438.         </tr>

  439.       </table>

  440.   </td>

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

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

  443.   </tr>

  444. </table>

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

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

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

  448. 

  449. </div>

  450. </div>

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

  452. <div class="memitem">

  453. <div class="memproto">

  454. <table class="mlabels">

  455.   <tr>

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

  457.       <table class="memname">

  458.         <tr>

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

  460.           <td>(</td>

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

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

  463.         </tr>

  464.         <tr>

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

  466.           <td></td>

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

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

  469.         </tr>

  470.         <tr>

  471.           <td></td>

  472.           <td>)</td>

  473.           <td></td><td></td>

  474.         </tr>

  475.       </table>

  476.   </td>

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

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

  479.   </tr>

  480. </table>

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

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

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

  484.   <table class="params">

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

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

  487.   </table>

  488.   </dd>

  489. </dl>

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

  491. 

  492. </div>

  493. </div>

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

  495. <div class="memitem">

  496. <div class="memproto">

  497. <table class="mlabels">

  498.   <tr>

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

  500.       <table class="memname">

  501.         <tr>

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

  503.           <td>(</td>

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

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

  506.         </tr>

  507.         <tr>

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

  509.           <td></td>

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

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

  512.         </tr>

  513.         <tr>

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

  515.           <td></td>

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

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

  518.         </tr>

  519.         <tr>

  520.           <td></td>

  521.           <td>)</td>

  522.           <td></td><td></td>

  523.         </tr>

  524.       </table>

  525.   </td>

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

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

  528.   </tr>

  529. </table>

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

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

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

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

  534.   <table class="params">

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

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

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

  538.   </table>

  539.   </dd>

  540. </dl>

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

  542. 

  543. </div>

  544. </div>

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

  546. <div class="memitem">

  547. <div class="memproto">

  548. <table class="mlabels">

  549.   <tr>

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

  551.       <table class="memname">

  552.         <tr>

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

  554.           <td>(</td>

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

  556.           <td> const</td>

  557.         </tr>

  558.       </table>

  559.   </td>

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

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

  562.   </tr>

  563. </table>

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

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

  566. 

  567. </div>

  568. </div>

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

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

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

  578.           <td>(</td>

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

  580.           <td> const</td>

  581.         </tr>

  582.       </table>

  583.   </td>

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

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

  586.   </tr>

  587. </table>

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

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

  590. 

  591. </div>

  592. </div>

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

  594. <div class="memitem">

  595. <div class="memproto">

  596. <table class="mlabels">

  597.   <tr>

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

  599.       <table class="memname">

  600.         <tr>

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

  602.           <td>(</td>

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

  604.           <td></td>

  605.         </tr>

  606.       </table>

  607.   </td>

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

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

  610.   </tr>

  611. </table>

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

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

  614. 

  615. </div>

  616. </div>

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

  618. <div class="memitem">

  619. <div class="memproto">

  620. <table class="mlabels">

  621.   <tr>

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

  623.       <table class="memname">

  624.         <tr>

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

  626.           <td>(</td>

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

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

  629.           <td></td>

  630.         </tr>

  631.       </table>

  632.   </td>

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

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

  635.   </tr>

  636. </table>

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

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

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

  640.   <table class="params">

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

  642.   </table>

  643.   </dd>

  644. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  659. 

  660. </div>

  661. </div>

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

  663. <div class="memitem">

  664. <div class="memproto">

  665. <table class="mlabels">

  666.   <tr>

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

  668.       <table class="memname">

  669.         <tr>

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

  671.           <td>(</td>

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

  673.           <td></td>

  674.         </tr>

  675.       </table>

  676.   </td>

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

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

  679.   </tr>

  680. </table>

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

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

  683. 

  684. </div>

  685. </div>

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

  687. <div class="memitem">

  688. <div class="memproto">

  689. <table class="mlabels">

  690.   <tr>

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

  692.       <table class="memname">

  693.         <tr>

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

  695.           <td>(</td>

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

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

  698.           <td></td>

  699.         </tr>

  700.       </table>

  701.   </td>

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

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

  704.   </tr>

  705. </table>

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

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

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

  709.   <table class="params">

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

  711.   </table>

  712.   </dd>

  713. </dl>

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

  715. 

  716. </div>

  717. </div>

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

  719. <div class="memitem">

  720. <div class="memproto">

  721. <table class="mlabels">

  722.   <tr>

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

  724.       <table class="memname">

  725.         <tr>

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

  727.           <td>(</td>

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

  729.           <td></td>

  730.         </tr>

  731.       </table>

  732.   </td>

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

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

  735.   </tr>

  736. </table>

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

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

  739. 

  740. </div>

  741. </div>

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

  743. <div class="memitem">

  744. <div class="memproto">

  745. <table class="mlabels">

  746.   <tr>

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

  748.       <table class="memname">

  749.         <tr>

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

  751.           <td>(</td>

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

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

  754.         </tr>

  755.         <tr>

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

  757.           <td></td>

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

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

  760.         </tr>

  761.         <tr>

  762.           <td></td>

  763.           <td>)</td>

  764.           <td></td><td></td>

  765.         </tr>

  766.       </table>

  767.   </td>

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

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

  770.   </tr>

  771. </table>

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

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

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

  775.   <table class="params">

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

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

  778.   </table>

  779.   </dd>

  780. </dl>

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

  782. 

  783. </div>

  784. </div>

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

  786. <div class="memitem">

  787. <div class="memproto">

  788. <table class="mlabels">

  789.   <tr>

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

  791.       <table class="memname">

  792.         <tr>

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

  794.           <td>(</td>

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

  796.           <td></td>

  797.         </tr>

  798.       </table>

  799.   </td>

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

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

  802.   </tr>

  803. </table>

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

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

  806. 

  807. </div>

  808. </div>

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

  810. <div class="memitem">

  811. <div class="memproto">

  812. <table class="mlabels">

  813.   <tr>

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

  815.       <table class="memname">

  816.         <tr>

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

  818.           <td>(</td>

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

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

  821.         </tr>

  822.         <tr>

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

  824.           <td></td>

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

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

  827.         </tr>

  828.         <tr>

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

  830.           <td></td>

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

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

  833.         </tr>

  834.         <tr>

  835.           <td></td>

  836.           <td>)</td>

  837.           <td></td><td></td>

  838.         </tr>

  839.       </table>

  840.   </td>

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

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

  843.   </tr>

  844. </table>

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

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

  847.   <table class="params">

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

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

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

  851.   </table>

  852.   </dd>

  853. </dl>

  854. 

  855. </div>

  856. </div>

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

  858. <div class="memitem">

  859. <div class="memproto">

  860. <table class="mlabels">

  861.   <tr>

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

  863.       <table class="memname">

  864.         <tr>

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

  866.           <td>(</td>

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

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

  869.           <td></td>

  870.         </tr>

  871.       </table>

  872.   </td>

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

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

  875.   </tr>

  876. </table>

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

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

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

  880.   <table class="params">

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

  882.   </table>

  883.   </dd>

  884. </dl>

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

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

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

  888. 

  889. </div>

  890. </div>

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

  892. <div class="memitem">

  893. <div class="memproto">

  894. <table class="mlabels">

  895.   <tr>

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

  897.       <table class="memname">

  898.         <tr>

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

  900.           <td>(</td>

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

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

  903.         </tr>

  904.         <tr>

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

  906.           <td></td>

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

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

  909.         </tr>

  910.         <tr>

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

  912.           <td></td>

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

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

  915.         </tr>

  916.         <tr>

  917.           <td></td>

  918.           <td>)</td>

  919.           <td></td><td></td>

  920.         </tr>

  921.       </table>

  922.   </td>

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

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

  925.   </tr>

  926. </table>

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

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

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

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

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

  932.   <table class="params">

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

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

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

  936.   </table>

  937.   </dd>

  938. </dl>

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

  940. 

  941. </div>

  942. </div>

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

  944. <div class="memitem">

  945. <div class="memproto">

  946. <table class="mlabels">

  947.   <tr>

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

  949.       <table class="memname">

  950.         <tr>

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

  952.           <td>(</td>

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

  954.           <td> const</td>

  955.         </tr>

  956.       </table>

  957.   </td>

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

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

  960.   </tr>

  961. </table>

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

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

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

  965. 

  966. </div>

  967. </div>

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

  969. <div class="memitem">

  970. <div class="memproto">

  971. <table class="mlabels">

  972.   <tr>

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

  974.       <table class="memname">

  975.         <tr>

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

  977.           <td>(</td>

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

  979.           <td> const</td>

  980.         </tr>

  981.       </table>

  982.   </td>

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

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

  985.   </tr>

  986. </table>

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

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

  989. 

  990. </div>

  991. </div>

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

  993. <div class="memitem">

  994. <div class="memproto">

  995. <table class="mlabels">

  996.   <tr>

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

  998.       <table class="memname">

  999.         <tr>

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

  1001.           <td>(</td>

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

  1003.           <td> const</td>

  1004.         </tr>

  1005.       </table>

  1006.   </td>

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

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

  1009.   </tr>

  1010. </table>

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

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

  1013. 

  1014. </div>

  1015. </div>

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

  1017. <div class="memitem">

  1018. <div class="memproto">

  1019. <table class="mlabels">

  1020.   <tr>

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

  1022.       <table class="memname">

  1023.         <tr>

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

  1025.           <td>(</td>

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

  1027.           <td></td>

  1028.         </tr>

  1029.       </table>

  1030.   </td>

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

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

  1033.   </tr>

  1034. </table>

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

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

  1037. 

  1038. </div>

  1039. </div>

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

  1041. <div class="memitem">

  1042. <div class="memproto">

  1043. <table class="mlabels">

  1044.   <tr>

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

  1046.       <table class="memname">

  1047.         <tr>

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

  1049.           <td>(</td>

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

  1051.           <td></td>

  1052.         </tr>

  1053.       </table>

  1054.   </td>

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

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

  1057.   </tr>

  1058. </table>

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

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

  1061. 

  1062. </div>

  1063. </div>

  1064. <a class="anchor" id="a58a8aa8e48c2d4a5ee9585184efcfbfd"></a>

  1065. <div class="memitem">

  1066. <div class="memproto">

  1067. <table class="mlabels">

  1068.   <tr>

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

  1070.       <table class="memname">

  1071.         <tr>

  1072.           <td class="memname">bool FatFile::getFilename </td>

  1073.           <td>(</td>

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

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

  1076.         </tr>

  1077.         <tr>

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

  1079.           <td></td>

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

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

  1082.         </tr>

  1083.         <tr>

  1084.           <td></td>

  1085.           <td>)</td>

  1086.           <td></td><td></td>

  1087.         </tr>

  1088.       </table>

  1089.   </td>

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

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

  1092.   </tr>

  1093. </table>

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

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

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

  1097.   <table class="params">

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

  1099.     <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 name will be truncated if it is too long. </td></tr>

  1100.   </table>

  1101.   </dd>

  1102. </dl>

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

  1104. 

  1105. </div>

  1106. </div>

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

  1108. <div class="memitem">

  1109. <div class="memproto">

  1110. <table class="mlabels">

  1111.   <tr>

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

  1113.       <table class="memname">

  1114.         <tr>

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

  1116.           <td>(</td>

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

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

  1119.           <td></td>

  1120.         </tr>

  1121.       </table>

  1122.   </td>

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

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

  1125.   </tr>

  1126. </table>

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

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

  1129.   <table class="params">

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

  1131.   </table>

  1132.   </dd>

  1133. </dl>

  1134. 

  1135. </div>

  1136. </div>

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

  1138. <div class="memitem">

  1139. <div class="memproto">

  1140. <table class="mlabels">

  1141.   <tr>

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

  1143.       <table class="memname">

  1144.         <tr>

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

  1146.           <td>(</td>

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

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

  1149.           <td></td>

  1150.         </tr>

  1151.       </table>

  1152.   </td>

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

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

  1155.   </tr>

  1156. </table>

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

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

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

  1160.   <table class="params">

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

  1162.   </table>

  1163.   </dd>

  1164. </dl>

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

  1166. 

  1167. </div>

  1168. </div>

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

  1170. <div class="memitem">

  1171. <div class="memproto">

  1172. <table class="mlabels">

  1173.   <tr>

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

  1175.       <table class="memname">

  1176.         <tr>

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

  1178.           <td>(</td>

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

  1180.           <td></td>

  1181.         </tr>

  1182.       </table>

  1183.   </td>

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

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

  1186.   </tr>

  1187. </table>

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

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

  1190. 

  1191. </div>

  1192. </div>

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

  1194. <div class="memitem">

  1195. <div class="memproto">

  1196. <table class="mlabels">

  1197.   <tr>

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

  1199.       <table class="memname">

  1200.         <tr>

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

  1202.           <td>(</td>

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

  1204.           <td> const</td>

  1205.         </tr>

  1206.       </table>

  1207.   </td>

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

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

  1210.   </tr>

  1211. </table>

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

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

  1214. 

  1215. </div>

  1216. </div>

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

  1218. <div class="memitem">

  1219. <div class="memproto">

  1220. <table class="mlabels">

  1221.   <tr>

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

  1223.       <table class="memname">

  1224.         <tr>

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

  1226.           <td>(</td>

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

  1228.           <td></td>

  1229.         </tr>

  1230.       </table>

  1231.   </td>

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

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

  1234.   </tr>

  1235. </table>

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

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

  1238. 

  1239. </div>

  1240. </div>

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

  1242. <div class="memitem">

  1243. <div class="memproto">

  1244. <table class="mlabels">

  1245.   <tr>

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

  1247.       <table class="memname">

  1248.         <tr>

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

  1250.           <td>(</td>

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

  1252.           <td> const</td>

  1253.         </tr>

  1254.       </table>

  1255.   </td>

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

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

  1258.   </tr>

  1259. </table>

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

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

  1262. 

  1263. </div>

  1264. </div>

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

  1266. <div class="memitem">

  1267. <div class="memproto">

  1268. <table class="mlabels">

  1269.   <tr>

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

  1271.       <table class="memname">

  1272.         <tr>

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

  1274.           <td>(</td>

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

  1276.           <td> const</td>

  1277.         </tr>

  1278.       </table>

  1279.   </td>

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

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

  1282.   </tr>

  1283. </table>

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

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

  1286. 

  1287. </div>

  1288. </div>

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

  1290. <div class="memitem">

  1291. <div class="memproto">

  1292. <table class="mlabels">

  1293.   <tr>

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

  1295.       <table class="memname">

  1296.         <tr>

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

  1298.           <td>(</td>

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

  1300.           <td> const</td>

  1301.         </tr>

  1302.       </table>

  1303.   </td>

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

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

  1306.   </tr>

  1307. </table>

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

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

  1310. 

  1311. </div>

  1312. </div>

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

  1314. <div class="memitem">

  1315. <div class="memproto">

  1316. <table class="mlabels">

  1317.   <tr>

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

  1319.       <table class="memname">

  1320.         <tr>

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

  1322.           <td>(</td>

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

  1324.           <td> const</td>

  1325.         </tr>

  1326.       </table>

  1327.   </td>

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

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

  1330.   </tr>

  1331. </table>

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

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

  1334. 

  1335. </div>

  1336. </div>

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

  1338. <div class="memitem">

  1339. <div class="memproto">

  1340. <table class="mlabels">

  1341.   <tr>

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

  1343.       <table class="memname">

  1344.         <tr>

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

  1346.           <td>(</td>

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

  1348.           <td> const</td>

  1349.         </tr>

  1350.       </table>

  1351.   </td>

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

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

  1354.   </tr>

  1355. </table>

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

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

  1358. 

  1359. </div>

  1360. </div>

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

  1362. <div class="memitem">

  1363. <div class="memproto">

  1364. <table class="mlabels">

  1365.   <tr>

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

  1367.       <table class="memname">

  1368.         <tr>

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

  1370.           <td>(</td>

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

  1372.           <td> const</td>

  1373.         </tr>

  1374.       </table>

  1375.   </td>

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

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

  1378.   </tr>

  1379. </table>

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

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

  1382. 

  1383. </div>

  1384. </div>

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

  1386. <div class="memitem">

  1387. <div class="memproto">

  1388. <table class="mlabels">

  1389.   <tr>

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

  1391.       <table class="memname">

  1392.         <tr>

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

  1394.           <td>(</td>

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

  1396.           <td> const</td>

  1397.         </tr>

  1398.       </table>

  1399.   </td>

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

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

  1402.   </tr>

  1403. </table>

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

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

  1406. 

  1407. </div>

  1408. </div>

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

  1410. <div class="memitem">

  1411. <div class="memproto">

  1412. <table class="mlabels">

  1413.   <tr>

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

  1415.       <table class="memname">

  1416.         <tr>

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

  1418.           <td>(</td>

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

  1420.           <td> const</td>

  1421.         </tr>

  1422.       </table>

  1423.   </td>

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

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

  1426.   </tr>

  1427. </table>

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

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

  1430. 

  1431. </div>

  1432. </div>

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

  1434. <div class="memitem">

  1435. <div class="memproto">

  1436. <table class="mlabels">

  1437.   <tr>

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

  1439.       <table class="memname">

  1440.         <tr>

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

  1442.           <td>(</td>

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

  1444.           <td> const</td>

  1445.         </tr>

  1446.       </table>

  1447.   </td>

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

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

  1450.   </tr>

  1451. </table>

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

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

  1454. 

  1455. </div>

  1456. </div>

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

  1458. <div class="memitem">

  1459. <div class="memproto">

  1460. <table class="mlabels">

  1461.   <tr>

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

  1463.       <table class="memname">

  1464.         <tr>

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

  1466.           <td>(</td>

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

  1468.           <td> const</td>

  1469.         </tr>

  1470.       </table>

  1471.   </td>

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

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

  1474.   </tr>

  1475. </table>

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

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

  1478. 

  1479. </div>

  1480. </div>

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

  1482. <div class="memitem">

  1483. <div class="memproto">

  1484. <table class="mlabels">

  1485.   <tr>

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

  1487.       <table class="memname">

  1488.         <tr>

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

  1490.           <td>(</td>

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

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

  1493.           <td></td>

  1494.         </tr>

  1495.       </table>

  1496.   </td>

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

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

  1499.   </tr>

  1500. </table>

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

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

  1503.   <table class="params">

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

  1505.   </table>

  1506.   </dd>

  1507. </dl>

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

  1509. 

  1510. </div>

  1511. </div>

  1512. <a class="anchor" id="a925b3badddc0f9472730a4ccd4ff7b67"></a>

  1513. <div class="memitem">

  1514. <div class="memproto">

  1515. <table class="mlabels">

  1516.   <tr>

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

  1518.       <table class="memname">

  1519.         <tr>

  1520.           <td class="memname">void SdBaseFile::ls </td>

  1521.           <td>(</td>

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

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

  1524.           <td></td>

  1525.         </tr>

  1526.       </table>

  1527.   </td>

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

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

  1530.   </tr>

  1531. </table>

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

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

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

  1535.   <table class="params">

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

  1537.   </table>

  1538.   </dd>

  1539. </dl>

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

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

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

  1543. 

  1544. </div>

  1545. </div>

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

  1547. <div class="memitem">

  1548. <div class="memproto">

  1549. <table class="mlabels">

  1550.   <tr>

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

  1552.       <table class="memname">

  1553.         <tr>

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

  1555.           <td>(</td>

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

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

  1558.         </tr>

  1559.         <tr>

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

  1561.           <td></td>

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

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

  1564.         </tr>

  1565.         <tr>

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

  1567.           <td></td>

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

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

  1570.         </tr>

  1571.         <tr>

  1572.           <td></td>

  1573.           <td>)</td>

  1574.           <td></td><td></td>

  1575.         </tr>

  1576.       </table>

  1577.   </td>

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

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

  1580.   </tr>

  1581. </table>

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

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

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

  1585.   <table class="params">

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

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

  1588.   </table>

  1589.   </dd>

  1590. </dl>

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

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

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

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

  1595.   <table class="params">

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

  1597.   </table>

  1598.   </dd>

  1599. </dl>

  1600. 

  1601. </div>

  1602. </div>

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

  1604. <div class="memitem">

  1605. <div class="memproto">

  1606. <table class="mlabels">

  1607.   <tr>

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

  1609.       <table class="memname">

  1610.         <tr>

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

  1612.           <td>(</td>

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

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

  1615.         </tr>

  1616.         <tr>

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

  1618.           <td></td>

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

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

  1621.         </tr>

  1622.         <tr>

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

  1624.           <td></td>

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

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

  1627.         </tr>

  1628.         <tr>

  1629.           <td></td>

  1630.           <td>)</td>

  1631.           <td></td><td></td>

  1632.         </tr>

  1633.       </table>

  1634.   </td>

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

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

  1637.   </tr>

  1638. </table>

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

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

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

  1642.   <table class="params">

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

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

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

  1646.   </table>

  1647.   </dd>

  1648. </dl>

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

  1650. 

  1651. </div>

  1652. </div>

  1653. <a class="anchor" id="ac6cd06ab1b72eb2d22ef41a65eded00b"></a>

  1654. <div class="memitem">

  1655. <div class="memproto">

  1656. <table class="mlabels">

  1657.   <tr>

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

  1659.       <table class="memname">

  1660.         <tr>

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

  1662.           <td>(</td>

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

  1664.           <td></td>

  1665.         </tr>

  1666.       </table>

  1667.   </td>

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

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

  1670.   </tr>

  1671. </table>

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

  1673. <dl class="section return"><dt>Returns</dt><dd>a pointer to the file's short name. </dd></dl>

  1674. 

  1675. </div>

  1676. </div>

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

  1678. <div class="memitem">

  1679. <div class="memproto">

  1680. <table class="mlabels">

  1681.   <tr>

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

  1683.       <table class="memname">

  1684.         <tr>

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

  1686.           <td>(</td>

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

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

  1689.         </tr>

  1690.         <tr>

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

  1692.           <td></td>

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

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

  1695.         </tr>

  1696.         <tr>

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

  1698.           <td></td>

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

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

  1701.         </tr>

  1702.         <tr>

  1703.           <td></td>

  1704.           <td>)</td>

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

  1706.         </tr>

  1707.       </table>

  1708.   </td>

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

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

  1711.   </tr>

  1712. </table>

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

  1714. <p>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>

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

  1716.   <table class="params">

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

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

  1719.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1720.   </table>

  1721.   </dd>

  1722. </dl>

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

  1724. 

  1725. </div>

  1726. </div>

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

  1728. <div class="memitem">

  1729. <div class="memproto">

  1730. <table class="mlabels">

  1731.   <tr>

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

  1733.       <table class="memname">

  1734.         <tr>

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

  1736.           <td>(</td>

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

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

  1739.         </tr>

  1740.         <tr>

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

  1742.           <td></td>

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

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

  1745.         </tr>

  1746.         <tr>

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

  1748.           <td></td>

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

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

  1751.         </tr>

  1752.         <tr>

  1753.           <td></td>

  1754.           <td>)</td>

  1755.           <td></td><td></td>

  1756.         </tr>

  1757.       </table>

  1758.   </td>

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

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

  1761.   </tr>

  1762. </table>

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

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

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

  1766.   <table class="params">

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

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

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

  1770.   </table>

  1771.   </dd>

  1772. </dl>

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

  1774. 

  1775. </div>

  1776. </div>

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

  1778. <div class="memitem">

  1779. <div class="memproto">

  1780. <table class="mlabels">

  1781.   <tr>

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

  1783.       <table class="memname">

  1784.         <tr>

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

  1786.           <td>(</td>

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

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

  1789.         </tr>

  1790.         <tr>

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

  1792.           <td></td>

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

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

  1795.         </tr>

  1796.         <tr>

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

  1798.           <td></td>

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

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

  1801.         </tr>

  1802.         <tr>

  1803.           <td></td>

  1804.           <td>)</td>

  1805.           <td></td><td></td>

  1806.         </tr>

  1807.       </table>

  1808.   </td>

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

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

  1811.   </tr>

  1812. </table>

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

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

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

  1816.   <table class="params">

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

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

  1819.     <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>

  1820.   </table>

  1821.   </dd>

  1822. </dl>

  1823. <p>O_READ - Open for reading.</p>

  1824. <p>O_RDONLY - Same as O_READ.</p>

  1825. <p>O_WRITE - Open for writing.</p>

  1826. <p>O_WRONLY - Same as O_WRITE.</p>

  1827. <p>O_RDWR - Open for reading and writing.</p>

  1828. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1829. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1830. <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>

  1831. <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>

  1832. <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>

  1833. <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>

  1834. <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>

  1835. <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>

  1836. <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>

  1837. 

  1838. </div>

  1839. </div>

  1840. <a class="anchor" id="ab0e7075062c89f356441f80fc64d03e6"></a>

  1841. <div class="memitem">

  1842. <div class="memproto">

  1843. <table class="mlabels">

  1844.   <tr>

  1845.   <td class="mlabels-left">

  1846.       <table class="memname">

  1847.         <tr>

  1848.           <td class="memname">bool FatFile::open </td>

  1849.           <td>(</td>

  1850.           <td class="paramtype">const char *&#160;</td>

  1851.           <td class="paramname"><em>path</em>, </td>

  1852.         </tr>

  1853.         <tr>

  1854.           <td class="paramkey"></td>

  1855.           <td></td>

  1856.           <td class="paramtype">uint8_t&#160;</td>

  1857.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1858.         </tr>

  1859.         <tr>

  1860.           <td></td>

  1861.           <td>)</td>

  1862.           <td></td><td></td>

  1863.         </tr>

  1864.       </table>

  1865.   </td>

  1866.   <td class="mlabels-right">

  1867. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1868.   </tr>

  1869. </table>

  1870. </div><div class="memdoc">

  1871. <p>Open a file in the current working directory.</p>

  1872. <dl class="params"><dt>Parameters</dt><dd>

  1873.   <table class="params">

  1874.     <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>

  1875.     <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>

  1876.   </table>

  1877.   </dd>

  1878. </dl>

  1879. <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>

  1880. 

  1881. </div>

  1882. </div>

  1883. <a class="anchor" id="a8034c4649eb0d26715b1a8a69e73d9d0"></a>

  1884. <div class="memitem">

  1885. <div class="memproto">

  1886. <table class="mlabels">

  1887.   <tr>

  1888.   <td class="mlabels-left">

  1889.       <table class="memname">

  1890.         <tr>

  1891.           <td class="memname">bool FatFile::openNext </td>

  1892.           <td>(</td>

  1893.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1894.           <td class="paramname"><em>dirFile</em>, </td>

  1895.         </tr>

  1896.         <tr>

  1897.           <td class="paramkey"></td>

  1898.           <td></td>

  1899.           <td class="paramtype">uint8_t&#160;</td>

  1900.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1901.         </tr>

  1902.         <tr>

  1903.           <td></td>

  1904.           <td>)</td>

  1905.           <td></td><td></td>

  1906.         </tr>

  1907.       </table>

  1908.   </td>

  1909.   <td class="mlabels-right">

  1910. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1911.   </tr>

  1912. </table>

  1913. </div><div class="memdoc">

  1914. <p>Open the next file or subdirectory in a directory.</p>

  1915. <dl class="params"><dt>Parameters</dt><dd>

  1916.   <table class="params">

  1917.     <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>

  1918.     <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>

  1919.   </table>

  1920.   </dd>

  1921. </dl>

  1922. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1923. 

  1924. </div>

  1925. </div>

  1926. <a class="anchor" id="acd72000ab1f6a1ce73ac8fbdc854ae0c"></a>

  1927. <div class="memitem">

  1928. <div class="memproto">

  1929. <table class="mlabels">

  1930.   <tr>

  1931.   <td class="mlabels-left">

  1932.       <table class="memname">

  1933.         <tr>

  1934.           <td class="memname"><a class="el" href="class_file.html">File</a> File::openNextFile </td>

  1935.           <td>(</td>

  1936.           <td class="paramtype">uint8_t&#160;</td>

  1937.           <td class="paramname"><em>mode</em> = <code>O_READ</code></td><td>)</td>

  1938.           <td></td>

  1939.         </tr>

  1940.       </table>

  1941.   </td>

  1942.   <td class="mlabels-right">

  1943. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1944.   </tr>

  1945. </table>

  1946. </div><div class="memdoc">

  1947. <p>Opens the next file or folder in a directory.</p>

  1948. <dl class="params"><dt>Parameters</dt><dd>

  1949.   <table class="params">

  1950.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>

  1951.   </table>

  1952.   </dd>

  1953. </dl>

  1954. <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>

  1955. 

  1956. </div>

  1957. </div>

  1958. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1959. <div class="memitem">

  1960. <div class="memproto">

  1961. <table class="mlabels">

  1962.   <tr>

  1963.   <td class="mlabels-left">

  1964.       <table class="memname">

  1965.         <tr>

  1966.           <td class="memname">bool FatFile::openRoot </td>

  1967.           <td>(</td>

  1968.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1969.           <td class="paramname"><em>vol</em></td><td>)</td>

  1970.           <td></td>

  1971.         </tr>

  1972.       </table>

  1973.   </td>

  1974.   <td class="mlabels-right">

  1975. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1976.   </tr>

  1977. </table>

  1978. </div><div class="memdoc">

  1979. <p>Open a volume's root directory.</p>

  1980. <dl class="params"><dt>Parameters</dt><dd>

  1981.   <table class="params">

  1982.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1983.   </table>

  1984.   </dd>

  1985. </dl>

  1986. <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>

  1987. 

  1988. </div>

  1989. </div>

  1990. <a class="anchor" id="af171fbf441c899cf71d88b8b0b83d38b"></a>

  1991. <div class="memitem">

  1992. <div class="memproto">

  1993. <table class="mlabels">

  1994.   <tr>

  1995.   <td class="mlabels-left">

  1996.       <table class="memname">

  1997.         <tr>

  1998.           <td class="memname">File::operator bool </td>

  1999.           <td>(</td>

  2000.           <td class="paramname"></td><td>)</td>

  2001.           <td></td>

  2002.         </tr>

  2003.       </table>

  2004.   </td>

  2005.   <td class="mlabels-right">

  2006. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2007.   </tr>

  2008. </table>

  2009. </div><div class="memdoc">

  2010. <p>The parenthesis operator.</p>

  2011. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2012. 

  2013. </div>

  2014. </div>

  2015. <a class="anchor" id="a0e5025f39bd584563bfe4b05fc1db268"></a>

  2016. <div class="memitem">

  2017. <div class="memproto">

  2018. <table class="mlabels">

  2019.   <tr>

  2020.   <td class="mlabels-left">

  2021.       <table class="memname">

  2022.         <tr>

  2023.           <td class="memname">int File::peek </td>

  2024.           <td>(</td>

  2025.           <td class="paramname"></td><td>)</td>

  2026.           <td></td>

  2027.         </tr>

  2028.       </table>

  2029.   </td>

  2030.   <td class="mlabels-right">

  2031. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2032.   </tr>

  2033. </table>

  2034. </div><div class="memdoc">

  2035. <p>Return the next available byte without consuming it.</p>

  2036. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2037. 

  2038. </div>

  2039. </div>

  2040. <a class="anchor" id="aae991c597c0bc4c5eb44c1f3b06a21ec"></a>

  2041. <div class="memitem">

  2042. <div class="memproto">

  2043. <table class="mlabels">

  2044.   <tr>

  2045.   <td class="mlabels-left">

  2046.       <table class="memname">

  2047.         <tr>

  2048.           <td class="memname">uint32_t File::position </td>

  2049.           <td>(</td>

  2050.           <td class="paramname"></td><td>)</td>

  2051.           <td></td>

  2052.         </tr>

  2053.       </table>

  2054.   </td>

  2055.   <td class="mlabels-right">

  2056. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2057.   </tr>

  2058. </table>

  2059. </div><div class="memdoc">

  2060. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2061. 

  2062. </div>

  2063. </div>

  2064. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  2065. <div class="memitem">

  2066. <div class="memproto">

  2067. <table class="mlabels">

  2068.   <tr>

  2069.   <td class="mlabels-left">

  2070.       <table class="memname">

  2071.         <tr>

  2072.           <td class="memname">bool FatFile::printCreateDateTime </td>

  2073.           <td>(</td>

  2074.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2075.           <td class="paramname"><em>pr</em></td><td>)</td>

  2076.           <td></td>

  2077.         </tr>

  2078.       </table>

  2079.   </td>

  2080.   <td class="mlabels-right">

  2081. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2082.   </tr>

  2083. </table>

  2084. </div><div class="memdoc">

  2085. <p>Print a file's creation date and time</p>

  2086. <dl class="params"><dt>Parameters</dt><dd>

  2087.   <table class="params">

  2088.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2089.   </table>

  2090.   </dd>

  2091. </dl>

  2092. <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>

  2093. 

  2094. </div>

  2095. </div>

  2096. <a class="anchor" id="a9f73ca0c68654c3dc8fa7c818f2cfe9f"></a>

  2097. <div class="memitem">

  2098. <div class="memproto">

  2099. <table class="mlabels">

  2100.   <tr>

  2101.   <td class="mlabels-left">

  2102.       <table class="memname">

  2103.         <tr>

  2104.           <td class="memname">static void SdBaseFile::printFatDate </td>

  2105.           <td>(</td>

  2106.           <td class="paramtype">uint16_t&#160;</td>

  2107.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  2108.           <td></td>

  2109.         </tr>

  2110.       </table>

  2111.   </td>

  2112.   <td class="mlabels-right">

  2113. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2114.   </tr>

  2115. </table>

  2116. </div><div class="memdoc">

  2117. <p>Print a directory date field.</p>

  2118. <p>Format is yyyy-mm-dd.</p>

  2119. <dl class="params"><dt>Parameters</dt><dd>

  2120.   <table class="params">

  2121.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2122.   </table>

  2123.   </dd>

  2124. </dl>

  2125. 

  2126. </div>

  2127. </div>

  2128. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  2129. <div class="memitem">

  2130. <div class="memproto">

  2131. <table class="mlabels">

  2132.   <tr>

  2133.   <td class="mlabels-left">

  2134.       <table class="memname">

  2135.         <tr>

  2136.           <td class="memname">void FatFile::printFatDate </td>

  2137.           <td>(</td>

  2138.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2139.           <td class="paramname"><em>pr</em>, </td>

  2140.         </tr>

  2141.         <tr>

  2142.           <td class="paramkey"></td>

  2143.           <td></td>

  2144.           <td class="paramtype">uint16_t&#160;</td>

  2145.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2146.         </tr>

  2147.         <tr>

  2148.           <td></td>

  2149.           <td>)</td>

  2150.           <td></td><td></td>

  2151.         </tr>

  2152.       </table>

  2153.   </td>

  2154.   <td class="mlabels-right">

  2155. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2156.   </tr>

  2157. </table>

  2158. </div><div class="memdoc">

  2159. <p>Print a directory date field.</p>

  2160. <p>Format is yyyy-mm-dd.</p>

  2161. <dl class="params"><dt>Parameters</dt><dd>

  2162.   <table class="params">

  2163.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2164.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2165.   </table>

  2166.   </dd>

  2167. </dl>

  2168. 

  2169. </div>

  2170. </div>

  2171. <a class="anchor" id="a9dbde542faa736b47c524205325463bb"></a>

  2172. <div class="memitem">

  2173. <div class="memproto">

  2174. <table class="mlabels">

  2175.   <tr>

  2176.   <td class="mlabels-left">

  2177.       <table class="memname">

  2178.         <tr>

  2179.           <td class="memname">static void SdBaseFile::printFatTime </td>

  2180.           <td>(</td>

  2181.           <td class="paramtype">uint16_t&#160;</td>

  2182.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2183.           <td></td>

  2184.         </tr>

  2185.       </table>

  2186.   </td>

  2187.   <td class="mlabels-right">

  2188. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2189.   </tr>

  2190. </table>

  2191. </div><div class="memdoc">

  2192. <p>Print a directory time field.</p>

  2193. <p>Format is hh:mm:ss.</p>

  2194. <dl class="params"><dt>Parameters</dt><dd>

  2195.   <table class="params">

  2196.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2197.   </table>

  2198.   </dd>

  2199. </dl>

  2200. 

  2201. </div>

  2202. </div>

  2203. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2204. <div class="memitem">

  2205. <div class="memproto">

  2206. <table class="mlabels">

  2207.   <tr>

  2208.   <td class="mlabels-left">

  2209.       <table class="memname">

  2210.         <tr>

  2211.           <td class="memname">void FatFile::printFatTime </td>

  2212.           <td>(</td>

  2213.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2214.           <td class="paramname"><em>pr</em>, </td>

  2215.         </tr>

  2216.         <tr>

  2217.           <td class="paramkey"></td>

  2218.           <td></td>

  2219.           <td class="paramtype">uint16_t&#160;</td>

  2220.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2221.         </tr>

  2222.         <tr>

  2223.           <td></td>

  2224.           <td>)</td>

  2225.           <td></td><td></td>

  2226.         </tr>

  2227.       </table>

  2228.   </td>

  2229.   <td class="mlabels-right">

  2230. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2231.   </tr>

  2232. </table>

  2233. </div><div class="memdoc">

  2234. <p>Print a directory time field.</p>

  2235. <p>Format is hh:mm:ss.</p>

  2236. <dl class="params"><dt>Parameters</dt><dd>

  2237.   <table class="params">

  2238.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2239.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2240.   </table>

  2241.   </dd>

  2242. </dl>

  2243. 

  2244. </div>

  2245. </div>

  2246. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2247. <div class="memitem">

  2248. <div class="memproto">

  2249. <table class="mlabels">

  2250.   <tr>

  2251.   <td class="mlabels-left">

  2252.       <table class="memname">

  2253.         <tr>

  2254.           <td class="memname">int FatFile::printField </td>

  2255.           <td>(</td>

  2256.           <td class="paramtype">float&#160;</td>

  2257.           <td class="paramname"><em>value</em>, </td>

  2258.         </tr>

  2259.         <tr>

  2260.           <td class="paramkey"></td>

  2261.           <td></td>

  2262.           <td class="paramtype">char&#160;</td>

  2263.           <td class="paramname"><em>term</em>, </td>

  2264.         </tr>

  2265.         <tr>

  2266.           <td class="paramkey"></td>

  2267.           <td></td>

  2268.           <td class="paramtype">uint8_t&#160;</td>

  2269.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2270.         </tr>

  2271.         <tr>

  2272.           <td></td>

  2273.           <td>)</td>

  2274.           <td></td><td></td>

  2275.         </tr>

  2276.       </table>

  2277.   </td>

  2278.   <td class="mlabels-right">

  2279. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2280.   </tr>

  2281. </table>

  2282. </div><div class="memdoc">

  2283. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2284.   <table class="params">

  2285.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2286.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2287.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2288.   </table>

  2289.   </dd>

  2290. </dl>

  2291. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2292. 

  2293. </div>

  2294. </div>

  2295. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2296. <div class="memitem">

  2297. <div class="memproto">

  2298. <table class="mlabels">

  2299.   <tr>

  2300.   <td class="mlabels-left">

  2301.       <table class="memname">

  2302.         <tr>

  2303.           <td class="memname">int FatFile::printField </td>

  2304.           <td>(</td>

  2305.           <td class="paramtype">int16_t&#160;</td>

  2306.           <td class="paramname"><em>value</em>, </td>

  2307.         </tr>

  2308.         <tr>

  2309.           <td class="paramkey"></td>

  2310.           <td></td>

  2311.           <td class="paramtype">char&#160;</td>

  2312.           <td class="paramname"><em>term</em>&#160;</td>

  2313.         </tr>

  2314.         <tr>

  2315.           <td></td>

  2316.           <td>)</td>

  2317.           <td></td><td></td>

  2318.         </tr>

  2319.       </table>

  2320.   </td>

  2321.   <td class="mlabels-right">

  2322. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2323.   </tr>

  2324. </table>

  2325. </div><div class="memdoc">

  2326. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2327.   <table class="params">

  2328.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2329.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2330.   </table>

  2331.   </dd>

  2332. </dl>

  2333. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2334. 

  2335. </div>

  2336. </div>

  2337. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2338. <div class="memitem">

  2339. <div class="memproto">

  2340. <table class="mlabels">

  2341.   <tr>

  2342.   <td class="mlabels-left">

  2343.       <table class="memname">

  2344.         <tr>

  2345.           <td class="memname">int FatFile::printField </td>

  2346.           <td>(</td>

  2347.           <td class="paramtype">uint16_t&#160;</td>

  2348.           <td class="paramname"><em>value</em>, </td>

  2349.         </tr>

  2350.         <tr>

  2351.           <td class="paramkey"></td>

  2352.           <td></td>

  2353.           <td class="paramtype">char&#160;</td>

  2354.           <td class="paramname"><em>term</em>&#160;</td>

  2355.         </tr>

  2356.         <tr>

  2357.           <td></td>

  2358.           <td>)</td>

  2359.           <td></td><td></td>

  2360.         </tr>

  2361.       </table>

  2362.   </td>

  2363.   <td class="mlabels-right">

  2364. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2365.   </tr>

  2366. </table>

  2367. </div><div class="memdoc">

  2368. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2369.   <table class="params">

  2370.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2371.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2372.   </table>

  2373.   </dd>

  2374. </dl>

  2375. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2376. 

  2377. </div>

  2378. </div>

  2379. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2380. <div class="memitem">

  2381. <div class="memproto">

  2382. <table class="mlabels">

  2383.   <tr>

  2384.   <td class="mlabels-left">

  2385.       <table class="memname">

  2386.         <tr>

  2387.           <td class="memname">int FatFile::printField </td>

  2388.           <td>(</td>

  2389.           <td class="paramtype">int32_t&#160;</td>

  2390.           <td class="paramname"><em>value</em>, </td>

  2391.         </tr>

  2392.         <tr>

  2393.           <td class="paramkey"></td>

  2394.           <td></td>

  2395.           <td class="paramtype">char&#160;</td>

  2396.           <td class="paramname"><em>term</em>&#160;</td>

  2397.         </tr>

  2398.         <tr>

  2399.           <td></td>

  2400.           <td>)</td>

  2401.           <td></td><td></td>

  2402.         </tr>

  2403.       </table>

  2404.   </td>

  2405.   <td class="mlabels-right">

  2406. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2407.   </tr>

  2408. </table>

  2409. </div><div class="memdoc">

  2410. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2411.   <table class="params">

  2412.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2413.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2414.   </table>

  2415.   </dd>

  2416. </dl>

  2417. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2418. 

  2419. </div>

  2420. </div>

  2421. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2422. <div class="memitem">

  2423. <div class="memproto">

  2424. <table class="mlabels">

  2425.   <tr>

  2426.   <td class="mlabels-left">

  2427.       <table class="memname">

  2428.         <tr>

  2429.           <td class="memname">int FatFile::printField </td>

  2430.           <td>(</td>

  2431.           <td class="paramtype">uint32_t&#160;</td>

  2432.           <td class="paramname"><em>value</em>, </td>

  2433.         </tr>

  2434.         <tr>

  2435.           <td class="paramkey"></td>

  2436.           <td></td>

  2437.           <td class="paramtype">char&#160;</td>

  2438.           <td class="paramname"><em>term</em>&#160;</td>

  2439.         </tr>

  2440.         <tr>

  2441.           <td></td>

  2442.           <td>)</td>

  2443.           <td></td><td></td>

  2444.         </tr>

  2445.       </table>

  2446.   </td>

  2447.   <td class="mlabels-right">

  2448. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2449.   </tr>

  2450. </table>

  2451. </div><div class="memdoc">

  2452. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2453.   <table class="params">

  2454.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2455.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2456.   </table>

  2457.   </dd>

  2458. </dl>

  2459. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2460. 

  2461. </div>

  2462. </div>

  2463. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2464. <div class="memitem">

  2465. <div class="memproto">

  2466. <table class="mlabels">

  2467.   <tr>

  2468.   <td class="mlabels-left">

  2469.       <table class="memname">

  2470.         <tr>

  2471.           <td class="memname">size_t FatFile::printFileSize </td>

  2472.           <td>(</td>

  2473.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2474.           <td class="paramname"><em>pr</em></td><td>)</td>

  2475.           <td></td>

  2476.         </tr>

  2477.       </table>

  2478.   </td>

  2479.   <td class="mlabels-right">

  2480. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2481.   </tr>

  2482. </table>

  2483. </div><div class="memdoc">

  2484. <p>Print a file's size.</p>

  2485. <dl class="params"><dt>Parameters</dt><dd>

  2486.   <table class="params">

  2487.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2488.   </table>

  2489.   </dd>

  2490. </dl>

  2491. <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>

  2492. 

  2493. </div>

  2494. </div>

  2495. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2496. <div class="memitem">

  2497. <div class="memproto">

  2498. <table class="mlabels">

  2499.   <tr>

  2500.   <td class="mlabels-left">

  2501.       <table class="memname">

  2502.         <tr>

  2503.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2504.           <td>(</td>

  2505.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2506.           <td class="paramname"><em>pr</em></td><td>)</td>

  2507.           <td></td>

  2508.         </tr>

  2509.       </table>

  2510.   </td>

  2511.   <td class="mlabels-right">

  2512. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2513.   </tr>

  2514. </table>

  2515. </div><div class="memdoc">

  2516. <p>Print a file's modify date and time</p>

  2517. <dl class="params"><dt>Parameters</dt><dd>

  2518.   <table class="params">

  2519.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2520.   </table>

  2521.   </dd>

  2522. </dl>

  2523. <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>

  2524. 

  2525. </div>

  2526. </div>

  2527. <a class="anchor" id="add1a682e60aa3d8c030805122d5aa4e3"></a>

  2528. <div class="memitem">

  2529. <div class="memproto">

  2530. <table class="mlabels">

  2531.   <tr>

  2532.   <td class="mlabels-left">

  2533.       <table class="memname">

  2534.         <tr>

  2535.           <td class="memname">size_t SdBaseFile::printName </td>

  2536.           <td>(</td>

  2537.           <td class="paramname"></td><td>)</td>

  2538.           <td></td>

  2539.         </tr>

  2540.       </table>

  2541.   </td>

  2542.   <td class="mlabels-right">

  2543. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2544.   </tr>

  2545. </table>

  2546. </div><div class="memdoc">

  2547. <p>Print a file's name.</p>

  2548. <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>

  2549. 

  2550. </div>

  2551. </div>

  2552. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2553. <div class="memitem">

  2554. <div class="memproto">

  2555. <table class="mlabels">

  2556.   <tr>

  2557.   <td class="mlabels-left">

  2558.       <table class="memname">

  2559.         <tr>

  2560.           <td class="memname">size_t FatFile::printName </td>

  2561.           <td>(</td>

  2562.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2563.           <td class="paramname"><em>pr</em></td><td>)</td>

  2564.           <td></td>

  2565.         </tr>

  2566.       </table>

  2567.   </td>

  2568.   <td class="mlabels-right">

  2569. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2570.   </tr>

  2571. </table>

  2572. </div><div class="memdoc">

  2573. <p>Print a file's name</p>

  2574. <dl class="params"><dt>Parameters</dt><dd>

  2575.   <table class="params">

  2576.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2577.   </table>

  2578.   </dd>

  2579. </dl>

  2580. <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>

  2581. 

  2582. </div>

  2583. </div>

  2584. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2585. <div class="memitem">

  2586. <div class="memproto">

  2587. <table class="mlabels">

  2588.   <tr>

  2589.   <td class="mlabels-left">

  2590.       <table class="memname">

  2591.         <tr>

  2592.           <td class="memname">size_t FatFile::printSFN </td>

  2593.           <td>(</td>

  2594.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2595.           <td class="paramname"><em>pr</em></td><td>)</td>

  2596.           <td></td>

  2597.         </tr>

  2598.       </table>

  2599.   </td>

  2600.   <td class="mlabels-right">

  2601. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2602.   </tr>

  2603. </table>

  2604. </div><div class="memdoc">

  2605. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2606. <dl class="params"><dt>Parameters</dt><dd>

  2607.   <table class="params">

  2608.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2609.   </table>

  2610.   </dd>

  2611. </dl>

  2612. <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>

  2613. 

  2614. </div>

  2615. </div>

  2616. <a class="anchor" id="a4c46a1975e66c37977bf07c58ec10b4e"></a>

  2617. <div class="memitem">

  2618. <div class="memproto">

  2619. <table class="mlabels">

  2620.   <tr>

  2621.   <td class="mlabels-left">

  2622.       <table class="memname">

  2623.         <tr>

  2624.           <td class="memname">int File::read </td>

  2625.           <td>(</td>

  2626.           <td class="paramname"></td><td>)</td>

  2627.           <td></td>

  2628.         </tr>

  2629.       </table>

  2630.   </td>

  2631.   <td class="mlabels-right">

  2632. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2633.   </tr>

  2634. </table>

  2635. </div><div class="memdoc">

  2636. <p>Read the next byte from a file.</p>

  2637. <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>

  2638. 

  2639. </div>

  2640. </div>

  2641. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2642. <div class="memitem">

  2643. <div class="memproto">

  2644. <table class="mlabels">

  2645.   <tr>

  2646.   <td class="mlabels-left">

  2647.       <table class="memname">

  2648.         <tr>

  2649.           <td class="memname">int FatFile::read </td>

  2650.           <td>(</td>

  2651.           <td class="paramtype">void *&#160;</td>

  2652.           <td class="paramname"><em>buf</em>, </td>

  2653.         </tr>

  2654.         <tr>

  2655.           <td class="paramkey"></td>

  2656.           <td></td>

  2657.           <td class="paramtype">size_t&#160;</td>

  2658.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2659.         </tr>

  2660.         <tr>

  2661.           <td></td>

  2662.           <td>)</td>

  2663.           <td></td><td></td>

  2664.         </tr>

  2665.       </table>

  2666.   </td>

  2667.   <td class="mlabels-right">

  2668. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2669.   </tr>

  2670. </table>

  2671. </div><div class="memdoc">

  2672. <p>Read data from a file starting at the current position.</p>

  2673. <dl class="params"><dt>Parameters</dt><dd>

  2674.   <table class="params">

  2675.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2676.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2677.   </table>

  2678.   </dd>

  2679. </dl>

  2680. <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>

  2681. 

  2682. </div>

  2683. </div>

  2684. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2685. <div class="memitem">

  2686. <div class="memproto">

  2687. <table class="mlabels">

  2688.   <tr>

  2689.   <td class="mlabels-left">

  2690.       <table class="memname">

  2691.         <tr>

  2692.           <td class="memname">int8_t FatFile::readDir </td>

  2693.           <td>(</td>

  2694.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2695.           <td class="paramname"><em>dir</em></td><td>)</td>

  2696.           <td></td>

  2697.         </tr>

  2698.       </table>

  2699.   </td>

  2700.   <td class="mlabels-right">

  2701. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2702.   </tr>

  2703. </table>

  2704. </div><div class="memdoc">

  2705. <p>Read the next directory entry from a directory file.</p>

  2706. <dl class="params"><dt>Parameters</dt><dd>

  2707.   <table class="params">

  2708.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2709.   </table>

  2710.   </dd>

  2711. </dl>

  2712. <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>

  2713. 

  2714. </div>

  2715. </div>

  2716. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2717. <div class="memitem">

  2718. <div class="memproto">

  2719. <table class="mlabels">

  2720.   <tr>

  2721.   <td class="mlabels-left">

  2722.       <table class="memname">

  2723.         <tr>

  2724.           <td class="memname">bool FatFile::remove </td>

  2725.           <td>(</td>

  2726.           <td class="paramname"></td><td>)</td>

  2727.           <td></td>

  2728.         </tr>

  2729.       </table>

  2730.   </td>

  2731.   <td class="mlabels-right">

  2732. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2733.   </tr>

  2734. </table>

  2735. </div><div class="memdoc">

  2736. <p>Remove a file.</p>

  2737. <p>The directory entry and all data for the file are deleted.</p>

  2738. <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>

  2739. <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>

  2740. 

  2741. </div>

  2742. </div>

  2743. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2744. <div class="memitem">

  2745. <div class="memproto">

  2746. <table class="mlabels">

  2747.   <tr>

  2748.   <td class="mlabels-left">

  2749.       <table class="memname">

  2750.         <tr>

  2751.           <td class="memname">bool FatFile::remove </td>

  2752.           <td>(</td>

  2753.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2754.           <td class="paramname"><em>dirFile</em>, </td>

  2755.         </tr>

  2756.         <tr>

  2757.           <td class="paramkey"></td>

  2758.           <td></td>

  2759.           <td class="paramtype">const char *&#160;</td>

  2760.           <td class="paramname"><em>path</em>&#160;</td>

  2761.         </tr>

  2762.         <tr>

  2763.           <td></td>

  2764.           <td>)</td>

  2765.           <td></td><td></td>

  2766.         </tr>

  2767.       </table>

  2768.   </td>

  2769.   <td class="mlabels-right">

  2770. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2771.   </tr>

  2772. </table>

  2773. </div><div class="memdoc">

  2774. <p>Remove a file.</p>

  2775. <p>The directory entry and all data for the file are deleted.</p>

  2776. <dl class="params"><dt>Parameters</dt><dd>

  2777.   <table class="params">

  2778.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2779.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2780.   </table>

  2781.   </dd>

  2782. </dl>

  2783. <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>

  2784. <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>

  2785. 

  2786. </div>

  2787. </div>

  2788. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2789. <div class="memitem">

  2790. <div class="memproto">

  2791. <table class="mlabels">

  2792.   <tr>

  2793.   <td class="mlabels-left">

  2794.       <table class="memname">

  2795.         <tr>

  2796.           <td class="memname">bool FatFile::rename </td>

  2797.           <td>(</td>

  2798.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2799.           <td class="paramname"><em>dirFile</em>, </td>

  2800.         </tr>

  2801.         <tr>

  2802.           <td class="paramkey"></td>

  2803.           <td></td>

  2804.           <td class="paramtype">const char *&#160;</td>

  2805.           <td class="paramname"><em>newPath</em>&#160;</td>

  2806.         </tr>

  2807.         <tr>

  2808.           <td></td>

  2809.           <td>)</td>

  2810.           <td></td><td></td>

  2811.         </tr>

  2812.       </table>

  2813.   </td>

  2814.   <td class="mlabels-right">

  2815. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2816.   </tr>

  2817. </table>

  2818. </div><div class="memdoc">

  2819. <p>Rename a file or subdirectory.</p>

  2820. <dl class="params"><dt>Parameters</dt><dd>

  2821.   <table class="params">

  2822.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2823.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2824.   </table>

  2825.   </dd>

  2826. </dl>

  2827. <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>

  2828. 

  2829. </div>

  2830. </div>

  2831. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2832. <div class="memitem">

  2833. <div class="memproto">

  2834. <table class="mlabels">

  2835.   <tr>

  2836.   <td class="mlabels-left">

  2837.       <table class="memname">

  2838.         <tr>

  2839.           <td class="memname">void FatFile::rewind </td>

  2840.           <td>(</td>

  2841.           <td class="paramname"></td><td>)</td>

  2842.           <td></td>

  2843.         </tr>

  2844.       </table>

  2845.   </td>

  2846.   <td class="mlabels-right">

  2847. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2848.   </tr>

  2849. </table>

  2850. </div><div class="memdoc">

  2851. <p>Set the file's current position to zero. </p>

  2852. 

  2853. </div>

  2854. </div>

  2855. <a class="anchor" id="ae1419603dea25a6c8480b941d7ac63a3"></a>

  2856. <div class="memitem">

  2857. <div class="memproto">

  2858. <table class="mlabels">

  2859.   <tr>

  2860.   <td class="mlabels-left">

  2861.       <table class="memname">

  2862.         <tr>

  2863.           <td class="memname">void File::rewindDirectory </td>

  2864.           <td>(</td>

  2865.           <td class="paramname"></td><td>)</td>

  2866.           <td></td>

  2867.         </tr>

  2868.       </table>

  2869.   </td>

  2870.   <td class="mlabels-right">

  2871. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2872.   </tr>

  2873. </table>

  2874. </div><div class="memdoc">

  2875. <p>Rewind a file if it is a directory </p>

  2876. 

  2877. </div>

  2878. </div>

  2879. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2880. <div class="memitem">

  2881. <div class="memproto">

  2882. <table class="mlabels">

  2883.   <tr>

  2884.   <td class="mlabels-left">

  2885.       <table class="memname">

  2886.         <tr>

  2887.           <td class="memname">bool FatFile::rmdir </td>

  2888.           <td>(</td>

  2889.           <td class="paramname"></td><td>)</td>

  2890.           <td></td>

  2891.         </tr>

  2892.       </table>

  2893.   </td>

  2894.   <td class="mlabels-right">

  2895. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2896.   </tr>

  2897. </table>

  2898. </div><div class="memdoc">

  2899. <p>Remove a directory file.</p>

  2900. <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>

  2901. <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>

  2902. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2903. 

  2904. </div>

  2905. </div>

  2906. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2907. <div class="memitem">

  2908. <div class="memproto">

  2909. <table class="mlabels">

  2910.   <tr>

  2911.   <td class="mlabels-left">

  2912.       <table class="memname">

  2913.         <tr>

  2914.           <td class="memname">bool FatFile::rmRfStar </td>

  2915.           <td>(</td>

  2916.           <td class="paramname"></td><td>)</td>

  2917.           <td></td>

  2918.         </tr>

  2919.       </table>

  2920.   </td>

  2921.   <td class="mlabels-right">

  2922. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2923.   </tr>

  2924. </table>

  2925. </div><div class="memdoc">

  2926. <p>Recursively delete a directory and all contained files.</p>

  2927. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2928. <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>

  2929. <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>

  2930. <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>

  2931. 

  2932. </div>

  2933. </div>

  2934. <a class="anchor" id="a2d41ea52356b769e05e1242685758c08"></a>

  2935. <div class="memitem">

  2936. <div class="memproto">

  2937. <table class="mlabels">

  2938.   <tr>

  2939.   <td class="mlabels-left">

  2940.       <table class="memname">

  2941.         <tr>

  2942.           <td class="memname">bool File::seek </td>

  2943.           <td>(</td>

  2944.           <td class="paramtype">uint32_t&#160;</td>

  2945.           <td class="paramname"><em>pos</em></td><td>)</td>

  2946.           <td></td>

  2947.         </tr>

  2948.       </table>

  2949.   </td>

  2950.   <td class="mlabels-right">

  2951. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2952.   </tr>

  2953. </table>

  2954. </div><div class="memdoc">

  2955. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  2956. <dl class="params"><dt>Parameters</dt><dd>

  2957.   <table class="params">

  2958.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2959.   </table>

  2960.   </dd>

  2961. </dl>

  2962. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2963. 

  2964. </div>

  2965. </div>

  2966. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2967. <div class="memitem">

  2968. <div class="memproto">

  2969. <table class="mlabels">

  2970.   <tr>

  2971.   <td class="mlabels-left">

  2972.       <table class="memname">

  2973.         <tr>

  2974.           <td class="memname">bool FatFile::seekCur </td>

  2975.           <td>(</td>

  2976.           <td class="paramtype">int32_t&#160;</td>

  2977.           <td class="paramname"><em>offset</em></td><td>)</td>

  2978.           <td></td>

  2979.         </tr>

  2980.       </table>

  2981.   </td>

  2982.   <td class="mlabels-right">

  2983. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2984.   </tr>

  2985. </table>

  2986. </div><div class="memdoc">

  2987. <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>

  2988.   <table class="params">

  2989.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2990.   </table>

  2991.   </dd>

  2992. </dl>

  2993. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2994. 

  2995. </div>

  2996. </div>

  2997. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2998. <div class="memitem">

  2999. <div class="memproto">

  3000. <table class="mlabels">

  3001.   <tr>

  3002.   <td class="mlabels-left">

  3003.       <table class="memname">

  3004.         <tr>

  3005.           <td class="memname">bool FatFile::seekEnd </td>

  3006.           <td>(</td>

  3007.           <td class="paramtype">int32_t&#160;</td>

  3008.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3009.           <td></td>

  3010.         </tr>

  3011.       </table>

  3012.   </td>

  3013.   <td class="mlabels-right">

  3014. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3015.   </tr>

  3016. </table>

  3017. </div><div class="memdoc">

  3018. <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>

  3019.   <table class="params">

  3020.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3021.   </table>

  3022.   </dd>

  3023. </dl>

  3024. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3025. 

  3026. </div>

  3027. </div>

  3028. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3029. <div class="memitem">

  3030. <div class="memproto">

  3031. <table class="mlabels">

  3032.   <tr>

  3033.   <td class="mlabels-left">

  3034.       <table class="memname">

  3035.         <tr>

  3036.           <td class="memname">bool FatFile::seekSet </td>

  3037.           <td>(</td>

  3038.           <td class="paramtype">uint32_t&#160;</td>

  3039.           <td class="paramname"><em>pos</em></td><td>)</td>

  3040.           <td></td>

  3041.         </tr>

  3042.       </table>

  3043.   </td>

  3044.   <td class="mlabels-right">

  3045. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3046.   </tr>

  3047. </table>

  3048. </div><div class="memdoc">

  3049. <p>Sets a file's position.</p>

  3050. <dl class="params"><dt>Parameters</dt><dd>

  3051.   <table class="params">

  3052.     <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>

  3053.   </table>

  3054.   </dd>

  3055. </dl>

  3056. <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>

  3057. 

  3058. </div>

  3059. </div>

  3060. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  3061. <div class="memitem">

  3062. <div class="memproto">

  3063. <table class="mlabels">

  3064.   <tr>

  3065.   <td class="mlabels-left">

  3066.       <table class="memname">

  3067.         <tr>

  3068.           <td class="memname">static bool FatFile::setCwd </td>

  3069.           <td>(</td>

  3070.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3071.           <td class="paramname"><em>dir</em></td><td>)</td>

  3072.           <td></td>

  3073.         </tr>

  3074.       </table>

  3075.   </td>

  3076.   <td class="mlabels-right">

  3077. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  3078.   </tr>

  3079. </table>

  3080. </div><div class="memdoc">

  3081. <p>Set the current working directory.</p>

  3082. <dl class="params"><dt>Parameters</dt><dd>

  3083.   <table class="params">

  3084.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  3085.   </table>

  3086.   </dd>

  3087. </dl>

  3088. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  3089. 

  3090. </div>

  3091. </div>

  3092. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  3093. <div class="memitem">

  3094. <div class="memproto">

  3095. <table class="mlabels">

  3096.   <tr>

  3097.   <td class="mlabels-left">

  3098.       <table class="memname">

  3099.         <tr>

  3100.           <td class="memname">void FatFile::setpos </td>

  3101.           <td>(</td>

  3102.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  3103.           <td class="paramname"><em>pos</em></td><td>)</td>

  3104.           <td></td>

  3105.         </tr>

  3106.       </table>

  3107.   </td>

  3108.   <td class="mlabels-right">

  3109. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3110.   </tr>

  3111. </table>

  3112. </div><div class="memdoc">

  3113. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  3114.   <table class="params">

  3115.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  3116.   </table>

  3117.   </dd>

  3118. </dl>

  3119. 

  3120. </div>

  3121. </div>

  3122. <a class="anchor" id="a603d3cd3319142d00a7ebd434970b017"></a>

  3123. <div class="memitem">

  3124. <div class="memproto">

  3125. <table class="mlabels">

  3126.   <tr>

  3127.   <td class="mlabels-left">

  3128.       <table class="memname">

  3129.         <tr>

  3130.           <td class="memname">uint32_t File::size </td>

  3131.           <td>(</td>

  3132.           <td class="paramname"></td><td>)</td>

  3133.           <td></td>

  3134.         </tr>

  3135.       </table>

  3136.   </td>

  3137.   <td class="mlabels-right">

  3138. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3139.   </tr>

  3140. </table>

  3141. </div><div class="memdoc">

  3142. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3143. 

  3144. </div>

  3145. </div>

  3146. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  3147. <div class="memitem">

  3148. <div class="memproto">

  3149. <table class="mlabels">

  3150.   <tr>

  3151.   <td class="mlabels-left">

  3152.       <table class="memname">

  3153.         <tr>

  3154.           <td class="memname">bool FatFile::sync </td>

  3155.           <td>(</td>

  3156.           <td class="paramname"></td><td>)</td>

  3157.           <td></td>

  3158.         </tr>

  3159.       </table>

  3160.   </td>

  3161.   <td class="mlabels-right">

  3162. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3163.   </tr>

  3164. </table>

  3165. </div><div class="memdoc">

  3166. <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>

  3167. <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>

  3168. 

  3169. </div>

  3170. </div>

  3171. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  3172. <div class="memitem">

  3173. <div class="memproto">

  3174. <table class="mlabels">

  3175.   <tr>

  3176.   <td class="mlabels-left">

  3177.       <table class="memname">

  3178.         <tr>

  3179.           <td class="memname">bool FatFile::timestamp </td>

  3180.           <td>(</td>

  3181.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  3182.           <td class="paramname"><em>file</em></td><td>)</td>

  3183.           <td></td>

  3184.         </tr>

  3185.       </table>

  3186.   </td>

  3187.   <td class="mlabels-right">

  3188. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3189.   </tr>

  3190. </table>

  3191. </div><div class="memdoc">

  3192. <p>Copy a file's timestamps</p>

  3193. <dl class="params"><dt>Parameters</dt><dd>

  3194.   <table class="params">

  3195.     <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>

  3196.   </table>

  3197.   </dd>

  3198. </dl>

  3199. <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>

  3200. <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>

  3201. 

  3202. </div>

  3203. </div>

  3204. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3205. <div class="memitem">

  3206. <div class="memproto">

  3207. <table class="mlabels">

  3208.   <tr>

  3209.   <td class="mlabels-left">

  3210.       <table class="memname">

  3211.         <tr>

  3212.           <td class="memname">bool FatFile::timestamp </td>

  3213.           <td>(</td>

  3214.           <td class="paramtype">uint8_t&#160;</td>

  3215.           <td class="paramname"><em>flags</em>, </td>

  3216.         </tr>

  3217.         <tr>

  3218.           <td class="paramkey"></td>

  3219.           <td></td>

  3220.           <td class="paramtype">uint16_t&#160;</td>

  3221.           <td class="paramname"><em>year</em>, </td>

  3222.         </tr>

  3223.         <tr>

  3224.           <td class="paramkey"></td>

  3225.           <td></td>

  3226.           <td class="paramtype">uint8_t&#160;</td>

  3227.           <td class="paramname"><em>month</em>, </td>

  3228.         </tr>

  3229.         <tr>

  3230.           <td class="paramkey"></td>

  3231.           <td></td>

  3232.           <td class="paramtype">uint8_t&#160;</td>

  3233.           <td class="paramname"><em>day</em>, </td>

  3234.         </tr>

  3235.         <tr>

  3236.           <td class="paramkey"></td>

  3237.           <td></td>

  3238.           <td class="paramtype">uint8_t&#160;</td>

  3239.           <td class="paramname"><em>hour</em>, </td>

  3240.         </tr>

  3241.         <tr>

  3242.           <td class="paramkey"></td>

  3243.           <td></td>

  3244.           <td class="paramtype">uint8_t&#160;</td>

  3245.           <td class="paramname"><em>minute</em>, </td>

  3246.         </tr>

  3247.         <tr>

  3248.           <td class="paramkey"></td>

  3249.           <td></td>

  3250.           <td class="paramtype">uint8_t&#160;</td>

  3251.           <td class="paramname"><em>second</em>&#160;</td>

  3252.         </tr>

  3253.         <tr>

  3254.           <td></td>

  3255.           <td>)</td>

  3256.           <td></td><td></td>

  3257.         </tr>

  3258.       </table>

  3259.   </td>

  3260.   <td class="mlabels-right">

  3261. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3262.   </tr>

  3263. </table>

  3264. </div><div class="memdoc">

  3265. <p>Set a file's timestamps in its directory entry.</p>

  3266. <dl class="params"><dt>Parameters</dt><dd>

  3267.   <table class="params">

  3268.     <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>

  3269.   </table>

  3270.   </dd>

  3271. </dl>

  3272. <p>T_ACCESS - Set the file's last access date.</p>

  3273. <p>T_CREATE - Set the file's creation date and time.</p>

  3274. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3275. <dl class="params"><dt>Parameters</dt><dd>

  3276.   <table class="params">

  3277.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3278.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3279.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3280.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3281.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3282.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3283.   </table>

  3284.   </dd>

  3285. </dl>

  3286. <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>

  3287. <dd>

  3288. 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>

  3289. <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>

  3290. 

  3291. </div>

  3292. </div>

  3293. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3294. <div class="memitem">

  3295. <div class="memproto">

  3296. <table class="mlabels">

  3297.   <tr>

  3298.   <td class="mlabels-left">

  3299.       <table class="memname">

  3300.         <tr>

  3301.           <td class="memname">bool FatFile::truncate </td>

  3302.           <td>(</td>

  3303.           <td class="paramtype">uint32_t&#160;</td>

  3304.           <td class="paramname"><em>length</em></td><td>)</td>

  3305.           <td></td>

  3306.         </tr>

  3307.       </table>

  3308.   </td>

  3309.   <td class="mlabels-right">

  3310. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3311.   </tr>

  3312. </table>

  3313. </div><div class="memdoc">

  3314. <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>

  3315. <dl class="params"><dt>Parameters</dt><dd>

  3316.   <table class="params">

  3317.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3318.   </table>

  3319.   </dd>

  3320. </dl>

  3321. <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>

  3322. 

  3323. </div>

  3324. </div>

  3325. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3326. <div class="memitem">

  3327. <div class="memproto">

  3328. <table class="mlabels">

  3329.   <tr>

  3330.   <td class="mlabels-left">

  3331.       <table class="memname">

  3332.         <tr>

  3333.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3334.           <td>(</td>

  3335.           <td class="paramname"></td><td>)</td>

  3336.           <td> const</td>

  3337.         </tr>

  3338.       </table>

  3339.   </td>

  3340.   <td class="mlabels-right">

  3341. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3342.   </tr>

  3343. </table>

  3344. </div><div class="memdoc">

  3345. <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>

  3346. 

  3347. </div>

  3348. </div>

  3349. <a class="anchor" id="a618a6b2b7e81bfb93e0d3c158f614f90"></a>

  3350. <div class="memitem">

  3351. <div class="memproto">

  3352. <table class="mlabels">

  3353.   <tr>

  3354.   <td class="mlabels-left">

  3355.       <table class="memname">

  3356.         <tr>

  3357.           <td class="memname">size_t File::write </td>

  3358.           <td>(</td>

  3359.           <td class="paramtype">uint8_t&#160;</td>

  3360.           <td class="paramname"><em>b</em></td><td>)</td>

  3361.           <td></td>

  3362.         </tr>

  3363.       </table>

  3364.   </td>

  3365.   <td class="mlabels-right">

  3366. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3367.   </tr>

  3368. </table>

  3369. </div><div class="memdoc">

  3370. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3371.   <table class="params">

  3372.     <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>

  3373.   </table>

  3374.   </dd>

  3375. </dl>

  3376. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3377. 

  3378. </div>

  3379. </div>

  3380. <a class="anchor" id="aa531c1641a2363e1f6b9d103f37433da"></a>

  3381. <div class="memitem">

  3382. <div class="memproto">

  3383. <table class="mlabels">

  3384.   <tr>

  3385.   <td class="mlabels-left">

  3386.       <table class="memname">

  3387.         <tr>

  3388.           <td class="memname">size_t File::write </td>

  3389.           <td>(</td>

  3390.           <td class="paramtype">const uint8_t *&#160;</td>

  3391.           <td class="paramname"><em>buf</em>, </td>

  3392.         </tr>

  3393.         <tr>

  3394.           <td class="paramkey"></td>

  3395.           <td></td>

  3396.           <td class="paramtype">size_t&#160;</td>

  3397.           <td class="paramname"><em>size</em>&#160;</td>

  3398.         </tr>

  3399.         <tr>

  3400.           <td></td>

  3401.           <td>)</td>

  3402.           <td></td><td></td>

  3403.         </tr>

  3404.       </table>

  3405.   </td>

  3406.   <td class="mlabels-right">

  3407. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  3408.   </tr>

  3409. </table>

  3410. </div><div class="memdoc">

  3411. <p>Write data to an open file. Form required by Print.</p>

  3412. <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>

  3413. <dl class="params"><dt>Parameters</dt><dd>

  3414.   <table class="params">

  3415.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3416.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3417.   </table>

  3418.   </dd>

  3419. </dl>

  3420. <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>

  3421. 

  3422. </div>

  3423. </div>

  3424. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3425. <div class="memitem">

  3426. <div class="memproto">

  3427. <table class="mlabels">

  3428.   <tr>

  3429.   <td class="mlabels-left">

  3430.       <table class="memname">

  3431.         <tr>

  3432.           <td class="memname">int FatFile::write </td>

  3433.           <td>(</td>

  3434.           <td class="paramtype">const void *&#160;</td>

  3435.           <td class="paramname"><em>buf</em>, </td>

  3436.         </tr>

  3437.         <tr>

  3438.           <td class="paramkey"></td>

  3439.           <td></td>

  3440.           <td class="paramtype">size_t&#160;</td>

  3441.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3442.         </tr>

  3443.         <tr>

  3444.           <td></td>

  3445.           <td>)</td>

  3446.           <td></td><td></td>

  3447.         </tr>

  3448.       </table>

  3449.   </td>

  3450.   <td class="mlabels-right">

  3451. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3452.   </tr>

  3453. </table>

  3454. </div><div class="memdoc">

  3455. <p>Write data to an open file.</p>

  3456. <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>

  3457. <dl class="params"><dt>Parameters</dt><dd>

  3458.   <table class="params">

  3459.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3460.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3461.   </table>

  3462.   </dd>

  3463. </dl>

  3464. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">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>

  3465. 

  3466. </div>

  3467. </div>

  3468. <hr/>The documentation for this class was generated from the following file:<ul>

  3469. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_file_8h.html">SdFile.h</a></li>

  3470. </ul>

  3471. </div><!-- contents -->

  3472. <!-- start footer part -->

  3473. <hr class="footer"/><address class="footer"><small>

  3474. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3475. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3476. </a> 1.8.8

  3477. </small></address>

  3478. </body>

  3479. </html>