visus
/
teensy-sdfat
關注 1
收藏 0
複製 0
程式碼 問題 0 合併請求 0 版本發佈 0 Wiki 活動
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 提交
1 分支
目錄樹: d60a3ab342
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'd60a3ab342'
${ noResults }
teensy-sdfat/html/class_sd_base_file.html

3183 line
142KB
原始文件 Blame 歷史記錄 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

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

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

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

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

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

  74. 

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

  76. <div id="MSearchResultsWindow">

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

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

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p><a class="el" href="class_sd_base_file.html" title="SdBaseFile base for SdFile and File. ">SdBaseFile</a> base for <a class="el" href="class_sd_file.html" title="SdFile SdBaseFile with Print. ">SdFile</a> and <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a>.  

  94.  <a href="class_sd_base_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 SdBaseFile:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node5" href="class_file.html" title="Arduino SD.h style File API. " alt="" coords="5,155,48,181"/>
<area shape="rect" id="node7" href="class_sd_file.html" title="SdFile SdBaseFile with Print. " alt="" coords="72,155,131,181"/>
<area shape="rect" id="node2" href="class_fat_file.html" title="Basic file class. " alt="" coords="33,5,95,32"/>
</map>

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

  104. <div class="dynheader">

  105. Collaboration diagram for SdBaseFile:</div>

  106. <div class="dyncontent">

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

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

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

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

  111. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  150. <tr class="memitem: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 *name, size_t size)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  182. <tr class="memitem:acabf31ff85e696fbf384c49428012fea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acabf31ff85e696fbf384c49428012fea">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0, uint8_t indent=0)</td></tr>

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

  184. <tr class="memitem:abab5b9f72cc796388dd4eed01d13d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abab5b9f72cc796388dd4eed01d13d90d">mkdir</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir, const char *path, bool pFlag=true)</td></tr>

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

  186. <tr class="memitem:a5f64576d3d19177ab3cf3812b69abdfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open</a> (<a class="el" href="class_fat_file_system.html">FatFileSystem</a> *fs, const char *path, uint8_t oflag)</td></tr>

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

  188. <tr class="memitem:ad3fa9daaccb4e4179fb88a8ca037aa80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad3fa9daaccb4e4179fb88a8ca037aa80">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, uint8_t oflag)</td></tr>

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

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

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

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

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

  194. <tr class="memitem:a8034c4649eb0d26715b1a8a69e73d9d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8034c4649eb0d26715b1a8a69e73d9d0">openNext</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint8_t oflag=O_READ)</td></tr>

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

  196. <tr class="memitem:a7e0c0548fed3a69e7284b91b694439d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e0c0548fed3a69e7284b91b694439d4">openRoot</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol)</td></tr>

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

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

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

  200. <tr class="memitem:a558530f20314a8d8ee3d1a488fc7f46e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a558530f20314a8d8ee3d1a488fc7f46e">printCreateDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  202. <tr class="memitem:a7478cad0f9e5079311b9e1fa558016ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7478cad0f9e5079311b9e1fa558016ff">printField</a> (float value, char term, uint8_t prec=2)</td></tr>

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

  204. <tr class="memitem:abd3e1747511216462b3ef98167156cbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abd3e1747511216462b3ef98167156cbb">printField</a> (int16_t value, char term)</td></tr>

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

  206. <tr class="memitem:a9972c2419c293ef9c382bff666b9ae4d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9972c2419c293ef9c382bff666b9ae4d">printField</a> (uint16_t value, char term)</td></tr>

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

  208. <tr class="memitem:a41b3b32dd8482429b74c7af3432d6cf8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a41b3b32dd8482429b74c7af3432d6cf8">printField</a> (int32_t value, char term)</td></tr>

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

  210. <tr class="memitem:a097240f08baadeb1c64b63eab9afb088"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a097240f08baadeb1c64b63eab9afb088">printField</a> (uint32_t value, char term)</td></tr>

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

  212. <tr class="memitem:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a12a5d2de2737c201aa39ca1bd2ab9c47">printFileSize</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  214. <tr class="memitem:a05cee5df46a370bf916d3ba597c82e39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a05cee5df46a370bf916d3ba597c82e39">printModifyDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

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

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

  218. <tr class="memitem:afe18a787fb8640e2d2483370c770f82f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe18a787fb8640e2d2483370c770f82f">printName</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  220. <tr class="memitem:a791cd7aade71f609aab62ec018aea3c0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a791cd7aade71f609aab62ec018aea3c0">printSFN</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

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

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

  224. <tr class="memitem:a200e6e0553d5b709520c9dfac9ef77dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a200e6e0553d5b709520c9dfac9ef77dd">read</a> (void *buf, size_t nbyte)</td></tr>

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

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

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

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

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

  230. <tr class="memitem:a4b42f2454ff462555c07ea094a92a1e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4b42f2454ff462555c07ea094a92a1e0">rename</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *newPath)</td></tr>

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

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

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

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

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

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

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

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

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

  240. <tr class="memitem:a5812037ea30777cc350698ad26f2c73f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5812037ea30777cc350698ad26f2c73f">seekCur</a> (int32_t offset)</td></tr>

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

  242. <tr class="memitem:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a84f677f4e75ef6fa2eb632f4cdf6b486">seekEnd</a> (int32_t offset=0)</td></tr>

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

  244. <tr class="memitem:ab067190d25733ed7e697d9890f61fd7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet</a> (uint32_t pos)</td></tr>

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

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

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

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

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

  250. <tr class="memitem:aa53a8d1d2467ad9af7d61cbf8ee85243"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa53a8d1d2467ad9af7d61cbf8ee85243">timestamp</a> (<a class="el" href="class_fat_file.html">FatFile</a> *file)</td></tr>

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

  252. <tr class="memitem:a56dabdf73833b7e961c4530eb8e16d23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a56dabdf73833b7e961c4530eb8e16d23">timestamp</a> (uint8_t flags, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)</td></tr>

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

  254. <tr class="memitem:aa6e663098a578635d37d92e82d18d616"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa6e663098a578635d37d92e82d18d616">truncate</a> (uint32_t length)</td></tr>

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

  256. <tr class="memitem:a3c64bd8a9abb9a6461d4addb405614df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a3c64bd8a9abb9a6461d4addb405614df">volume</a> () const </td></tr>

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

  258. <tr class="memitem:a5524bd9f3b8f54ee163e391cba618186"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write</a> (uint8_t b)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

  271. <tr class="memitem:a648461081fe07578780f4cd3f246cb66"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a648461081fe07578780f4cd3f246cb66">dirName</a> (const <a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir, char *name)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  287. </table>

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

  289. <div class="textblock"><p><a class="el" href="class_sd_base_file.html" title="SdBaseFile base for SdFile and File. ">SdBaseFile</a> base for <a class="el" href="class_sd_file.html" title="SdFile SdBaseFile with Print. ">SdFile</a> and <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a>. </p>

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

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

  292. <div class="memitem">

  293. <div class="memproto">

  294. <table class="mlabels">

  295.   <tr>

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

  297.       <table class="memname">

  298.         <tr>

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

  300.           <td>(</td>

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

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

  303.         </tr>

  304.         <tr>

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

  306.           <td></td>

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

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

  309.         </tr>

  310.         <tr>

  311.           <td></td>

  312.           <td>)</td>

  313.           <td></td><td></td>

  314.         </tr>

  315.       </table>

  316.   </td>

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

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

  319.   </tr>

  320. </table>

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

  322. <p>Constructor with file open.</p>

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

  324.   <table class="params">

  325.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> location and name. </td></tr>

  326.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> open mode. </td></tr>

  327.   </table>

  328.   </dd>

  329. </dl>

  330. 

  331. </div>

  332. </div>

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

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

  335. <div class="memitem">

  336. <div class="memproto">

  337. <table class="mlabels">

  338.   <tr>

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

  340.       <table class="memname">

  341.         <tr>

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

  343.           <td>(</td>

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

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348.   </td>

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

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

  351.   </tr>

  352. </table>

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

  354. <dl class="section return"><dt>Returns</dt><dd>The number of bytes available from the current position to EOF for normal files. Zero is returned for directory files. </dd></dl>

  355. 

  356. </div>

  357. </div>

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

  359. <div class="memitem">

  360. <div class="memproto">

  361. <table class="mlabels">

  362.   <tr>

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

  364.       <table class="memname">

  365.         <tr>

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

  367.           <td>(</td>

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

  369.           <td></td>

  370.         </tr>

  371.       </table>

  372.   </td>

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

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

  375.   </tr>

  376. </table>

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

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

  379. 

  380. </div>

  381. </div>

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

  383. <div class="memitem">

  384. <div class="memproto">

  385. <table class="mlabels">

  386.   <tr>

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

  388.       <table class="memname">

  389.         <tr>

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

  391.           <td>(</td>

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

  393.           <td></td>

  394.         </tr>

  395.       </table>

  396.   </td>

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

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

  399.   </tr>

  400. </table>

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

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

  403. 

  404. </div>

  405. </div>

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

  407. <div class="memitem">

  408. <div class="memproto">

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

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

  415.           <td>(</td>

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

  417.           <td></td>

  418.         </tr>

  419.       </table>

  420.   </td>

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

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

  423.   </tr>

  424. </table>

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

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

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

  428. 

  429. </div>

  430. </div>

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

  432. <div class="memitem">

  433. <div class="memproto">

  434. <table class="mlabels">

  435.   <tr>

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

  437.       <table class="memname">

  438.         <tr>

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

  440.           <td>(</td>

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

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

  443.         </tr>

  444.         <tr>

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

  446.           <td></td>

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

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

  449.         </tr>

  450.         <tr>

  451.           <td></td>

  452.           <td>)</td>

  453.           <td></td><td></td>

  454.         </tr>

  455.       </table>

  456.   </td>

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

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

  459.   </tr>

  460. </table>

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

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

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

  464.   <table class="params">

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

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

  467.   </table>

  468.   </dd>

  469. </dl>

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

  471. 

  472. </div>

  473. </div>

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

  475. <div class="memitem">

  476. <div class="memproto">

  477. <table class="mlabels">

  478.   <tr>

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

  480.       <table class="memname">

  481.         <tr>

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

  483.           <td>(</td>

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

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

  486.         </tr>

  487.         <tr>

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

  489.           <td></td>

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

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

  492.         </tr>

  493.         <tr>

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

  495.           <td></td>

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

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

  498.         </tr>

  499.         <tr>

  500.           <td></td>

  501.           <td>)</td>

  502.           <td></td><td></td>

  503.         </tr>

  504.       </table>

  505.   </td>

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

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

  508.   </tr>

  509. </table>

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

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

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

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

  514.   <table class="params">

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

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

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

  518.   </table>

  519.   </dd>

  520. </dl>

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

  522. 

  523. </div>

  524. </div>

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

  526. <div class="memitem">

  527. <div class="memproto">

  528. <table class="mlabels">

  529.   <tr>

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

  531.       <table class="memname">

  532.         <tr>

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

  534.           <td>(</td>

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

  536.           <td> const</td>

  537.         </tr>

  538.       </table>

  539.   </td>

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

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

  542.   </tr>

  543. </table>

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

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

  546. 

  547. </div>

  548. </div>

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

  550. <div class="memitem">

  551. <div class="memproto">

  552. <table class="mlabels">

  553.   <tr>

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

  555.       <table class="memname">

  556.         <tr>

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

  558.           <td>(</td>

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

  560.           <td> const</td>

  561.         </tr>

  562.       </table>

  563.   </td>

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

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

  566.   </tr>

  567. </table>

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

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

  570. 

  571. </div>

  572. </div>

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

  574. <div class="memitem">

  575. <div class="memproto">

  576. <table class="mlabels">

  577.   <tr>

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

  579.       <table class="memname">

  580.         <tr>

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

  582.           <td>(</td>

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

  584.           <td></td>

  585.         </tr>

  586.       </table>

  587.   </td>

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

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

  590.   </tr>

  591. </table>

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

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

  594. 

  595. </div>

  596. </div>

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

  598. <div class="memitem">

  599. <div class="memproto">

  600. <table class="mlabels">

  601.   <tr>

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

  603.       <table class="memname">

  604.         <tr>

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

  606.           <td>(</td>

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

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

  609.           <td></td>

  610.         </tr>

  611.       </table>

  612.   </td>

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

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

  615.   </tr>

  616. </table>

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

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

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

  620.   <table class="params">

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

  622.   </table>

  623.   </dd>

  624. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  639. 

  640. </div>

  641. </div>

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

  643. <div class="memitem">

  644. <div class="memproto">

  645. <table class="mlabels">

  646.   <tr>

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

  648.       <table class="memname">

  649.         <tr>

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

  651.           <td>(</td>

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

  653.           <td></td>

  654.         </tr>

  655.       </table>

  656.   </td>

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

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

  659.   </tr>

  660. </table>

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

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

  663. 

  664. </div>

  665. </div>

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

  667. <div class="memitem">

  668. <div class="memproto">

  669. <table class="mlabels">

  670.   <tr>

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

  672.       <table class="memname">

  673.         <tr>

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

  675.           <td>(</td>

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

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

  678.           <td></td>

  679.         </tr>

  680.       </table>

  681.   </td>

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

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

  684.   </tr>

  685. </table>

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

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

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

  689.   <table class="params">

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

  691.   </table>

  692.   </dd>

  693. </dl>

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

  695. 

  696. </div>

  697. </div>

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

  699. <div class="memitem">

  700. <div class="memproto">

  701. <table class="mlabels">

  702.   <tr>

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

  704.       <table class="memname">

  705.         <tr>

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

  707.           <td>(</td>

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

  709.           <td></td>

  710.         </tr>

  711.       </table>

  712.   </td>

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

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

  715.   </tr>

  716. </table>

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

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

  719. 

  720. </div>

  721. </div>

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

  723. <div class="memitem">

  724. <div class="memproto">

  725. <table class="mlabels">

  726.   <tr>

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

  728.       <table class="memname">

  729.         <tr>

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

  731.           <td>(</td>

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

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

  734.         </tr>

  735.         <tr>

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

  737.           <td></td>

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

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

  740.         </tr>

  741.         <tr>

  742.           <td></td>

  743.           <td>)</td>

  744.           <td></td><td></td>

  745.         </tr>

  746.       </table>

  747.   </td>

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

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

  750.   </tr>

  751. </table>

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

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

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

  755.   <table class="params">

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

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

  758.   </table>

  759.   </dd>

  760. </dl>

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

  762. 

  763. </div>

  764. </div>

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

  766. <div class="memitem">

  767. <div class="memproto">

  768. <table class="mlabels">

  769.   <tr>

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

  771.       <table class="memname">

  772.         <tr>

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

  774.           <td>(</td>

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

  776.           <td></td>

  777.         </tr>

  778.       </table>

  779.   </td>

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

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

  782.   </tr>

  783. </table>

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

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

  786. 

  787. </div>

  788. </div>

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

  790. <div class="memitem">

  791. <div class="memproto">

  792. <table class="mlabels">

  793.   <tr>

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

  795.       <table class="memname">

  796.         <tr>

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

  798.           <td>(</td>

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

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

  801.         </tr>

  802.         <tr>

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

  804.           <td></td>

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

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

  807.         </tr>

  808.         <tr>

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

  810.           <td></td>

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

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

  813.         </tr>

  814.         <tr>

  815.           <td></td>

  816.           <td>)</td>

  817.           <td></td><td></td>

  818.         </tr>

  819.       </table>

  820.   </td>

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

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

  823.   </tr>

  824. </table>

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

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

  827.   <table class="params">

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

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

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

  831.   </table>

  832.   </dd>

  833. </dl>

  834. 

  835. </div>

  836. </div>

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

  838. <div class="memitem">

  839. <div class="memproto">

  840. <table class="mlabels">

  841.   <tr>

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

  843.       <table class="memname">

  844.         <tr>

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

  846.           <td>(</td>

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

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

  849.           <td></td>

  850.         </tr>

  851.       </table>

  852.   </td>

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

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

  855.   </tr>

  856. </table>

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

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

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

  860.   <table class="params">

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

  862.   </table>

  863.   </dd>

  864. </dl>

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

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

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

  868. 

  869. </div>

  870. </div>

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

  872. <div class="memitem">

  873. <div class="memproto">

  874. <table class="mlabels">

  875.   <tr>

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

  877.       <table class="memname">

  878.         <tr>

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

  880.           <td>(</td>

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

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

  883.         </tr>

  884.         <tr>

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

  886.           <td></td>

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

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

  889.         </tr>

  890.         <tr>

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

  892.           <td></td>

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

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

  895.         </tr>

  896.         <tr>

  897.           <td></td>

  898.           <td>)</td>

  899.           <td></td><td></td>

  900.         </tr>

  901.       </table>

  902.   </td>

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

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

  905.   </tr>

  906. </table>

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

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

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

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

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

  912.   <table class="params">

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

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

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

  916.   </table>

  917.   </dd>

  918. </dl>

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

  920. 

  921. </div>

  922. </div>

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

  924. <div class="memitem">

  925. <div class="memproto">

  926. <table class="mlabels">

  927.   <tr>

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

  929.       <table class="memname">

  930.         <tr>

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

  932.           <td>(</td>

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

  934.           <td> const</td>

  935.         </tr>

  936.       </table>

  937.   </td>

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

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

  940.   </tr>

  941. </table>

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

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

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

  945. 

  946. </div>

  947. </div>

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

  949. <div class="memitem">

  950. <div class="memproto">

  951. <table class="mlabels">

  952.   <tr>

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

  954.       <table class="memname">

  955.         <tr>

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

  957.           <td>(</td>

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

  959.           <td> const</td>

  960.         </tr>

  961.       </table>

  962.   </td>

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

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

  965.   </tr>

  966. </table>

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

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

  969. 

  970. </div>

  971. </div>

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

  973. <div class="memitem">

  974. <div class="memproto">

  975. <table class="mlabels">

  976.   <tr>

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

  978.       <table class="memname">

  979.         <tr>

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

  981.           <td>(</td>

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

  983.           <td> const</td>

  984.         </tr>

  985.       </table>

  986.   </td>

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

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

  989.   </tr>

  990. </table>

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

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

  993. 

  994. </div>

  995. </div>

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

  997. <div class="memitem">

  998. <div class="memproto">

  999. <table class="mlabels">

  1000.   <tr>

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

  1002.       <table class="memname">

  1003.         <tr>

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

  1005.           <td>(</td>

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

  1007.           <td></td>

  1008.         </tr>

  1009.       </table>

  1010.   </td>

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

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

  1013.   </tr>

  1014. </table>

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

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

  1017. 

  1018. </div>

  1019. </div>

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

  1021. <div class="memitem">

  1022. <div class="memproto">

  1023. <table class="mlabels">

  1024.   <tr>

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

  1026.       <table class="memname">

  1027.         <tr>

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

  1029.           <td>(</td>

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

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

  1032.         </tr>

  1033.         <tr>

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

  1035.           <td></td>

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

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

  1038.         </tr>

  1039.         <tr>

  1040.           <td></td>

  1041.           <td>)</td>

  1042.           <td></td><td></td>

  1043.         </tr>

  1044.       </table>

  1045.   </td>

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

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

  1048.   </tr>

  1049. </table>

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

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

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

  1053.   <table class="params">

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

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

  1056.   </table>

  1057.   </dd>

  1058. </dl>

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

  1060. 

  1061. </div>

  1062. </div>

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

  1064. <div class="memitem">

  1065. <div class="memproto">

  1066. <table class="mlabels">

  1067.   <tr>

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

  1069.       <table class="memname">

  1070.         <tr>

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

  1072.           <td>(</td>

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

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

  1075.           <td></td>

  1076.         </tr>

  1077.       </table>

  1078.   </td>

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

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

  1081.   </tr>

  1082. </table>

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

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

  1085.   <table class="params">

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

  1087.   </table>

  1088.   </dd>

  1089. </dl>

  1090. 

  1091. </div>

  1092. </div>

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

  1094. <div class="memitem">

  1095. <div class="memproto">

  1096. <table class="mlabels">

  1097.   <tr>

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

  1099.       <table class="memname">

  1100.         <tr>

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

  1102.           <td>(</td>

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

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

  1105.           <td></td>

  1106.         </tr>

  1107.       </table>

  1108.   </td>

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

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

  1111.   </tr>

  1112. </table>

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

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

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

  1116.   <table class="params">

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

  1118.   </table>

  1119.   </dd>

  1120. </dl>

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

  1122. 

  1123. </div>

  1124. </div>

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

  1126. <div class="memitem">

  1127. <div class="memproto">

  1128. <table class="mlabels">

  1129.   <tr>

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

  1131.       <table class="memname">

  1132.         <tr>

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

  1134.           <td>(</td>

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

  1136.           <td></td>

  1137.         </tr>

  1138.       </table>

  1139.   </td>

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

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

  1142.   </tr>

  1143. </table>

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

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

  1146. 

  1147. </div>

  1148. </div>

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

  1150. <div class="memitem">

  1151. <div class="memproto">

  1152. <table class="mlabels">

  1153.   <tr>

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

  1155.       <table class="memname">

  1156.         <tr>

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

  1158.           <td>(</td>

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

  1160.           <td> const</td>

  1161.         </tr>

  1162.       </table>

  1163.   </td>

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

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

  1166.   </tr>

  1167. </table>

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

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

  1170. 

  1171. </div>

  1172. </div>

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

  1174. <div class="memitem">

  1175. <div class="memproto">

  1176. <table class="mlabels">

  1177.   <tr>

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

  1179.       <table class="memname">

  1180.         <tr>

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

  1182.           <td>(</td>

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

  1184.           <td> const</td>

  1185.         </tr>

  1186.       </table>

  1187.   </td>

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

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

  1190.   </tr>

  1191. </table>

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

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

  1194. 

  1195. </div>

  1196. </div>

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

  1198. <div class="memitem">

  1199. <div class="memproto">

  1200. <table class="mlabels">

  1201.   <tr>

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

  1203.       <table class="memname">

  1204.         <tr>

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

  1206.           <td>(</td>

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

  1208.           <td> const</td>

  1209.         </tr>

  1210.       </table>

  1211.   </td>

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

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

  1214.   </tr>

  1215. </table>

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

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

  1218. 

  1219. </div>

  1220. </div>

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

  1222. <div class="memitem">

  1223. <div class="memproto">

  1224. <table class="mlabels">

  1225.   <tr>

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

  1227.       <table class="memname">

  1228.         <tr>

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

  1230.           <td>(</td>

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

  1232.           <td> const</td>

  1233.         </tr>

  1234.       </table>

  1235.   </td>

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

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

  1238.   </tr>

  1239. </table>

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

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

  1242. 

  1243. </div>

  1244. </div>

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

  1246. <div class="memitem">

  1247. <div class="memproto">

  1248. <table class="mlabels">

  1249.   <tr>

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

  1251.       <table class="memname">

  1252.         <tr>

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

  1254.           <td>(</td>

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

  1256.           <td> const</td>

  1257.         </tr>

  1258.       </table>

  1259.   </td>

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

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

  1262.   </tr>

  1263. </table>

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

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

  1266. 

  1267. </div>

  1268. </div>

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

  1270. <div class="memitem">

  1271. <div class="memproto">

  1272. <table class="mlabels">

  1273.   <tr>

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

  1275.       <table class="memname">

  1276.         <tr>

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

  1278.           <td>(</td>

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

  1280.           <td> const</td>

  1281.         </tr>

  1282.       </table>

  1283.   </td>

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

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

  1286.   </tr>

  1287. </table>

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

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

  1290. 

  1291. </div>

  1292. </div>

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

  1294. <div class="memitem">

  1295. <div class="memproto">

  1296. <table class="mlabels">

  1297.   <tr>

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

  1299.       <table class="memname">

  1300.         <tr>

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

  1302.           <td>(</td>

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

  1304.           <td> const</td>

  1305.         </tr>

  1306.       </table>

  1307.   </td>

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

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

  1310.   </tr>

  1311. </table>

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

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

  1314. 

  1315. </div>

  1316. </div>

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

  1318. <div class="memitem">

  1319. <div class="memproto">

  1320. <table class="mlabels">

  1321.   <tr>

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

  1323.       <table class="memname">

  1324.         <tr>

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

  1326.           <td>(</td>

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

  1328.           <td> const</td>

  1329.         </tr>

  1330.       </table>

  1331.   </td>

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

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

  1334.   </tr>

  1335. </table>

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

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

  1338. 

  1339. </div>

  1340. </div>

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

  1342. <div class="memitem">

  1343. <div class="memproto">

  1344. <table class="mlabels">

  1345.   <tr>

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

  1347.       <table class="memname">

  1348.         <tr>

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

  1350.           <td>(</td>

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

  1352.           <td> const</td>

  1353.         </tr>

  1354.       </table>

  1355.   </td>

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

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

  1358.   </tr>

  1359. </table>

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

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

  1362. 

  1363. </div>

  1364. </div>

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

  1366. <div class="memitem">

  1367. <div class="memproto">

  1368. <table class="mlabels">

  1369.   <tr>

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

  1371.       <table class="memname">

  1372.         <tr>

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

  1374.           <td>(</td>

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

  1376.           <td> const</td>

  1377.         </tr>

  1378.       </table>

  1379.   </td>

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

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

  1382.   </tr>

  1383. </table>

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

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

  1386. 

  1387. </div>

  1388. </div>

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

  1390. <div class="memitem">

  1391. <div class="memproto">

  1392. <table class="mlabels">

  1393.   <tr>

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

  1395.       <table class="memname">

  1396.         <tr>

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

  1398.           <td>(</td>

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

  1400.           <td> const</td>

  1401.         </tr>

  1402.       </table>

  1403.   </td>

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

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

  1406.   </tr>

  1407. </table>

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

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

  1410. 

  1411. </div>

  1412. </div>

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

  1414. <div class="memitem">

  1415. <div class="memproto">

  1416. <table class="mlabels">

  1417.   <tr>

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

  1419.       <table class="memname">

  1420.         <tr>

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

  1422.           <td>(</td>

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

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

  1425.           <td></td>

  1426.         </tr>

  1427.       </table>

  1428.   </td>

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

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

  1431.   </tr>

  1432. </table>

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

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

  1435.   <table class="params">

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

  1437.   </table>

  1438.   </dd>

  1439. </dl>

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

  1441. 

  1442. </div>

  1443. </div>

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

  1445. <div class="memitem">

  1446. <div class="memproto">

  1447. <table class="mlabels">

  1448.   <tr>

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

  1450.       <table class="memname">

  1451.         <tr>

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

  1453.           <td>(</td>

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

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

  1456.           <td></td>

  1457.         </tr>

  1458.       </table>

  1459.   </td>

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

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

  1462.   </tr>

  1463. </table>

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

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

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

  1467.   <table class="params">

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

  1469.   </table>

  1470.   </dd>

  1471. </dl>

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

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

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

  1475. 

  1476. </div>

  1477. </div>

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

  1479. <div class="memitem">

  1480. <div class="memproto">

  1481. <table class="mlabels">

  1482.   <tr>

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

  1484.       <table class="memname">

  1485.         <tr>

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

  1487.           <td>(</td>

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

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

  1490.         </tr>

  1491.         <tr>

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

  1493.           <td></td>

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

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

  1496.         </tr>

  1497.         <tr>

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

  1499.           <td></td>

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

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

  1502.         </tr>

  1503.         <tr>

  1504.           <td></td>

  1505.           <td>)</td>

  1506.           <td></td><td></td>

  1507.         </tr>

  1508.       </table>

  1509.   </td>

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

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

  1512.   </tr>

  1513. </table>

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

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

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

  1517.   <table class="params">

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

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

  1520.   </table>

  1521.   </dd>

  1522. </dl>

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

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

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

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

  1527.   <table class="params">

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

  1529.   </table>

  1530.   </dd>

  1531. </dl>

  1532. 

  1533. </div>

  1534. </div>

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

  1536. <div class="memitem">

  1537. <div class="memproto">

  1538. <table class="mlabels">

  1539.   <tr>

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

  1541.       <table class="memname">

  1542.         <tr>

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

  1544.           <td>(</td>

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

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

  1547.         </tr>

  1548.         <tr>

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

  1550.           <td></td>

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

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

  1553.         </tr>

  1554.         <tr>

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

  1556.           <td></td>

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

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

  1559.         </tr>

  1560.         <tr>

  1561.           <td></td>

  1562.           <td>)</td>

  1563.           <td></td><td></td>

  1564.         </tr>

  1565.       </table>

  1566.   </td>

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

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

  1569.   </tr>

  1570. </table>

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

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

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

  1574.   <table class="params">

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

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

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

  1578.   </table>

  1579.   </dd>

  1580. </dl>

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

  1582. 

  1583. </div>

  1584. </div>

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

  1586. <div class="memitem">

  1587. <div class="memproto">

  1588. <table class="mlabels">

  1589.   <tr>

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

  1591.       <table class="memname">

  1592.         <tr>

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

  1594.           <td>(</td>

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

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

  1597.         </tr>

  1598.         <tr>

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

  1600.           <td></td>

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

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

  1603.         </tr>

  1604.         <tr>

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

  1606.           <td></td>

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

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

  1609.         </tr>

  1610.         <tr>

  1611.           <td></td>

  1612.           <td>)</td>

  1613.           <td></td><td></td>

  1614.         </tr>

  1615.       </table>

  1616.   </td>

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

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

  1619.   </tr>

  1620. </table>

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

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

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

  1624.   <table class="params">

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

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

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

  1628.   </table>

  1629.   </dd>

  1630. </dl>

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

  1632. 

  1633. </div>

  1634. </div>

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

  1636. <div class="memitem">

  1637. <div class="memproto">

  1638. <table class="mlabels">

  1639.   <tr>

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

  1641.       <table class="memname">

  1642.         <tr>

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

  1644.           <td>(</td>

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

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

  1647.         </tr>

  1648.         <tr>

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

  1650.           <td></td>

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

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

  1653.         </tr>

  1654.         <tr>

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

  1656.           <td></td>

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

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

  1659.         </tr>

  1660.         <tr>

  1661.           <td></td>

  1662.           <td>)</td>

  1663.           <td></td><td></td>

  1664.         </tr>

  1665.       </table>

  1666.   </td>

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

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

  1669.   </tr>

  1670. </table>

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

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

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

  1674.   <table class="params">

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

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

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

  1678.   </table>

  1679.   </dd>

  1680. </dl>

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

  1682. 

  1683. </div>

  1684. </div>

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

  1686. <div class="memitem">

  1687. <div class="memproto">

  1688. <table class="mlabels">

  1689.   <tr>

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

  1691.       <table class="memname">

  1692.         <tr>

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

  1694.           <td>(</td>

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

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

  1697.         </tr>

  1698.         <tr>

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

  1700.           <td></td>

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

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

  1703.         </tr>

  1704.         <tr>

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

  1706.           <td></td>

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

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

  1709.         </tr>

  1710.         <tr>

  1711.           <td></td>

  1712.           <td>)</td>

  1713.           <td></td><td></td>

  1714.         </tr>

  1715.       </table>

  1716.   </td>

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

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

  1719.   </tr>

  1720. </table>

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

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

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

  1724.   <table class="params">

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

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

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

  1728.   </table>

  1729.   </dd>

  1730. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1745. 

  1746. </div>

  1747. </div>

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

  1749. <div class="memitem">

  1750. <div class="memproto">

  1751. <table class="mlabels">

  1752.   <tr>

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

  1754.       <table class="memname">

  1755.         <tr>

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

  1757.           <td>(</td>

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

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

  1760.         </tr>

  1761.         <tr>

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

  1763.           <td></td>

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

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

  1766.         </tr>

  1767.         <tr>

  1768.           <td></td>

  1769.           <td>)</td>

  1770.           <td></td><td></td>

  1771.         </tr>

  1772.       </table>

  1773.   </td>

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

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

  1776.   </tr>

  1777. </table>

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

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

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

  1781.   <table class="params">

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

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

  1784.   </table>

  1785.   </dd>

  1786. </dl>

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

  1788. 

  1789. </div>

  1790. </div>

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

  1792. <div class="memitem">

  1793. <div class="memproto">

  1794. <table class="mlabels">

  1795.   <tr>

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

  1797.       <table class="memname">

  1798.         <tr>

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

  1800.           <td>(</td>

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

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

  1803.         </tr>

  1804.         <tr>

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

  1806.           <td></td>

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

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

  1809.         </tr>

  1810.         <tr>

  1811.           <td></td>

  1812.           <td>)</td>

  1813.           <td></td><td></td>

  1814.         </tr>

  1815.       </table>

  1816.   </td>

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

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

  1819.   </tr>

  1820. </table>

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

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

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

  1824.   <table class="params">

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

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

  1827.   </table>

  1828.   </dd>

  1829. </dl>

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

  1831. 

  1832. </div>

  1833. </div>

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

  1835. <div class="memitem">

  1836. <div class="memproto">

  1837. <table class="mlabels">

  1838.   <tr>

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

  1840.       <table class="memname">

  1841.         <tr>

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

  1843.           <td>(</td>

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

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

  1846.           <td></td>

  1847.         </tr>

  1848.       </table>

  1849.   </td>

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

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

  1852.   </tr>

  1853. </table>

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

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

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

  1857.   <table class="params">

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

  1859.   </table>

  1860.   </dd>

  1861. </dl>

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

  1863. 

  1864. </div>

  1865. </div>

  1866. <a class="anchor" id="ac05b7136b887539426856c623869aa3a"></a>

  1867. <div class="memitem">

  1868. <div class="memproto">

  1869. <table class="mlabels">

  1870.   <tr>

  1871.   <td class="mlabels-left">

  1872.       <table class="memname">

  1873.         <tr>

  1874.           <td class="memname">int FatFile::peek </td>

  1875.           <td>(</td>

  1876.           <td class="paramname"></td><td>)</td>

  1877.           <td></td>

  1878.         </tr>

  1879.       </table>

  1880.   </td>

  1881.   <td class="mlabels-right">

  1882. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1883.   </tr>

  1884. </table>

  1885. </div><div class="memdoc">

  1886. <p>Return the next available byte without consuming it.</p>

  1887. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1888. 

  1889. </div>

  1890. </div>

  1891. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1892. <div class="memitem">

  1893. <div class="memproto">

  1894. <table class="mlabels">

  1895.   <tr>

  1896.   <td class="mlabels-left">

  1897.       <table class="memname">

  1898.         <tr>

  1899.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1900.           <td>(</td>

  1901.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1902.           <td class="paramname"><em>pr</em></td><td>)</td>

  1903.           <td></td>

  1904.         </tr>

  1905.       </table>

  1906.   </td>

  1907.   <td class="mlabels-right">

  1908. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1909.   </tr>

  1910. </table>

  1911. </div><div class="memdoc">

  1912. <p>Print a file's creation date and time</p>

  1913. <dl class="params"><dt>Parameters</dt><dd>

  1914.   <table class="params">

  1915.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1916.   </table>

  1917.   </dd>

  1918. </dl>

  1919. <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>

  1920. 

  1921. </div>

  1922. </div>

  1923. <a class="anchor" id="a9f73ca0c68654c3dc8fa7c818f2cfe9f"></a>

  1924. <div class="memitem">

  1925. <div class="memproto">

  1926. <table class="mlabels">

  1927.   <tr>

  1928.   <td class="mlabels-left">

  1929.       <table class="memname">

  1930.         <tr>

  1931.           <td class="memname">static void SdBaseFile::printFatDate </td>

  1932.           <td>(</td>

  1933.           <td class="paramtype">uint16_t&#160;</td>

  1934.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1935.           <td></td>

  1936.         </tr>

  1937.       </table>

  1938.   </td>

  1939.   <td class="mlabels-right">

  1940. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  1941.   </tr>

  1942. </table>

  1943. </div><div class="memdoc">

  1944. <p>Print a directory date field.</p>

  1945. <p>Format is yyyy-mm-dd.</p>

  1946. <dl class="params"><dt>Parameters</dt><dd>

  1947.   <table class="params">

  1948.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1949.   </table>

  1950.   </dd>

  1951. </dl>

  1952. 

  1953. </div>

  1954. </div>

  1955. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1956. <div class="memitem">

  1957. <div class="memproto">

  1958. <table class="mlabels">

  1959.   <tr>

  1960.   <td class="mlabels-left">

  1961.       <table class="memname">

  1962.         <tr>

  1963.           <td class="memname">void FatFile::printFatDate </td>

  1964.           <td>(</td>

  1965.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1966.           <td class="paramname"><em>pr</em>, </td>

  1967.         </tr>

  1968.         <tr>

  1969.           <td class="paramkey"></td>

  1970.           <td></td>

  1971.           <td class="paramtype">uint16_t&#160;</td>

  1972.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1973.         </tr>

  1974.         <tr>

  1975.           <td></td>

  1976.           <td>)</td>

  1977.           <td></td><td></td>

  1978.         </tr>

  1979.       </table>

  1980.   </td>

  1981.   <td class="mlabels-right">

  1982. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  1983.   </tr>

  1984. </table>

  1985. </div><div class="memdoc">

  1986. <p>Print a directory date field.</p>

  1987. <p>Format is yyyy-mm-dd.</p>

  1988. <dl class="params"><dt>Parameters</dt><dd>

  1989.   <table class="params">

  1990.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1991.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1992.   </table>

  1993.   </dd>

  1994. </dl>

  1995. 

  1996. </div>

  1997. </div>

  1998. <a class="anchor" id="a9dbde542faa736b47c524205325463bb"></a>

  1999. <div class="memitem">

  2000. <div class="memproto">

  2001. <table class="mlabels">

  2002.   <tr>

  2003.   <td class="mlabels-left">

  2004.       <table class="memname">

  2005.         <tr>

  2006.           <td class="memname">static void SdBaseFile::printFatTime </td>

  2007.           <td>(</td>

  2008.           <td class="paramtype">uint16_t&#160;</td>

  2009.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  2010.           <td></td>

  2011.         </tr>

  2012.       </table>

  2013.   </td>

  2014.   <td class="mlabels-right">

  2015. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  2016.   </tr>

  2017. </table>

  2018. </div><div class="memdoc">

  2019. <p>Print a directory time field.</p>

  2020. <p>Format is hh:mm:ss.</p>

  2021. <dl class="params"><dt>Parameters</dt><dd>

  2022.   <table class="params">

  2023.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2024.   </table>

  2025.   </dd>

  2026. </dl>

  2027. 

  2028. </div>

  2029. </div>

  2030. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  2031. <div class="memitem">

  2032. <div class="memproto">

  2033. <table class="mlabels">

  2034.   <tr>

  2035.   <td class="mlabels-left">

  2036.       <table class="memname">

  2037.         <tr>

  2038.           <td class="memname">void FatFile::printFatTime </td>

  2039.           <td>(</td>

  2040.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2041.           <td class="paramname"><em>pr</em>, </td>

  2042.         </tr>

  2043.         <tr>

  2044.           <td class="paramkey"></td>

  2045.           <td></td>

  2046.           <td class="paramtype">uint16_t&#160;</td>

  2047.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2048.         </tr>

  2049.         <tr>

  2050.           <td></td>

  2051.           <td>)</td>

  2052.           <td></td><td></td>

  2053.         </tr>

  2054.       </table>

  2055.   </td>

  2056.   <td class="mlabels-right">

  2057. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2058.   </tr>

  2059. </table>

  2060. </div><div class="memdoc">

  2061. <p>Print a directory time field.</p>

  2062. <p>Format is hh:mm:ss.</p>

  2063. <dl class="params"><dt>Parameters</dt><dd>

  2064.   <table class="params">

  2065.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2066.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2067.   </table>

  2068.   </dd>

  2069. </dl>

  2070. 

  2071. </div>

  2072. </div>

  2073. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  2074. <div class="memitem">

  2075. <div class="memproto">

  2076. <table class="mlabels">

  2077.   <tr>

  2078.   <td class="mlabels-left">

  2079.       <table class="memname">

  2080.         <tr>

  2081.           <td class="memname">int FatFile::printField </td>

  2082.           <td>(</td>

  2083.           <td class="paramtype">float&#160;</td>

  2084.           <td class="paramname"><em>value</em>, </td>

  2085.         </tr>

  2086.         <tr>

  2087.           <td class="paramkey"></td>

  2088.           <td></td>

  2089.           <td class="paramtype">char&#160;</td>

  2090.           <td class="paramname"><em>term</em>, </td>

  2091.         </tr>

  2092.         <tr>

  2093.           <td class="paramkey"></td>

  2094.           <td></td>

  2095.           <td class="paramtype">uint8_t&#160;</td>

  2096.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2097.         </tr>

  2098.         <tr>

  2099.           <td></td>

  2100.           <td>)</td>

  2101.           <td></td><td></td>

  2102.         </tr>

  2103.       </table>

  2104.   </td>

  2105.   <td class="mlabels-right">

  2106. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2107.   </tr>

  2108. </table>

  2109. </div><div class="memdoc">

  2110. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2111.   <table class="params">

  2112.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2113.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2114.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2115.   </table>

  2116.   </dd>

  2117. </dl>

  2118. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2119. 

  2120. </div>

  2121. </div>

  2122. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  2123. <div class="memitem">

  2124. <div class="memproto">

  2125. <table class="mlabels">

  2126.   <tr>

  2127.   <td class="mlabels-left">

  2128.       <table class="memname">

  2129.         <tr>

  2130.           <td class="memname">int FatFile::printField </td>

  2131.           <td>(</td>

  2132.           <td class="paramtype">int16_t&#160;</td>

  2133.           <td class="paramname"><em>value</em>, </td>

  2134.         </tr>

  2135.         <tr>

  2136.           <td class="paramkey"></td>

  2137.           <td></td>

  2138.           <td class="paramtype">char&#160;</td>

  2139.           <td class="paramname"><em>term</em>&#160;</td>

  2140.         </tr>

  2141.         <tr>

  2142.           <td></td>

  2143.           <td>)</td>

  2144.           <td></td><td></td>

  2145.         </tr>

  2146.       </table>

  2147.   </td>

  2148.   <td class="mlabels-right">

  2149. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2150.   </tr>

  2151. </table>

  2152. </div><div class="memdoc">

  2153. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2154.   <table class="params">

  2155.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2156.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2157.   </table>

  2158.   </dd>

  2159. </dl>

  2160. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2161. 

  2162. </div>

  2163. </div>

  2164. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2165. <div class="memitem">

  2166. <div class="memproto">

  2167. <table class="mlabels">

  2168.   <tr>

  2169.   <td class="mlabels-left">

  2170.       <table class="memname">

  2171.         <tr>

  2172.           <td class="memname">int FatFile::printField </td>

  2173.           <td>(</td>

  2174.           <td class="paramtype">uint16_t&#160;</td>

  2175.           <td class="paramname"><em>value</em>, </td>

  2176.         </tr>

  2177.         <tr>

  2178.           <td class="paramkey"></td>

  2179.           <td></td>

  2180.           <td class="paramtype">char&#160;</td>

  2181.           <td class="paramname"><em>term</em>&#160;</td>

  2182.         </tr>

  2183.         <tr>

  2184.           <td></td>

  2185.           <td>)</td>

  2186.           <td></td><td></td>

  2187.         </tr>

  2188.       </table>

  2189.   </td>

  2190.   <td class="mlabels-right">

  2191. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2192.   </tr>

  2193. </table>

  2194. </div><div class="memdoc">

  2195. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2196.   <table class="params">

  2197.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2198.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2199.   </table>

  2200.   </dd>

  2201. </dl>

  2202. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2203. 

  2204. </div>

  2205. </div>

  2206. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2207. <div class="memitem">

  2208. <div class="memproto">

  2209. <table class="mlabels">

  2210.   <tr>

  2211.   <td class="mlabels-left">

  2212.       <table class="memname">

  2213.         <tr>

  2214.           <td class="memname">int FatFile::printField </td>

  2215.           <td>(</td>

  2216.           <td class="paramtype">int32_t&#160;</td>

  2217.           <td class="paramname"><em>value</em>, </td>

  2218.         </tr>

  2219.         <tr>

  2220.           <td class="paramkey"></td>

  2221.           <td></td>

  2222.           <td class="paramtype">char&#160;</td>

  2223.           <td class="paramname"><em>term</em>&#160;</td>

  2224.         </tr>

  2225.         <tr>

  2226.           <td></td>

  2227.           <td>)</td>

  2228.           <td></td><td></td>

  2229.         </tr>

  2230.       </table>

  2231.   </td>

  2232.   <td class="mlabels-right">

  2233. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2234.   </tr>

  2235. </table>

  2236. </div><div class="memdoc">

  2237. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2238.   <table class="params">

  2239.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2240.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2241.   </table>

  2242.   </dd>

  2243. </dl>

  2244. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2245. 

  2246. </div>

  2247. </div>

  2248. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2249. <div class="memitem">

  2250. <div class="memproto">

  2251. <table class="mlabels">

  2252.   <tr>

  2253.   <td class="mlabels-left">

  2254.       <table class="memname">

  2255.         <tr>

  2256.           <td class="memname">int FatFile::printField </td>

  2257.           <td>(</td>

  2258.           <td class="paramtype">uint32_t&#160;</td>

  2259.           <td class="paramname"><em>value</em>, </td>

  2260.         </tr>

  2261.         <tr>

  2262.           <td class="paramkey"></td>

  2263.           <td></td>

  2264.           <td class="paramtype">char&#160;</td>

  2265.           <td class="paramname"><em>term</em>&#160;</td>

  2266.         </tr>

  2267.         <tr>

  2268.           <td></td>

  2269.           <td>)</td>

  2270.           <td></td><td></td>

  2271.         </tr>

  2272.       </table>

  2273.   </td>

  2274.   <td class="mlabels-right">

  2275. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2276.   </tr>

  2277. </table>

  2278. </div><div class="memdoc">

  2279. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2280.   <table class="params">

  2281.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2282.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2283.   </table>

  2284.   </dd>

  2285. </dl>

  2286. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2287. 

  2288. </div>

  2289. </div>

  2290. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2291. <div class="memitem">

  2292. <div class="memproto">

  2293. <table class="mlabels">

  2294.   <tr>

  2295.   <td class="mlabels-left">

  2296.       <table class="memname">

  2297.         <tr>

  2298.           <td class="memname">size_t FatFile::printFileSize </td>

  2299.           <td>(</td>

  2300.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2301.           <td class="paramname"><em>pr</em></td><td>)</td>

  2302.           <td></td>

  2303.         </tr>

  2304.       </table>

  2305.   </td>

  2306.   <td class="mlabels-right">

  2307. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2308.   </tr>

  2309. </table>

  2310. </div><div class="memdoc">

  2311. <p>Print a file's size.</p>

  2312. <dl class="params"><dt>Parameters</dt><dd>

  2313.   <table class="params">

  2314.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2315.   </table>

  2316.   </dd>

  2317. </dl>

  2318. <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>

  2319. 

  2320. </div>

  2321. </div>

  2322. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2323. <div class="memitem">

  2324. <div class="memproto">

  2325. <table class="mlabels">

  2326.   <tr>

  2327.   <td class="mlabels-left">

  2328.       <table class="memname">

  2329.         <tr>

  2330.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2331.           <td>(</td>

  2332.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2333.           <td class="paramname"><em>pr</em></td><td>)</td>

  2334.           <td></td>

  2335.         </tr>

  2336.       </table>

  2337.   </td>

  2338.   <td class="mlabels-right">

  2339. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2340.   </tr>

  2341. </table>

  2342. </div><div class="memdoc">

  2343. <p>Print a file's modify date and time</p>

  2344. <dl class="params"><dt>Parameters</dt><dd>

  2345.   <table class="params">

  2346.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2347.   </table>

  2348.   </dd>

  2349. </dl>

  2350. <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>

  2351. 

  2352. </div>

  2353. </div>

  2354. <a class="anchor" id="add1a682e60aa3d8c030805122d5aa4e3"></a>

  2355. <div class="memitem">

  2356. <div class="memproto">

  2357. <table class="mlabels">

  2358.   <tr>

  2359.   <td class="mlabels-left">

  2360.       <table class="memname">

  2361.         <tr>

  2362.           <td class="memname">size_t SdBaseFile::printName </td>

  2363.           <td>(</td>

  2364.           <td class="paramname"></td><td>)</td>

  2365.           <td></td>

  2366.         </tr>

  2367.       </table>

  2368.   </td>

  2369.   <td class="mlabels-right">

  2370. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2371.   </tr>

  2372. </table>

  2373. </div><div class="memdoc">

  2374. <p>Print a file's name.</p>

  2375. <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>

  2376. 

  2377. </div>

  2378. </div>

  2379. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></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">size_t FatFile::printName </td>

  2388.           <td>(</td>

  2389.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2390.           <td class="paramname"><em>pr</em></td><td>)</td>

  2391.           <td></td>

  2392.         </tr>

  2393.       </table>

  2394.   </td>

  2395.   <td class="mlabels-right">

  2396. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2397.   </tr>

  2398. </table>

  2399. </div><div class="memdoc">

  2400. <p>Print a file's name</p>

  2401. <dl class="params"><dt>Parameters</dt><dd>

  2402.   <table class="params">

  2403.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2404.   </table>

  2405.   </dd>

  2406. </dl>

  2407. <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>

  2408. 

  2409. </div>

  2410. </div>

  2411. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2412. <div class="memitem">

  2413. <div class="memproto">

  2414. <table class="mlabels">

  2415.   <tr>

  2416.   <td class="mlabels-left">

  2417.       <table class="memname">

  2418.         <tr>

  2419.           <td class="memname">size_t FatFile::printSFN </td>

  2420.           <td>(</td>

  2421.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2422.           <td class="paramname"><em>pr</em></td><td>)</td>

  2423.           <td></td>

  2424.         </tr>

  2425.       </table>

  2426.   </td>

  2427.   <td class="mlabels-right">

  2428. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2429.   </tr>

  2430. </table>

  2431. </div><div class="memdoc">

  2432. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2433. <dl class="params"><dt>Parameters</dt><dd>

  2434.   <table class="params">

  2435.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2436.   </table>

  2437.   </dd>

  2438. </dl>

  2439. <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>

  2440. 

  2441. </div>

  2442. </div>

  2443. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2444. <div class="memitem">

  2445. <div class="memproto">

  2446. <table class="mlabels">

  2447.   <tr>

  2448.   <td class="mlabels-left">

  2449.       <table class="memname">

  2450.         <tr>

  2451.           <td class="memname">int FatFile::read </td>

  2452.           <td>(</td>

  2453.           <td class="paramname"></td><td>)</td>

  2454.           <td></td>

  2455.         </tr>

  2456.       </table>

  2457.   </td>

  2458.   <td class="mlabels-right">

  2459. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2460.   </tr>

  2461. </table>

  2462. </div><div class="memdoc">

  2463. <p>Read the next byte from a file.</p>

  2464. <dl class="section return"><dt>Returns</dt><dd>For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned. </dd></dl>

  2465. 

  2466. </div>

  2467. </div>

  2468. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2469. <div class="memitem">

  2470. <div class="memproto">

  2471. <table class="mlabels">

  2472.   <tr>

  2473.   <td class="mlabels-left">

  2474.       <table class="memname">

  2475.         <tr>

  2476.           <td class="memname">int FatFile::read </td>

  2477.           <td>(</td>

  2478.           <td class="paramtype">void *&#160;</td>

  2479.           <td class="paramname"><em>buf</em>, </td>

  2480.         </tr>

  2481.         <tr>

  2482.           <td class="paramkey"></td>

  2483.           <td></td>

  2484.           <td class="paramtype">size_t&#160;</td>

  2485.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2486.         </tr>

  2487.         <tr>

  2488.           <td></td>

  2489.           <td>)</td>

  2490.           <td></td><td></td>

  2491.         </tr>

  2492.       </table>

  2493.   </td>

  2494.   <td class="mlabels-right">

  2495. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2496.   </tr>

  2497. </table>

  2498. </div><div class="memdoc">

  2499. <p>Read data from a file starting at the current position.</p>

  2500. <dl class="params"><dt>Parameters</dt><dd>

  2501.   <table class="params">

  2502.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2503.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2504.   </table>

  2505.   </dd>

  2506. </dl>

  2507. <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>

  2508. 

  2509. </div>

  2510. </div>

  2511. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2512. <div class="memitem">

  2513. <div class="memproto">

  2514. <table class="mlabels">

  2515.   <tr>

  2516.   <td class="mlabels-left">

  2517.       <table class="memname">

  2518.         <tr>

  2519.           <td class="memname">int8_t FatFile::readDir </td>

  2520.           <td>(</td>

  2521.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2522.           <td class="paramname"><em>dir</em></td><td>)</td>

  2523.           <td></td>

  2524.         </tr>

  2525.       </table>

  2526.   </td>

  2527.   <td class="mlabels-right">

  2528. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2529.   </tr>

  2530. </table>

  2531. </div><div class="memdoc">

  2532. <p>Read the next directory entry from a directory file.</p>

  2533. <dl class="params"><dt>Parameters</dt><dd>

  2534.   <table class="params">

  2535.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2536.   </table>

  2537.   </dd>

  2538. </dl>

  2539. <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>

  2540. 

  2541. </div>

  2542. </div>

  2543. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2544. <div class="memitem">

  2545. <div class="memproto">

  2546. <table class="mlabels">

  2547.   <tr>

  2548.   <td class="mlabels-left">

  2549.       <table class="memname">

  2550.         <tr>

  2551.           <td class="memname">bool FatFile::remove </td>

  2552.           <td>(</td>

  2553.           <td class="paramname"></td><td>)</td>

  2554.           <td></td>

  2555.         </tr>

  2556.       </table>

  2557.   </td>

  2558.   <td class="mlabels-right">

  2559. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2560.   </tr>

  2561. </table>

  2562. </div><div class="memdoc">

  2563. <p>Remove a file.</p>

  2564. <p>The directory entry and all data for the file are deleted.</p>

  2565. <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>

  2566. <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>

  2567. 

  2568. </div>

  2569. </div>

  2570. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2571. <div class="memitem">

  2572. <div class="memproto">

  2573. <table class="mlabels">

  2574.   <tr>

  2575.   <td class="mlabels-left">

  2576.       <table class="memname">

  2577.         <tr>

  2578.           <td class="memname">bool FatFile::remove </td>

  2579.           <td>(</td>

  2580.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2581.           <td class="paramname"><em>dirFile</em>, </td>

  2582.         </tr>

  2583.         <tr>

  2584.           <td class="paramkey"></td>

  2585.           <td></td>

  2586.           <td class="paramtype">const char *&#160;</td>

  2587.           <td class="paramname"><em>path</em>&#160;</td>

  2588.         </tr>

  2589.         <tr>

  2590.           <td></td>

  2591.           <td>)</td>

  2592.           <td></td><td></td>

  2593.         </tr>

  2594.       </table>

  2595.   </td>

  2596.   <td class="mlabels-right">

  2597. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2598.   </tr>

  2599. </table>

  2600. </div><div class="memdoc">

  2601. <p>Remove a file.</p>

  2602. <p>The directory entry and all data for the file are deleted.</p>

  2603. <dl class="params"><dt>Parameters</dt><dd>

  2604.   <table class="params">

  2605.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2606.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2607.   </table>

  2608.   </dd>

  2609. </dl>

  2610. <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>

  2611. <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>

  2612. 

  2613. </div>

  2614. </div>

  2615. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2616. <div class="memitem">

  2617. <div class="memproto">

  2618. <table class="mlabels">

  2619.   <tr>

  2620.   <td class="mlabels-left">

  2621.       <table class="memname">

  2622.         <tr>

  2623.           <td class="memname">bool FatFile::rename </td>

  2624.           <td>(</td>

  2625.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2626.           <td class="paramname"><em>dirFile</em>, </td>

  2627.         </tr>

  2628.         <tr>

  2629.           <td class="paramkey"></td>

  2630.           <td></td>

  2631.           <td class="paramtype">const char *&#160;</td>

  2632.           <td class="paramname"><em>newPath</em>&#160;</td>

  2633.         </tr>

  2634.         <tr>

  2635.           <td></td>

  2636.           <td>)</td>

  2637.           <td></td><td></td>

  2638.         </tr>

  2639.       </table>

  2640.   </td>

  2641.   <td class="mlabels-right">

  2642. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2643.   </tr>

  2644. </table>

  2645. </div><div class="memdoc">

  2646. <p>Rename a file or subdirectory.</p>

  2647. <dl class="params"><dt>Parameters</dt><dd>

  2648.   <table class="params">

  2649.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2650.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2651.   </table>

  2652.   </dd>

  2653. </dl>

  2654. <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>

  2655. 

  2656. </div>

  2657. </div>

  2658. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2659. <div class="memitem">

  2660. <div class="memproto">

  2661. <table class="mlabels">

  2662.   <tr>

  2663.   <td class="mlabels-left">

  2664.       <table class="memname">

  2665.         <tr>

  2666.           <td class="memname">void FatFile::rewind </td>

  2667.           <td>(</td>

  2668.           <td class="paramname"></td><td>)</td>

  2669.           <td></td>

  2670.         </tr>

  2671.       </table>

  2672.   </td>

  2673.   <td class="mlabels-right">

  2674. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2675.   </tr>

  2676. </table>

  2677. </div><div class="memdoc">

  2678. <p>Set the file's current position to zero. </p>

  2679. 

  2680. </div>

  2681. </div>

  2682. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2683. <div class="memitem">

  2684. <div class="memproto">

  2685. <table class="mlabels">

  2686.   <tr>

  2687.   <td class="mlabels-left">

  2688.       <table class="memname">

  2689.         <tr>

  2690.           <td class="memname">bool FatFile::rmdir </td>

  2691.           <td>(</td>

  2692.           <td class="paramname"></td><td>)</td>

  2693.           <td></td>

  2694.         </tr>

  2695.       </table>

  2696.   </td>

  2697.   <td class="mlabels-right">

  2698. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2699.   </tr>

  2700. </table>

  2701. </div><div class="memdoc">

  2702. <p>Remove a directory file.</p>

  2703. <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>

  2704. <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>

  2705. <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>

  2706. 

  2707. </div>

  2708. </div>

  2709. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2710. <div class="memitem">

  2711. <div class="memproto">

  2712. <table class="mlabels">

  2713.   <tr>

  2714.   <td class="mlabels-left">

  2715.       <table class="memname">

  2716.         <tr>

  2717.           <td class="memname">bool FatFile::rmRfStar </td>

  2718.           <td>(</td>

  2719.           <td class="paramname"></td><td>)</td>

  2720.           <td></td>

  2721.         </tr>

  2722.       </table>

  2723.   </td>

  2724.   <td class="mlabels-right">

  2725. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2726.   </tr>

  2727. </table>

  2728. </div><div class="memdoc">

  2729. <p>Recursively delete a directory and all contained files.</p>

  2730. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2731. <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>

  2732. <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>

  2733. <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>

  2734. 

  2735. </div>

  2736. </div>

  2737. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2738. <div class="memitem">

  2739. <div class="memproto">

  2740. <table class="mlabels">

  2741.   <tr>

  2742.   <td class="mlabels-left">

  2743.       <table class="memname">

  2744.         <tr>

  2745.           <td class="memname">bool FatFile::seekCur </td>

  2746.           <td>(</td>

  2747.           <td class="paramtype">int32_t&#160;</td>

  2748.           <td class="paramname"><em>offset</em></td><td>)</td>

  2749.           <td></td>

  2750.         </tr>

  2751.       </table>

  2752.   </td>

  2753.   <td class="mlabels-right">

  2754. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2755.   </tr>

  2756. </table>

  2757. </div><div class="memdoc">

  2758. <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>

  2759.   <table class="params">

  2760.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2761.   </table>

  2762.   </dd>

  2763. </dl>

  2764. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2765. 

  2766. </div>

  2767. </div>

  2768. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2769. <div class="memitem">

  2770. <div class="memproto">

  2771. <table class="mlabels">

  2772.   <tr>

  2773.   <td class="mlabels-left">

  2774.       <table class="memname">

  2775.         <tr>

  2776.           <td class="memname">bool FatFile::seekEnd </td>

  2777.           <td>(</td>

  2778.           <td class="paramtype">int32_t&#160;</td>

  2779.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2780.           <td></td>

  2781.         </tr>

  2782.       </table>

  2783.   </td>

  2784.   <td class="mlabels-right">

  2785. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2786.   </tr>

  2787. </table>

  2788. </div><div class="memdoc">

  2789. <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>

  2790.   <table class="params">

  2791.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2792.   </table>

  2793.   </dd>

  2794. </dl>

  2795. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2796. 

  2797. </div>

  2798. </div>

  2799. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2800. <div class="memitem">

  2801. <div class="memproto">

  2802. <table class="mlabels">

  2803.   <tr>

  2804.   <td class="mlabels-left">

  2805.       <table class="memname">

  2806.         <tr>

  2807.           <td class="memname">bool FatFile::seekSet </td>

  2808.           <td>(</td>

  2809.           <td class="paramtype">uint32_t&#160;</td>

  2810.           <td class="paramname"><em>pos</em></td><td>)</td>

  2811.           <td></td>

  2812.         </tr>

  2813.       </table>

  2814.   </td>

  2815.   <td class="mlabels-right">

  2816. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2817.   </tr>

  2818. </table>

  2819. </div><div class="memdoc">

  2820. <p>Sets a file's position.</p>

  2821. <dl class="params"><dt>Parameters</dt><dd>

  2822.   <table class="params">

  2823.     <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>

  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="a360ef9c05e677271bed6c0a4d663634c"></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">static bool FatFile::setCwd </td>

  2840.           <td>(</td>

  2841.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2842.           <td class="paramname"><em>dir</em></td><td>)</td>

  2843.           <td></td>

  2844.         </tr>

  2845.       </table>

  2846.   </td>

  2847.   <td class="mlabels-right">

  2848. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2849.   </tr>

  2850. </table>

  2851. </div><div class="memdoc">

  2852. <p>Set the current working directory.</p>

  2853. <dl class="params"><dt>Parameters</dt><dd>

  2854.   <table class="params">

  2855.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2856.   </table>

  2857.   </dd>

  2858. </dl>

  2859. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2860. 

  2861. </div>

  2862. </div>

  2863. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2864. <div class="memitem">

  2865. <div class="memproto">

  2866. <table class="mlabels">

  2867.   <tr>

  2868.   <td class="mlabels-left">

  2869.       <table class="memname">

  2870.         <tr>

  2871.           <td class="memname">void FatFile::setpos </td>

  2872.           <td>(</td>

  2873.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2874.           <td class="paramname"><em>pos</em></td><td>)</td>

  2875.           <td></td>

  2876.         </tr>

  2877.       </table>

  2878.   </td>

  2879.   <td class="mlabels-right">

  2880. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2881.   </tr>

  2882. </table>

  2883. </div><div class="memdoc">

  2884. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2885.   <table class="params">

  2886.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2887.   </table>

  2888.   </dd>

  2889. </dl>

  2890. 

  2891. </div>

  2892. </div>

  2893. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2894. <div class="memitem">

  2895. <div class="memproto">

  2896. <table class="mlabels">

  2897.   <tr>

  2898.   <td class="mlabels-left">

  2899.       <table class="memname">

  2900.         <tr>

  2901.           <td class="memname">bool FatFile::sync </td>

  2902.           <td>(</td>

  2903.           <td class="paramname"></td><td>)</td>

  2904.           <td></td>

  2905.         </tr>

  2906.       </table>

  2907.   </td>

  2908.   <td class="mlabels-right">

  2909. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2910.   </tr>

  2911. </table>

  2912. </div><div class="memdoc">

  2913. <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>

  2914. <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>

  2915. 

  2916. </div>

  2917. </div>

  2918. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2919. <div class="memitem">

  2920. <div class="memproto">

  2921. <table class="mlabels">

  2922.   <tr>

  2923.   <td class="mlabels-left">

  2924.       <table class="memname">

  2925.         <tr>

  2926.           <td class="memname">bool FatFile::timestamp </td>

  2927.           <td>(</td>

  2928.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2929.           <td class="paramname"><em>file</em></td><td>)</td>

  2930.           <td></td>

  2931.         </tr>

  2932.       </table>

  2933.   </td>

  2934.   <td class="mlabels-right">

  2935. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2936.   </tr>

  2937. </table>

  2938. </div><div class="memdoc">

  2939. <p>Copy a file's timestamps</p>

  2940. <dl class="params"><dt>Parameters</dt><dd>

  2941.   <table class="params">

  2942.     <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>

  2943.   </table>

  2944.   </dd>

  2945. </dl>

  2946. <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>

  2947. <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>

  2948. 

  2949. </div>

  2950. </div>

  2951. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2952. <div class="memitem">

  2953. <div class="memproto">

  2954. <table class="mlabels">

  2955.   <tr>

  2956.   <td class="mlabels-left">

  2957.       <table class="memname">

  2958.         <tr>

  2959.           <td class="memname">bool FatFile::timestamp </td>

  2960.           <td>(</td>

  2961.           <td class="paramtype">uint8_t&#160;</td>

  2962.           <td class="paramname"><em>flags</em>, </td>

  2963.         </tr>

  2964.         <tr>

  2965.           <td class="paramkey"></td>

  2966.           <td></td>

  2967.           <td class="paramtype">uint16_t&#160;</td>

  2968.           <td class="paramname"><em>year</em>, </td>

  2969.         </tr>

  2970.         <tr>

  2971.           <td class="paramkey"></td>

  2972.           <td></td>

  2973.           <td class="paramtype">uint8_t&#160;</td>

  2974.           <td class="paramname"><em>month</em>, </td>

  2975.         </tr>

  2976.         <tr>

  2977.           <td class="paramkey"></td>

  2978.           <td></td>

  2979.           <td class="paramtype">uint8_t&#160;</td>

  2980.           <td class="paramname"><em>day</em>, </td>

  2981.         </tr>

  2982.         <tr>

  2983.           <td class="paramkey"></td>

  2984.           <td></td>

  2985.           <td class="paramtype">uint8_t&#160;</td>

  2986.           <td class="paramname"><em>hour</em>, </td>

  2987.         </tr>

  2988.         <tr>

  2989.           <td class="paramkey"></td>

  2990.           <td></td>

  2991.           <td class="paramtype">uint8_t&#160;</td>

  2992.           <td class="paramname"><em>minute</em>, </td>

  2993.         </tr>

  2994.         <tr>

  2995.           <td class="paramkey"></td>

  2996.           <td></td>

  2997.           <td class="paramtype">uint8_t&#160;</td>

  2998.           <td class="paramname"><em>second</em>&#160;</td>

  2999.         </tr>

  3000.         <tr>

  3001.           <td></td>

  3002.           <td>)</td>

  3003.           <td></td><td></td>

  3004.         </tr>

  3005.       </table>

  3006.   </td>

  3007.   <td class="mlabels-right">

  3008. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3009.   </tr>

  3010. </table>

  3011. </div><div class="memdoc">

  3012. <p>Set a file's timestamps in its directory entry.</p>

  3013. <dl class="params"><dt>Parameters</dt><dd>

  3014.   <table class="params">

  3015.     <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>

  3016.   </table>

  3017.   </dd>

  3018. </dl>

  3019. <p>T_ACCESS - Set the file's last access date.</p>

  3020. <p>T_CREATE - Set the file's creation date and time.</p>

  3021. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3022. <dl class="params"><dt>Parameters</dt><dd>

  3023.   <table class="params">

  3024.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3025.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3026.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3027.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3028.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3029.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3030.   </table>

  3031.   </dd>

  3032. </dl>

  3033. <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>

  3034. <dd>

  3035. 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>

  3036. <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>

  3037. 

  3038. </div>

  3039. </div>

  3040. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  3041. <div class="memitem">

  3042. <div class="memproto">

  3043. <table class="mlabels">

  3044.   <tr>

  3045.   <td class="mlabels-left">

  3046.       <table class="memname">

  3047.         <tr>

  3048.           <td class="memname">bool FatFile::truncate </td>

  3049.           <td>(</td>

  3050.           <td class="paramtype">uint32_t&#160;</td>

  3051.           <td class="paramname"><em>length</em></td><td>)</td>

  3052.           <td></td>

  3053.         </tr>

  3054.       </table>

  3055.   </td>

  3056.   <td class="mlabels-right">

  3057. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3058.   </tr>

  3059. </table>

  3060. </div><div class="memdoc">

  3061. <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>

  3062. <dl class="params"><dt>Parameters</dt><dd>

  3063.   <table class="params">

  3064.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3065.   </table>

  3066.   </dd>

  3067. </dl>

  3068. <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>

  3069. 

  3070. </div>

  3071. </div>

  3072. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  3073. <div class="memitem">

  3074. <div class="memproto">

  3075. <table class="mlabels">

  3076.   <tr>

  3077.   <td class="mlabels-left">

  3078.       <table class="memname">

  3079.         <tr>

  3080.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  3081.           <td>(</td>

  3082.           <td class="paramname"></td><td>)</td>

  3083.           <td> const</td>

  3084.         </tr>

  3085.       </table>

  3086.   </td>

  3087.   <td class="mlabels-right">

  3088. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3089.   </tr>

  3090. </table>

  3091. </div><div class="memdoc">

  3092. <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>

  3093. 

  3094. </div>

  3095. </div>

  3096. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  3097. <div class="memitem">

  3098. <div class="memproto">

  3099. <table class="mlabels">

  3100.   <tr>

  3101.   <td class="mlabels-left">

  3102.       <table class="memname">

  3103.         <tr>

  3104.           <td class="memname">int FatFile::write </td>

  3105.           <td>(</td>

  3106.           <td class="paramtype">uint8_t&#160;</td>

  3107.           <td class="paramname"><em>b</em></td><td>)</td>

  3108.           <td></td>

  3109.         </tr>

  3110.       </table>

  3111.   </td>

  3112.   <td class="mlabels-right">

  3113. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3114.   </tr>

  3115. </table>

  3116. </div><div class="memdoc">

  3117. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  3118.   <table class="params">

  3119.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  3120.   </table>

  3121.   </dd>

  3122. </dl>

  3123. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  3124. 

  3125. </div>

  3126. </div>

  3127. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  3128. <div class="memitem">

  3129. <div class="memproto">

  3130. <table class="mlabels">

  3131.   <tr>

  3132.   <td class="mlabels-left">

  3133.       <table class="memname">

  3134.         <tr>

  3135.           <td class="memname">int FatFile::write </td>

  3136.           <td>(</td>

  3137.           <td class="paramtype">const void *&#160;</td>

  3138.           <td class="paramname"><em>buf</em>, </td>

  3139.         </tr>

  3140.         <tr>

  3141.           <td class="paramkey"></td>

  3142.           <td></td>

  3143.           <td class="paramtype">size_t&#160;</td>

  3144.           <td class="paramname"><em>nbyte</em>&#160;</td>

  3145.         </tr>

  3146.         <tr>

  3147.           <td></td>

  3148.           <td>)</td>

  3149.           <td></td><td></td>

  3150.         </tr>

  3151.       </table>

  3152.   </td>

  3153.   <td class="mlabels-right">

  3154. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3155.   </tr>

  3156. </table>

  3157. </div><div class="memdoc">

  3158. <p>Write data to an open file.</p>

  3159. <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>

  3160. <dl class="params"><dt>Parameters</dt><dd>

  3161.   <table class="params">

  3162.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3163.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  3164.   </table>

  3165.   </dd>

  3166. </dl>

  3167. <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>

  3168. 

  3169. </div>

  3170. </div>

  3171. <hr/>The documentation for this class was generated from the following file:<ul>

  3172. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_file_8h.html">SdFile.h</a></li>

  3173. </ul>

  3174. </div><!-- contents -->

  3175. <!-- start footer part -->

  3176. <hr class="footer"/><address class="footer"><small>

  3177. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3178. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3179. </a> 1.8.8

  3180. </small></address>

  3181. </body>

  3182. </html>