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

2454 lines
111KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: FsFile Class Reference</title>

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.16 -->

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

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

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

  66. <a href="class_fs_file-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">FsFile Class Reference</div>  </div>

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

  70. <div class="contents">

  71. 

  72. <p><a class="el" href="class_fs_base_file.html" title="FsBaseFile class.">FsBaseFile</a> file with Arduino Stream.  

  73.  <a href="class_fs_file.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;FsFile.h&gt;</code></p>

  76. <div class="dynheader">

  77. Inheritance diagram for FsFile:</div>

  78. <div class="dyncontent">

  79. <div class="center"><img src="class_fs_file__inherit__graph.png" border="0" usemap="#_fs_file_inherit__map" alt="Inheritance graph"/></div>

  80. <map name="_fs_file_inherit__map" id="_fs_file_inherit__map">

  81. <area shape="rect" title="FsBaseFile file with Arduino Stream." alt="" coords="65,169,123,196"/>

  82. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="11,80,177,121"/>

  83. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  84. <area shape="rect" href="class_fs_base_file.html" title="FsBaseFile class." alt="" coords="103,5,191,32"/>

  85. </map>

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

  87. <div class="dynheader">

  88. Collaboration diagram for FsFile:</div>

  89. <div class="dyncontent">

  90. <div class="center"><img src="class_fs_file__coll__graph.png" border="0" usemap="#_fs_file_coll__map" alt="Collaboration graph"/></div>

  91. <map name="_fs_file_coll__map" id="_fs_file_coll__map">

  92. <area shape="rect" title="FsBaseFile file with Arduino Stream." alt="" coords="65,169,123,196"/>

  93. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="11,80,177,121"/>

  94. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  95. <area shape="rect" href="class_fs_base_file.html" title="FsBaseFile class." alt="" coords="103,5,191,32"/>

  96. </map>

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

  98. <table class="memberdecls">

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

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

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

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

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

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

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

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

  107. <tr class="memitem:a856bccf55a40ebbea27072dcfea06191"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a856bccf55a40ebbea27072dcfea06191">curPosition</a> ()</td></tr>

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

  109. <tr class="memitem:ac05660570595552c72164a61001899d5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#ac05660570595552c72164a61001899d5">dirIndex</a> ()</td></tr>

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

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

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

  113. <tr class="memitem:adda345ec539688e40e279a4e3020d208"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#adda345ec539688e40e279a4e3020d208">fgetpos</a> (fspos_t *pos)</td></tr>

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

  115. <tr class="memitem:ab6b6b97a6382a763d6de882252412727"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#ab6b6b97a6382a763d6de882252412727">fgets</a> (char *str, int num, char *delim=<a class="el" href="_sys_call_8h.html#ab979d9d4b4923f7c54d6caa6e1a61936">nullptr</a>)</td></tr>

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

  117. <tr class="memitem:aef21ae3af496d80f214918bb40b5b3ba"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#aef21ae3af496d80f214918bb40b5b3ba">fileSize</a> ()</td></tr>

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

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

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

  121. <tr class="memitem:a4bc085bc1ef0569f4ca7f14fff3e5678"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a4bc085bc1ef0569f4ca7f14fff3e5678">fsetpos</a> (const fspos_t *pos)</td></tr>

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

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

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

  125. <tr class="memitem:ad2099dbe6bb8f61e1bf933d8e97b2d86"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#ad2099dbe6bb8f61e1bf933d8e97b2d86">getName</a> (char *<a class="el" href="class_stream_file.html#a8792c863080576eb65ce6cacbe1dd931">name</a>, size_t len)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  139. <tr class="memitem:aecbc336b952eebebfdfcf917863183ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#aecbc336b952eebebfdfcf917863183ee">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  141. <tr class="memitem:a6a254df9866966f7f97478e916fe6a7f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a6a254df9866966f7f97478e916fe6a7f">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags)</td></tr>

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

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

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

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

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

  147. <tr class="memitem:af44f0decd9b11dd45996e81f46e2cdee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#af44f0decd9b11dd45996e81f46e2cdee">open</a> (const char *path, oflag_t oflag=O_RDONLY)</td></tr>

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

  149. <tr class="memitem:aa767859d4a4b4716ebbc4ea42a6d74df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#aa767859d4a4b4716ebbc4ea42a6d74df">open</a> (<a class="el" href="class_fs_base_file.html">FsBaseFile</a> *dir, const char *path, oflag_t oflag=O_RDONLY)</td></tr>

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

  151. <tr class="memitem:ac4edea1afb935119ecaf39607016c3cc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#ac4edea1afb935119ecaf39607016c3cc">open</a> (<a class="el" href="class_fs_base_file.html">FsBaseFile</a> *dir, uint32_t index, oflag_t oflag)</td></tr>

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

  153. <tr class="memitem:a9786eb47f5d001e89ff291c271517547"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a9786eb47f5d001e89ff291c271517547">open</a> (<a class="el" href="class_fs_volume.html">FsVolume</a> *vol, const char *path, oflag_t oflag)</td></tr>

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

  155. <tr class="memitem:acb9b1075f4db76fa7e0521c9aff9c3df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#acb9b1075f4db76fa7e0521c9aff9c3df">openNext</a> (<a class="el" href="class_fs_base_file.html">FsBaseFile</a> *dir, oflag_t oflag=O_RDONLY)</td></tr>

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

  157. <tr class="memitem:ab2f85961e3831d0d654da862becb7433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fs_file.html">FsFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_file.html#ab2f85961e3831d0d654da862becb7433">openNextFile</a> (oflag_t oflag=O_RDONLY)</td></tr>

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

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

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

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

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

  163. <tr class="memitem:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a18a04d1e68a0c1e3e38e5712cd9bbc03">position</a> ()</td></tr>

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

  165. <tr class="memitem:acbc037f9f07c57235bb8b30af5a53ac2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#acbc037f9f07c57235bb8b30af5a53ac2">preAllocate</a> (uint64_t length)</td></tr>

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

  167. <tr class="memitem:a264ba61530aee50dbe9659d41dd2c1d6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a264ba61530aee50dbe9659d41dd2c1d6">printAccessDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  169. <tr class="memitem:a3f75ac7eb6643afcabae28e8c93479c8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a3f75ac7eb6643afcabae28e8c93479c8">printCreateDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  171. <tr class="memitem:a911ae825e67d7e6ade4a672595e060d6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a911ae825e67d7e6ade4a672595e060d6">printField</a> (double value, char term, uint8_t prec=2)</td></tr>

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

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

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

  175. <tr class="memitem:a45639312b8c5aa9ceddb19e654e902b4"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>

  176. <tr class="memitem:a45639312b8c5aa9ceddb19e654e902b4"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a45639312b8c5aa9ceddb19e654e902b4">printField</a> (Type value, char term)</td></tr>

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

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

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

  180. <tr class="memitem:a0f2f813496fa156f9808a5d33c2d8746"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a0f2f813496fa156f9808a5d33c2d8746">printModifyDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  192. <tr class="memitem:af532d87177e86995a053503eb9152115"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#af532d87177e86995a053503eb9152115">rename</a> (const char *newPath)</td></tr>

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

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

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

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

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

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

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

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

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

  202. <tr class="memitem:a773ee6f661fc689a5187f51cb5498086"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a773ee6f661fc689a5187f51cb5498086">seek</a> (uint64_t pos)</td></tr>

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

  204. <tr class="memitem:a5fa242a4598eab5caa6efd4bdf62f5c0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a5fa242a4598eab5caa6efd4bdf62f5c0">seekCur</a> (int64_t offset)</td></tr>

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

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

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

  208. <tr class="memitem:a460f7598c903b8a4b4fe868dacccb6dd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a460f7598c903b8a4b4fe868dacccb6dd">seekSet</a> (uint64_t pos)</td></tr>

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

  210. <tr class="memitem:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a> ()</td></tr>

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

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

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

  214. <tr class="memitem:acea65e639feebaac01964af02a77d324"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#acea65e639feebaac01964af02a77d324">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>

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

  216. <tr class="memitem:a2a0bf00241df08a604f054512746986b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a2a0bf00241df08a604f054512746986b">truncate</a> ()</td></tr>

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

  218. <tr class="memitem:a47247cc54157ef79e0752f55ba01cf7e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#a47247cc54157ef79e0752f55ba01cf7e">truncate</a> (uint64_t length)</td></tr>

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

  220. <tr class="memitem:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0ace3aaaf6d0fb673a43059c0664fab6">write</a> (const uint8_t *buffer, size_t <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

  222. <tr class="memitem:aa763e83fea4889828effc3308f13113a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_base_file.html#aa763e83fea4889828effc3308f13113a">write</a> (const void *buf, size_t count)</td></tr>

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

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

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

  226. </table>

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

  228. <div class="textblock"><p><a class="el" href="class_fs_base_file.html" title="FsBaseFile class.">FsBaseFile</a> file with Arduino Stream. </p>

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

  230. <a id="a0112cc39b64aac6f1ec47741397a7582"></a>

  231. <h2 class="memtitle"><span class="permalink"><a href="#a0112cc39b64aac6f1ec47741397a7582">&#9670;&nbsp;</a></span>available()</h2>

  232. 

  233. <div class="memitem">

  234. <div class="memproto">

  235. <table class="mlabels">

  236.   <tr>

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

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::available </td>

  241.           <td>(</td>

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

  243.           <td></td>

  244.         </tr>

  245.       </table>

  246.   </td>

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

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

  249.   </tr>

  250. </table>

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

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

  253. 

  254. </div>

  255. </div>

  256. <a id="a936fc1e3fb13a6ae1352d027bf0a70f7"></a>

  257. <h2 class="memtitle"><span class="permalink"><a href="#a936fc1e3fb13a6ae1352d027bf0a70f7">&#9670;&nbsp;</a></span>clearWriteError()</h2>

  258. 

  259. <div class="memitem">

  260. <div class="memproto">

  261. <table class="mlabels">

  262.   <tr>

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

  264.       <table class="memname">

  265.         <tr>

  266.           <td class="memname">void FsBaseFile::clearWriteError </td>

  267.           <td>(</td>

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

  269.           <td></td>

  270.         </tr>

  271.       </table>

  272.   </td>

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

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

  275.   </tr>

  276. </table>

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

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

  279. 

  280. </div>

  281. </div>

  282. <a id="aa669c695a839e68e417fb15eebe3de13"></a>

  283. <h2 class="memtitle"><span class="permalink"><a href="#aa669c695a839e68e417fb15eebe3de13">&#9670;&nbsp;</a></span>close()</h2>

  284. 

  285. <div class="memitem">

  286. <div class="memproto">

  287. <table class="mlabels">

  288.   <tr>

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

  290.       <table class="memname">

  291.         <tr>

  292.           <td class="memname">bool FsBaseFile::close </td>

  293.           <td>(</td>

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

  295.           <td></td>

  296.         </tr>

  297.       </table>

  298.   </td>

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

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

  301.   </tr>

  302. </table>

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

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

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

  306. 

  307. </div>

  308. </div>

  309. <a id="a856bccf55a40ebbea27072dcfea06191"></a>

  310. <h2 class="memtitle"><span class="permalink"><a href="#a856bccf55a40ebbea27072dcfea06191">&#9670;&nbsp;</a></span>curPosition()</h2>

  311. 

  312. <div class="memitem">

  313. <div class="memproto">

  314. <table class="mlabels">

  315.   <tr>

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

  317.       <table class="memname">

  318.         <tr>

  319.           <td class="memname">uint64_t FsBaseFile::curPosition </td>

  320.           <td>(</td>

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

  322.           <td></td>

  323.         </tr>

  324.       </table>

  325.   </td>

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

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

  328.   </tr>

  329. </table>

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

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

  332. 

  333. </div>

  334. </div>

  335. <a id="ac05660570595552c72164a61001899d5"></a>

  336. <h2 class="memtitle"><span class="permalink"><a href="#ac05660570595552c72164a61001899d5">&#9670;&nbsp;</a></span>dirIndex()</h2>

  337. 

  338. <div class="memitem">

  339. <div class="memproto">

  340. <table class="mlabels">

  341.   <tr>

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

  343.       <table class="memname">

  344.         <tr>

  345.           <td class="memname">uint32_t FsBaseFile::dirIndex </td>

  346.           <td>(</td>

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

  348.           <td></td>

  349.         </tr>

  350.       </table>

  351.   </td>

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

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

  354.   </tr>

  355. </table>

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

  357. <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>

  358. 

  359. </div>

  360. </div>

  361. <a id="a76aea9766ffeae5454381a0704e62505"></a>

  362. <h2 class="memtitle"><span class="permalink"><a href="#a76aea9766ffeae5454381a0704e62505">&#9670;&nbsp;</a></span>exists()</h2>

  363. 

  364. <div class="memitem">

  365. <div class="memproto">

  366. <table class="mlabels">

  367.   <tr>

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

  369.       <table class="memname">

  370.         <tr>

  371.           <td class="memname">bool FsBaseFile::exists </td>

  372.           <td>(</td>

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

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

  375.           <td></td>

  376.         </tr>

  377.       </table>

  378.   </td>

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

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

  381.   </tr>

  382. </table>

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

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

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

  386.   <table class="params">

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

  388.   </table>

  389.   </dd>

  390. </dl>

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

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

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

  394. 

  395. </div>

  396. </div>

  397. <a id="adda345ec539688e40e279a4e3020d208"></a>

  398. <h2 class="memtitle"><span class="permalink"><a href="#adda345ec539688e40e279a4e3020d208">&#9670;&nbsp;</a></span>fgetpos()</h2>

  399. 

  400. <div class="memitem">

  401. <div class="memproto">

  402. <table class="mlabels">

  403.   <tr>

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

  405.       <table class="memname">

  406.         <tr>

  407.           <td class="memname">void FsBaseFile::fgetpos </td>

  408.           <td>(</td>

  409.           <td class="paramtype">fspos_t *&#160;</td>

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

  411.           <td></td>

  412.         </tr>

  413.       </table>

  414.   </td>

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

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

  417.   </tr>

  418. </table>

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

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

  421.   <table class="params">

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

  423.   </table>

  424.   </dd>

  425. </dl>

  426. 

  427. </div>

  428. </div>

  429. <a id="ab6b6b97a6382a763d6de882252412727"></a>

  430. <h2 class="memtitle"><span class="permalink"><a href="#ab6b6b97a6382a763d6de882252412727">&#9670;&nbsp;</a></span>fgets()</h2>

  431. 

  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">int FsBaseFile::fgets </td>

  440.           <td>(</td>

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

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

  443.         </tr>

  444.         <tr>

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

  446.           <td></td>

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

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

  449.         </tr>

  450.         <tr>

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

  452.           <td></td>

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

  454.           <td class="paramname"><em>delim</em> = <code><a class="el" href="_sys_call_8h.html#ab979d9d4b4923f7c54d6caa6e1a61936">nullptr</a></code>&#160;</td>

  455.         </tr>

  456.         <tr>

  457.           <td></td>

  458.           <td>)</td>

  459.           <td></td><td></td>

  460.         </tr>

  461.       </table>

  462.   </td>

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

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

  465.   </tr>

  466. </table>

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

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

  469. <p><a class="el" href="class_fs_base_file.html#ab6b6b97a6382a763d6de882252412727">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>

  470. <p><a class="el" href="class_fs_base_file.html#ab6b6b97a6382a763d6de882252412727">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>

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

  472.   <table class="params">

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

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

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

  476.   </table>

  477.   </dd>

  478. </dl>

  479. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fs_base_file.html#ab6b6b97a6382a763d6de882252412727">fgets()</a> returns the length of the string in <em>str</em>. If no data is read, <a class="el" href="class_fs_base_file.html#ab6b6b97a6382a763d6de882252412727">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>

  480. 

  481. </div>

  482. </div>

  483. <a id="aef21ae3af496d80f214918bb40b5b3ba"></a>

  484. <h2 class="memtitle"><span class="permalink"><a href="#aef21ae3af496d80f214918bb40b5b3ba">&#9670;&nbsp;</a></span>fileSize()</h2>

  485. 

  486. <div class="memitem">

  487. <div class="memproto">

  488. <table class="mlabels">

  489.   <tr>

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

  491.       <table class="memname">

  492.         <tr>

  493.           <td class="memname">uint64_t FsBaseFile::fileSize </td>

  494.           <td>(</td>

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

  496.           <td></td>

  497.         </tr>

  498.       </table>

  499.   </td>

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

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

  502.   </tr>

  503. </table>

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

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

  506. 

  507. </div>

  508. </div>

  509. <a id="a32f813e659414892a58aa5157fe14f82"></a>

  510. <h2 class="memtitle"><span class="permalink"><a href="#a32f813e659414892a58aa5157fe14f82">&#9670;&nbsp;</a></span>flush()</h2>

  511. 

  512. <div class="memitem">

  513. <div class="memproto">

  514. <table class="mlabels">

  515.   <tr>

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

  517.       <table class="memname">

  518.         <tr>

  519.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::flush </td>

  520.           <td>(</td>

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

  522.           <td></td>

  523.         </tr>

  524.       </table>

  525.   </td>

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

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

  528.   </tr>

  529. </table>

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

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

  532. 

  533. </div>

  534. </div>

  535. <a id="a4bc085bc1ef0569f4ca7f14fff3e5678"></a>

  536. <h2 class="memtitle"><span class="permalink"><a href="#a4bc085bc1ef0569f4ca7f14fff3e5678">&#9670;&nbsp;</a></span>fsetpos()</h2>

  537. 

  538. <div class="memitem">

  539. <div class="memproto">

  540. <table class="mlabels">

  541.   <tr>

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

  543.       <table class="memname">

  544.         <tr>

  545.           <td class="memname">void FsBaseFile::fsetpos </td>

  546.           <td>(</td>

  547.           <td class="paramtype">const fspos_t *&#160;</td>

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

  549.           <td></td>

  550.         </tr>

  551.       </table>

  552.   </td>

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

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

  555.   </tr>

  556. </table>

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

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

  559.   <table class="params">

  560.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  561.   </table>

  562.   </dd>

  563. </dl>

  564. 

  565. </div>

  566. </div>

  567. <a id="a7553d4aeb68fe8d3f1b61a16c8005e34"></a>

  568. <h2 class="memtitle"><span class="permalink"><a href="#a7553d4aeb68fe8d3f1b61a16c8005e34">&#9670;&nbsp;</a></span>getError()</h2>

  569. 

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

  577.           <td class="memname">uint8_t FsBaseFile::getError </td>

  578.           <td>(</td>

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

  580.           <td></td>

  581.         </tr>

  582.       </table>

  583.   </td>

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

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

  586.   </tr>

  587. </table>

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

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

  590. 

  591. </div>

  592. </div>

  593. <a id="ad2099dbe6bb8f61e1bf933d8e97b2d86"></a>

  594. <h2 class="memtitle"><span class="permalink"><a href="#ad2099dbe6bb8f61e1bf933d8e97b2d86">&#9670;&nbsp;</a></span>getName()</h2>

  595. 

  596. <div class="memitem">

  597. <div class="memproto">

  598. <table class="mlabels">

  599.   <tr>

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

  601.       <table class="memname">

  602.         <tr>

  603.           <td class="memname">size_t FsBaseFile::getName </td>

  604.           <td>(</td>

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

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

  607.         </tr>

  608.         <tr>

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

  610.           <td></td>

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

  612.           <td class="paramname"><em>len</em>&#160;</td>

  613.         </tr>

  614.         <tr>

  615.           <td></td>

  616.           <td>)</td>

  617.           <td></td><td></td>

  618.         </tr>

  619.       </table>

  620.   </td>

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

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

  623.   </tr>

  624. </table>

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

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

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

  628.   <table class="params">

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

  630.     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size of the array in bytes. The array must be at least 13 bytes long. The file's name will be truncated if the file's name is too long. </td></tr>

  631.   </table>

  632.   </dd>

  633. </dl>

  634. <dl class="section return"><dt>Returns</dt><dd>The length of the returned string. </dd></dl>

  635. 

  636. </div>

  637. </div>

  638. <a id="ab5525bef93bab61569225374d475f2cb"></a>

  639. <h2 class="memtitle"><span class="permalink"><a href="#ab5525bef93bab61569225374d475f2cb">&#9670;&nbsp;</a></span>getWriteError()</h2>

  640. 

  641. <div class="memitem">

  642. <div class="memproto">

  643. <table class="mlabels">

  644.   <tr>

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

  646.       <table class="memname">

  647.         <tr>

  648.           <td class="memname">bool FsBaseFile::getWriteError </td>

  649.           <td>(</td>

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

  651.           <td></td>

  652.         </tr>

  653.       </table>

  654.   </td>

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

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

  657.   </tr>

  658. </table>

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

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

  661. 

  662. </div>

  663. </div>

  664. <a id="ae93db43779d54734855005116244f6aa"></a>

  665. <h2 class="memtitle"><span class="permalink"><a href="#ae93db43779d54734855005116244f6aa">&#9670;&nbsp;</a></span>isDir()</h2>

  666. 

  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 FsBaseFile::isDir </td>

  675.           <td>(</td>

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

  677.           <td></td>

  678.         </tr>

  679.       </table>

  680.   </td>

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

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

  683.   </tr>

  684. </table>

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

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

  687. 

  688. </div>

  689. </div>

  690. <a id="a586ad44055eca4c1b2b457299b829d44"></a>

  691. <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">&#9670;&nbsp;</a></span>isDirectory()</h2>

  692. 

  693. <div class="memitem">

  694. <div class="memproto">

  695. <table class="mlabels">

  696.   <tr>

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

  698.       <table class="memname">

  699.         <tr>

  700.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::isDirectory </td>

  701.           <td>(</td>

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

  703.           <td></td>

  704.         </tr>

  705.       </table>

  706.   </td>

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

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

  709.   </tr>

  710. </table>

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

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

  713. 

  714. </div>

  715. </div>

  716. <a id="a00e76b229cbb5098e1eb88e64a41dbfb"></a>

  717. <h2 class="memtitle"><span class="permalink"><a href="#a00e76b229cbb5098e1eb88e64a41dbfb">&#9670;&nbsp;</a></span>isHidden()</h2>

  718. 

  719. <div class="memitem">

  720. <div class="memproto">

  721. <table class="mlabels">

  722.   <tr>

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

  724.       <table class="memname">

  725.         <tr>

  726.           <td class="memname">bool FsBaseFile::isHidden </td>

  727.           <td>(</td>

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

  729.           <td></td>

  730.         </tr>

  731.       </table>

  732.   </td>

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

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

  735.   </tr>

  736. </table>

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

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

  739. 

  740. </div>

  741. </div>

  742. <a id="a707007ff19ac5e4eb94cd0b26c542e0e"></a>

  743. <h2 class="memtitle"><span class="permalink"><a href="#a707007ff19ac5e4eb94cd0b26c542e0e">&#9670;&nbsp;</a></span>isOpen()</h2>

  744. 

  745. <div class="memitem">

  746. <div class="memproto">

  747. <table class="mlabels">

  748.   <tr>

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

  750.       <table class="memname">

  751.         <tr>

  752.           <td class="memname">bool FsBaseFile::isOpen </td>

  753.           <td>(</td>

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

  755.           <td></td>

  756.         </tr>

  757.       </table>

  758.   </td>

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

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

  761.   </tr>

  762. </table>

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

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

  765. 

  766. </div>

  767. </div>

  768. <a id="a3140f64c85218c4b2f12f711483cd4c6"></a>

  769. <h2 class="memtitle"><span class="permalink"><a href="#a3140f64c85218c4b2f12f711483cd4c6">&#9670;&nbsp;</a></span>isSubDir()</h2>

  770. 

  771. <div class="memitem">

  772. <div class="memproto">

  773. <table class="mlabels">

  774.   <tr>

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

  776.       <table class="memname">

  777.         <tr>

  778.           <td class="memname">bool FsBaseFile::isSubDir </td>

  779.           <td>(</td>

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

  781.           <td></td>

  782.         </tr>

  783.       </table>

  784.   </td>

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

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

  787.   </tr>

  788. </table>

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

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

  791. 

  792. </div>

  793. </div>

  794. <a id="aecbc336b952eebebfdfcf917863183ee"></a>

  795. <h2 class="memtitle"><span class="permalink"><a href="#aecbc336b952eebebfdfcf917863183ee">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>

  796. 

  797. <div class="memitem">

  798. <div class="memproto">

  799. <table class="mlabels">

  800.   <tr>

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

  802.       <table class="memname">

  803.         <tr>

  804.           <td class="memname">bool FsBaseFile::ls </td>

  805.           <td>(</td>

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

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

  808.           <td></td>

  809.         </tr>

  810.       </table>

  811.   </td>

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

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

  814.   </tr>

  815. </table>

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

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

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

  819.   <table class="params">

  820.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object.</td></tr>

  821.   </table>

  822.   </dd>

  823. </dl>

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

  825. 

  826. </div>

  827. </div>

  828. <a id="a6a254df9866966f7f97478e916fe6a7f"></a>

  829. <h2 class="memtitle"><span class="permalink"><a href="#a6a254df9866966f7f97478e916fe6a7f">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>

  830. 

  831. <div class="memitem">

  832. <div class="memproto">

  833. <table class="mlabels">

  834.   <tr>

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

  836.       <table class="memname">

  837.         <tr>

  838.           <td class="memname">bool FsBaseFile::ls </td>

  839.           <td>(</td>

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

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

  842.         </tr>

  843.         <tr>

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

  845.           <td></td>

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

  847.           <td class="paramname"><em>flags</em>&#160;</td>

  848.         </tr>

  849.         <tr>

  850.           <td></td>

  851.           <td>)</td>

  852.           <td></td><td></td>

  853.         </tr>

  854.       </table>

  855.   </td>

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

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

  858.   </tr>

  859. </table>

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

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

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

  863.   <table class="params">

  864.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object. </td></tr>

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

  866.   </table>

  867.   </dd>

  868. </dl>

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

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

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

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

  873. 

  874. </div>

  875. </div>

  876. <a id="a8b7aa7f2c63882e483336dfe12ef6800"></a>

  877. <h2 class="memtitle"><span class="permalink"><a href="#a8b7aa7f2c63882e483336dfe12ef6800">&#9670;&nbsp;</a></span>mkdir()</h2>

  878. 

  879. <div class="memitem">

  880. <div class="memproto">

  881. <table class="mlabels">

  882.   <tr>

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

  884.       <table class="memname">

  885.         <tr>

  886.           <td class="memname">bool FsBaseFile::mkdir </td>

  887.           <td>(</td>

  888.           <td class="paramtype"><a class="el" href="class_fs_base_file.html">FsBaseFile</a> *&#160;</td>

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

  890.         </tr>

  891.         <tr>

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

  893.           <td></td>

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

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

  896.         </tr>

  897.         <tr>

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

  899.           <td></td>

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

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

  902.         </tr>

  903.         <tr>

  904.           <td></td>

  905.           <td>)</td>

  906.           <td></td><td></td>

  907.         </tr>

  908.       </table>

  909.   </td>

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

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

  912.   </tr>

  913. </table>

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

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

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

  917.   <table class="params">

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

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

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

  921.   </table>

  922.   </dd>

  923. </dl>

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

  925. 

  926. </div>

  927. </div>

  928. <a id="a8792c863080576eb65ce6cacbe1dd931"></a>

  929. <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">&#9670;&nbsp;</a></span>name()</h2>

  930. 

  931. <div class="memitem">

  932. <div class="memproto">

  933. <table class="mlabels">

  934.   <tr>

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

  936.       <table class="memname">

  937.         <tr>

  938.           <td class="memname">const char* <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::name </td>

  939.           <td>(</td>

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

  941.           <td> const</td>

  942.         </tr>

  943.       </table>

  944.   </td>

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

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

  947.   </tr>

  948. </table>

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

  950. <p>No longer implemented due to Long File Names.</p>

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

  952. 

  953. </div>

  954. </div>

  955. <a id="af44f0decd9b11dd45996e81f46e2cdee"></a>

  956. <h2 class="memtitle"><span class="permalink"><a href="#af44f0decd9b11dd45996e81f46e2cdee">&#9670;&nbsp;</a></span>open() <span class="overload">[1/4]</span></h2>

  957. 

  958. <div class="memitem">

  959. <div class="memproto">

  960. <table class="mlabels">

  961.   <tr>

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

  963.       <table class="memname">

  964.         <tr>

  965.           <td class="memname">bool FsBaseFile::open </td>

  966.           <td>(</td>

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

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

  969.         </tr>

  970.         <tr>

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

  972.           <td></td>

  973.           <td class="paramtype">oflag_t&#160;</td>

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

  975.         </tr>

  976.         <tr>

  977.           <td></td>

  978.           <td>)</td>

  979.           <td></td><td></td>

  980.         </tr>

  981.       </table>

  982.   </td>

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

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

  985.   </tr>

  986. </table>

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

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

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

  990.   <table class="params">

  991.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>

  992.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of open flags.</td></tr>

  993.   </table>

  994.   </dd>

  995. </dl>

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

  997. 

  998. </div>

  999. </div>

  1000. <a id="aa767859d4a4b4716ebbc4ea42a6d74df"></a>

  1001. <h2 class="memtitle"><span class="permalink"><a href="#aa767859d4a4b4716ebbc4ea42a6d74df">&#9670;&nbsp;</a></span>open() <span class="overload">[2/4]</span></h2>

  1002. 

  1003. <div class="memitem">

  1004. <div class="memproto">

  1005. <table class="mlabels">

  1006.   <tr>

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

  1008.       <table class="memname">

  1009.         <tr>

  1010.           <td class="memname">bool FsBaseFile::open </td>

  1011.           <td>(</td>

  1012.           <td class="paramtype"><a class="el" href="class_fs_base_file.html">FsBaseFile</a> *&#160;</td>

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

  1014.         </tr>

  1015.         <tr>

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

  1017.           <td></td>

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

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

  1020.         </tr>

  1021.         <tr>

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

  1023.           <td></td>

  1024.           <td class="paramtype">oflag_t&#160;</td>

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

  1026.         </tr>

  1027.         <tr>

  1028.           <td></td>

  1029.           <td>)</td>

  1030.           <td></td><td></td>

  1031.         </tr>

  1032.       </table>

  1033.   </td>

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

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

  1036.   </tr>

  1037. </table>

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

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

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

  1041.   <table class="params">

  1042.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>An open file instance for the directory containing the file to be opened.</td></tr>

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

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

  1045.   </table>

  1046.   </dd>

  1047. </dl>

  1048. <p>O_RDONLY - Open for reading only..</p>

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

  1050. <p>O_WRONLY - Open for writing only.</p>

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

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

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

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

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

  1056. <p>O_EXCL - If O_CREAT and O_EXCL are set, <a class="el" href="class_fs_base_file.html#aa767859d4a4b4716ebbc4ea42a6d74df">open()</a> shall fail if the file exists.</p>

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

  1058. <p>WARNING: A given file must not be opened by more than one file object or file corruption may occur.</p>

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

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

  1061. 

  1062. </div>

  1063. </div>

  1064. <a id="ac4edea1afb935119ecaf39607016c3cc"></a>

  1065. <h2 class="memtitle"><span class="permalink"><a href="#ac4edea1afb935119ecaf39607016c3cc">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>

  1066. 

  1067. <div class="memitem">

  1068. <div class="memproto">

  1069. <table class="mlabels">

  1070.   <tr>

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

  1072.       <table class="memname">

  1073.         <tr>

  1074.           <td class="memname">bool FsBaseFile::open </td>

  1075.           <td>(</td>

  1076.           <td class="paramtype"><a class="el" href="class_fs_base_file.html">FsBaseFile</a> *&#160;</td>

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

  1078.         </tr>

  1079.         <tr>

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

  1081.           <td></td>

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

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

  1084.         </tr>

  1085.         <tr>

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

  1087.           <td></td>

  1088.           <td class="paramtype">oflag_t&#160;</td>

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

  1090.         </tr>

  1091.         <tr>

  1092.           <td></td>

  1093.           <td>)</td>

  1094.           <td></td><td></td>

  1095.         </tr>

  1096.       </table>

  1097.   </td>

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

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

  1100.   </tr>

  1101. </table>

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

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

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

  1105.   <table class="params">

  1106.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>An open <a class="el" href="class_fs_file.html" title="FsBaseFile file with Arduino Stream.">FsFile</a> instance for the directory.</td></tr>

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

  1108.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open flags. See see FsFile::open(FsFile*, const char*, uint8_t).</td></tr>

  1109.   </table>

  1110.   </dd>

  1111. </dl>

  1112. <p>See <a class="el" href="class_fs_base_file.html#aa767859d4a4b4716ebbc4ea42a6d74df">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>

  1113. 

  1114. </div>

  1115. </div>

  1116. <a id="a9786eb47f5d001e89ff291c271517547"></a>

  1117. <h2 class="memtitle"><span class="permalink"><a href="#a9786eb47f5d001e89ff291c271517547">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>

  1118. 

  1119. <div class="memitem">

  1120. <div class="memproto">

  1121. <table class="mlabels">

  1122.   <tr>

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

  1124.       <table class="memname">

  1125.         <tr>

  1126.           <td class="memname">bool FsBaseFile::open </td>

  1127.           <td>(</td>

  1128.           <td class="paramtype"><a class="el" href="class_fs_volume.html">FsVolume</a> *&#160;</td>

  1129.           <td class="paramname"><em>vol</em>, </td>

  1130.         </tr>

  1131.         <tr>

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

  1133.           <td></td>

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

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

  1136.         </tr>

  1137.         <tr>

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

  1139.           <td></td>

  1140.           <td class="paramtype">oflag_t&#160;</td>

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

  1142.         </tr>

  1143.         <tr>

  1144.           <td></td>

  1145.           <td>)</td>

  1146.           <td></td><td></td>

  1147.         </tr>

  1148.       </table>

  1149.   </td>

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

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

  1152.   </tr>

  1153. </table>

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

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

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

  1157.   <table class="params">

  1158.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>

  1159.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>

  1160.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of open flags.</td></tr>

  1161.   </table>

  1162.   </dd>

  1163. </dl>

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

  1165. 

  1166. </div>

  1167. </div>

  1168. <a id="acb9b1075f4db76fa7e0521c9aff9c3df"></a>

  1169. <h2 class="memtitle"><span class="permalink"><a href="#acb9b1075f4db76fa7e0521c9aff9c3df">&#9670;&nbsp;</a></span>openNext()</h2>

  1170. 

  1171. <div class="memitem">

  1172. <div class="memproto">

  1173. <table class="mlabels">

  1174.   <tr>

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

  1176.       <table class="memname">

  1177.         <tr>

  1178.           <td class="memname">bool FsBaseFile::openNext </td>

  1179.           <td>(</td>

  1180.           <td class="paramtype"><a class="el" href="class_fs_base_file.html">FsBaseFile</a> *&#160;</td>

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

  1182.         </tr>

  1183.         <tr>

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

  1185.           <td></td>

  1186.           <td class="paramtype">oflag_t&#160;</td>

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

  1188.         </tr>

  1189.         <tr>

  1190.           <td></td>

  1191.           <td>)</td>

  1192.           <td></td><td></td>

  1193.         </tr>

  1194.       </table>

  1195.   </td>

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

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

  1198.   </tr>

  1199. </table>

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

  1201. <p>Opens the next file or folder in a directory. </p><dl class="params"><dt>Parameters</dt><dd>

  1202.   <table class="params">

  1203.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>directory containing files. </td></tr>

  1204.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  1205.   </table>

  1206.   </dd>

  1207. </dl>

  1208. <dl class="section return"><dt>Returns</dt><dd>a file object. </dd></dl>

  1209. 

  1210. </div>

  1211. </div>

  1212. <a id="ab2f85961e3831d0d654da862becb7433"></a>

  1213. <h2 class="memtitle"><span class="permalink"><a href="#ab2f85961e3831d0d654da862becb7433">&#9670;&nbsp;</a></span>openNextFile()</h2>

  1214. 

  1215. <div class="memitem">

  1216. <div class="memproto">

  1217. <table class="mlabels">

  1218.   <tr>

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

  1220.       <table class="memname">

  1221.         <tr>

  1222.           <td class="memname"><a class="el" href="class_fs_file.html">FsFile</a> FsFile::openNextFile </td>

  1223.           <td>(</td>

  1224.           <td class="paramtype">oflag_t&#160;</td>

  1225.           <td class="paramname"><em>oflag</em> = <code>O_RDONLY</code></td><td>)</td>

  1226.           <td></td>

  1227.         </tr>

  1228.       </table>

  1229.   </td>

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

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

  1232.   </tr>

  1233. </table>

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

  1235. <p>Opens the next file or folder in a directory.</p>

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

  1237.   <table class="params">

  1238.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  1239.   </table>

  1240.   </dd>

  1241. </dl>

  1242. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>

  1243. 

  1244. </div>

  1245. </div>

  1246. <a id="a3ad633f3efc2701a3a89e776436b14e1"></a>

  1247. <h2 class="memtitle"><span class="permalink"><a href="#a3ad633f3efc2701a3a89e776436b14e1">&#9670;&nbsp;</a></span>operator bool()</h2>

  1248. 

  1249. <div class="memitem">

  1250. <div class="memproto">

  1251. <table class="mlabels">

  1252.   <tr>

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

  1254.       <table class="memname">

  1255.         <tr>

  1256.           <td class="memname">FsBaseFile::operator bool </td>

  1257.           <td>(</td>

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

  1259.           <td></td>

  1260.         </tr>

  1261.       </table>

  1262.   </td>

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

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

  1265.   </tr>

  1266. </table>

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

  1268. <p>The parenthesis operator.</p>

  1269. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  1270. 

  1271. </div>

  1272. </div>

  1273. <a id="af0da96e502485133ca0cff27fa130082"></a>

  1274. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>

  1275. 

  1276. <div class="memitem">

  1277. <div class="memproto">

  1278. <table class="mlabels">

  1279.   <tr>

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

  1281.       <table class="memname">

  1282.         <tr>

  1283.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::peek </td>

  1284.           <td>(</td>

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

  1286.           <td></td>

  1287.         </tr>

  1288.       </table>

  1289.   </td>

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

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

  1292.   </tr>

  1293. </table>

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

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

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

  1297. 

  1298. </div>

  1299. </div>

  1300. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>

  1301. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>

  1302. 

  1303. <div class="memitem">

  1304. <div class="memproto">

  1305. <table class="mlabels">

  1306.   <tr>

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

  1308.       <table class="memname">

  1309.         <tr>

  1310.           <td class="memname">uint64_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::position </td>

  1311.           <td>(</td>

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

  1313.           <td></td>

  1314.         </tr>

  1315.       </table>

  1316.   </td>

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

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

  1319.   </tr>

  1320. </table>

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

  1322. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  1323. 

  1324. </div>

  1325. </div>

  1326. <a id="acbc037f9f07c57235bb8b30af5a53ac2"></a>

  1327. <h2 class="memtitle"><span class="permalink"><a href="#acbc037f9f07c57235bb8b30af5a53ac2">&#9670;&nbsp;</a></span>preAllocate()</h2>

  1328. 

  1329. <div class="memitem">

  1330. <div class="memproto">

  1331. <table class="mlabels">

  1332.   <tr>

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

  1334.       <table class="memname">

  1335.         <tr>

  1336.           <td class="memname">bool FsBaseFile::preAllocate </td>

  1337.           <td>(</td>

  1338.           <td class="paramtype">uint64_t&#160;</td>

  1339.           <td class="paramname"><em>length</em></td><td>)</td>

  1340.           <td></td>

  1341.         </tr>

  1342.       </table>

  1343.   </td>

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

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

  1346.   </tr>

  1347. </table>

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

  1349. <p>Allocate contiguous clusters to an empty file.</p>

  1350. <p>The file must be empty with no clusters allocated.</p>

  1351. <p>The file will contain uninitialized data for FAT16/FAT32 files. exFAT files will have zero validLength and dataLength will equal the requested length.</p>

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

  1353.   <table class="params">

  1354.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  1355.   </table>

  1356.   </dd>

  1357. </dl>

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

  1359. 

  1360. </div>

  1361. </div>

  1362. <a id="a264ba61530aee50dbe9659d41dd2c1d6"></a>

  1363. <h2 class="memtitle"><span class="permalink"><a href="#a264ba61530aee50dbe9659d41dd2c1d6">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  1364. 

  1365. <div class="memitem">

  1366. <div class="memproto">

  1367. <table class="mlabels">

  1368.   <tr>

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

  1370.       <table class="memname">

  1371.         <tr>

  1372.           <td class="memname">size_t FsBaseFile::printAccessDateTime </td>

  1373.           <td>(</td>

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

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

  1376.           <td></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. <p>Print a file's access date and time</p>

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

  1387.   <table class="params">

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

  1389.   </table>

  1390.   </dd>

  1391. </dl>

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

  1393. 

  1394. </div>

  1395. </div>

  1396. <a id="a3f75ac7eb6643afcabae28e8c93479c8"></a>

  1397. <h2 class="memtitle"><span class="permalink"><a href="#a3f75ac7eb6643afcabae28e8c93479c8">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  1398. 

  1399. <div class="memitem">

  1400. <div class="memproto">

  1401. <table class="mlabels">

  1402.   <tr>

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

  1404.       <table class="memname">

  1405.         <tr>

  1406.           <td class="memname">size_t FsBaseFile::printCreateDateTime </td>

  1407.           <td>(</td>

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

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

  1410.           <td></td>

  1411.         </tr>

  1412.       </table>

  1413.   </td>

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

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

  1416.   </tr>

  1417. </table>

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

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

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

  1421.   <table class="params">

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

  1423.   </table>

  1424.   </dd>

  1425. </dl>

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

  1427. 

  1428. </div>

  1429. </div>

  1430. <a id="a911ae825e67d7e6ade4a672595e060d6"></a>

  1431. <h2 class="memtitle"><span class="permalink"><a href="#a911ae825e67d7e6ade4a672595e060d6">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  1432. 

  1433. <div class="memitem">

  1434. <div class="memproto">

  1435. <table class="mlabels">

  1436.   <tr>

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

  1438.       <table class="memname">

  1439.         <tr>

  1440.           <td class="memname">size_t FsBaseFile::printField </td>

  1441.           <td>(</td>

  1442.           <td class="paramtype">double&#160;</td>

  1443.           <td class="paramname"><em>value</em>, </td>

  1444.         </tr>

  1445.         <tr>

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

  1447.           <td></td>

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

  1449.           <td class="paramname"><em>term</em>, </td>

  1450.         </tr>

  1451.         <tr>

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

  1453.           <td></td>

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

  1455.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  1456.         </tr>

  1457.         <tr>

  1458.           <td></td>

  1459.           <td>)</td>

  1460.           <td></td><td></td>

  1461.         </tr>

  1462.       </table>

  1463.   </td>

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

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

  1466.   </tr>

  1467. </table>

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

  1469. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1470.   <table class="params">

  1471.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1472.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1473.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  1474.   </table>

  1475.   </dd>

  1476. </dl>

  1477. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1478. 

  1479. </div>

  1480. </div>

  1481. <a id="a5dd2738efe2e550f56037536bc252f13"></a>

  1482. <h2 class="memtitle"><span class="permalink"><a href="#a5dd2738efe2e550f56037536bc252f13">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  1483. 

  1484. <div class="memitem">

  1485. <div class="memproto">

  1486. <table class="mlabels">

  1487.   <tr>

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

  1489.       <table class="memname">

  1490.         <tr>

  1491.           <td class="memname">size_t FsBaseFile::printField </td>

  1492.           <td>(</td>

  1493.           <td class="paramtype">float&#160;</td>

  1494.           <td class="paramname"><em>value</em>, </td>

  1495.         </tr>

  1496.         <tr>

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

  1498.           <td></td>

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

  1500.           <td class="paramname"><em>term</em>, </td>

  1501.         </tr>

  1502.         <tr>

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

  1504.           <td></td>

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

  1506.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  1507.         </tr>

  1508.         <tr>

  1509.           <td></td>

  1510.           <td>)</td>

  1511.           <td></td><td></td>

  1512.         </tr>

  1513.       </table>

  1514.   </td>

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

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

  1517.   </tr>

  1518. </table>

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

  1520. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1521.   <table class="params">

  1522.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1523.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1524.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  1525.   </table>

  1526.   </dd>

  1527. </dl>

  1528. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1529. 

  1530. </div>

  1531. </div>

  1532. <a id="a45639312b8c5aa9ceddb19e654e902b4"></a>

  1533. <h2 class="memtitle"><span class="permalink"><a href="#a45639312b8c5aa9ceddb19e654e902b4">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  1534. 

  1535. <div class="memitem">

  1536. <div class="memproto">

  1537. <div class="memtemplate">

  1538. template&lt;typename Type &gt; </div>

  1539. <table class="mlabels">

  1540.   <tr>

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

  1542.       <table class="memname">

  1543.         <tr>

  1544.           <td class="memname">size_t FsBaseFile::printField </td>

  1545.           <td>(</td>

  1546.           <td class="paramtype">Type&#160;</td>

  1547.           <td class="paramname"><em>value</em>, </td>

  1548.         </tr>

  1549.         <tr>

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

  1551.           <td></td>

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

  1553.           <td class="paramname"><em>term</em>&#160;</td>

  1554.         </tr>

  1555.         <tr>

  1556.           <td></td>

  1557.           <td>)</td>

  1558.           <td></td><td></td>

  1559.         </tr>

  1560.       </table>

  1561.   </td>

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

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

  1564.   </tr>

  1565. </table>

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

  1567. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1568.   <table class="params">

  1569.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1570.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1571.   </table>

  1572.   </dd>

  1573. </dl>

  1574. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1575. 

  1576. </div>

  1577. </div>

  1578. <a id="a6760471e3c445f66b94f3f0e96fdfe10"></a>

  1579. <h2 class="memtitle"><span class="permalink"><a href="#a6760471e3c445f66b94f3f0e96fdfe10">&#9670;&nbsp;</a></span>printFileSize()</h2>

  1580. 

  1581. <div class="memitem">

  1582. <div class="memproto">

  1583. <table class="mlabels">

  1584.   <tr>

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

  1586.       <table class="memname">

  1587.         <tr>

  1588.           <td class="memname">size_t FsBaseFile::printFileSize </td>

  1589.           <td>(</td>

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

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

  1592.           <td></td>

  1593.         </tr>

  1594.       </table>

  1595.   </td>

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

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

  1598.   </tr>

  1599. </table>

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

  1601. <p>Print a file's size.</p>

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

  1603.   <table class="params">

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

  1605.   </table>

  1606.   </dd>

  1607. </dl>

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

  1609. 

  1610. </div>

  1611. </div>

  1612. <a id="a0f2f813496fa156f9808a5d33c2d8746"></a>

  1613. <h2 class="memtitle"><span class="permalink"><a href="#a0f2f813496fa156f9808a5d33c2d8746">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  1614. 

  1615. <div class="memitem">

  1616. <div class="memproto">

  1617. <table class="mlabels">

  1618.   <tr>

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

  1620.       <table class="memname">

  1621.         <tr>

  1622.           <td class="memname">size_t FsBaseFile::printModifyDateTime </td>

  1623.           <td>(</td>

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

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

  1626.           <td></td>

  1627.         </tr>

  1628.       </table>

  1629.   </td>

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

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

  1632.   </tr>

  1633. </table>

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

  1635. <p>Print a file's modify date and time</p>

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

  1637.   <table class="params">

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

  1639.   </table>

  1640.   </dd>

  1641. </dl>

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

  1643. 

  1644. </div>

  1645. </div>

  1646. <a id="a178a1cbe2bce19758a55bd00fa262732"></a>

  1647. <h2 class="memtitle"><span class="permalink"><a href="#a178a1cbe2bce19758a55bd00fa262732">&#9670;&nbsp;</a></span>printName()</h2>

  1648. 

  1649. <div class="memitem">

  1650. <div class="memproto">

  1651. <table class="mlabels">

  1652.   <tr>

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

  1654.       <table class="memname">

  1655.         <tr>

  1656.           <td class="memname">size_t FsBaseFile::printName </td>

  1657.           <td>(</td>

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

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

  1660.           <td></td>

  1661.         </tr>

  1662.       </table>

  1663.   </td>

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

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

  1666.   </tr>

  1667. </table>

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

  1669. <p>Print a file's name</p>

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

  1671.   <table class="params">

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

  1673.   </table>

  1674.   </dd>

  1675. </dl>

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

  1677. 

  1678. </div>

  1679. </div>

  1680. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  1681. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  1682. 

  1683. <div class="memitem">

  1684. <div class="memproto">

  1685. <table class="mlabels">

  1686.   <tr>

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

  1688.       <table class="memname">

  1689.         <tr>

  1690.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::read </td>

  1691.           <td>(</td>

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

  1693.           <td></td>

  1694.         </tr>

  1695.       </table>

  1696.   </td>

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

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

  1699.   </tr>

  1700. </table>

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

  1702. <p>Read the next byte from a file.</p>

  1703. <dl class="section return"><dt>Returns</dt><dd>For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1. </dd></dl>

  1704. 

  1705. </div>

  1706. </div>

  1707. <a id="ae8d8cb4cceda9d56e8dae692d04a46e6"></a>

  1708. <h2 class="memtitle"><span class="permalink"><a href="#ae8d8cb4cceda9d56e8dae692d04a46e6">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  1709. 

  1710. <div class="memitem">

  1711. <div class="memproto">

  1712. <table class="mlabels">

  1713.   <tr>

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

  1715.       <table class="memname">

  1716.         <tr>

  1717.           <td class="memname">int FsBaseFile::read </td>

  1718.           <td>(</td>

  1719.           <td class="paramtype">void *&#160;</td>

  1720.           <td class="paramname"><em>buf</em>, </td>

  1721.         </tr>

  1722.         <tr>

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

  1724.           <td></td>

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

  1726.           <td class="paramname"><em>count</em>&#160;</td>

  1727.         </tr>

  1728.         <tr>

  1729.           <td></td>

  1730.           <td>)</td>

  1731.           <td></td><td></td>

  1732.         </tr>

  1733.       </table>

  1734.   </td>

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

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

  1737.   </tr>

  1738. </table>

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

  1740. <p>Read data from a file starting at the current position.</p>

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

  1742.   <table class="params">

  1743.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  1744.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  1745.   </table>

  1746.   </dd>

  1747. </dl>

  1748. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read()</a> returns the number of bytes read. A value less than <em>count</em>, including zero, will be returned if end of file is reached. If an error occurs, <a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read()</a> returns -1. Possible errors include <a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read()</a> called before a file has been opened, corrupt file system or an I/O error occurred. </dd></dl>

  1749. 

  1750. </div>

  1751. </div>

  1752. <a id="a8d21f9df86e846e34c3bb11cf7db21bc"></a>

  1753. <h2 class="memtitle"><span class="permalink"><a href="#a8d21f9df86e846e34c3bb11cf7db21bc">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  1754. 

  1755. <div class="memitem">

  1756. <div class="memproto">

  1757. <table class="mlabels">

  1758.   <tr>

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

  1760.       <table class="memname">

  1761.         <tr>

  1762.           <td class="memname">bool FsBaseFile::remove </td>

  1763.           <td>(</td>

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

  1765.           <td></td>

  1766.         </tr>

  1767.       </table>

  1768.   </td>

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

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

  1771.   </tr>

  1772. </table>

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

  1774. <p>Remove a file.</p>

  1775. <p>The directory entry and all data for the file are deleted.</p>

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

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

  1778. 

  1779. </div>

  1780. </div>

  1781. <a id="a64feff69c4f09e56247c7f9dc7c74f34"></a>

  1782. <h2 class="memtitle"><span class="permalink"><a href="#a64feff69c4f09e56247c7f9dc7c74f34">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  1783. 

  1784. <div class="memitem">

  1785. <div class="memproto">

  1786. <table class="mlabels">

  1787.   <tr>

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

  1789.       <table class="memname">

  1790.         <tr>

  1791.           <td class="memname">bool FsBaseFile::remove </td>

  1792.           <td>(</td>

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

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

  1795.           <td></td>

  1796.         </tr>

  1797.       </table>

  1798.   </td>

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

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

  1801.   </tr>

  1802. </table>

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

  1804. <p>Remove a file.</p>

  1805. <p>The directory entry and all data for the file are deleted.</p>

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

  1807.   <table class="params">

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

  1809.   </table>

  1810.   </dd>

  1811. </dl>

  1812. <p>Example use: dirFile.remove(filenameToRemove);</p>

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

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

  1815. 

  1816. </div>

  1817. </div>

  1818. <a id="af532d87177e86995a053503eb9152115"></a>

  1819. <h2 class="memtitle"><span class="permalink"><a href="#af532d87177e86995a053503eb9152115">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  1820. 

  1821. <div class="memitem">

  1822. <div class="memproto">

  1823. <table class="mlabels">

  1824.   <tr>

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

  1826.       <table class="memname">

  1827.         <tr>

  1828.           <td class="memname">bool FsBaseFile::rename </td>

  1829.           <td>(</td>

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

  1831.           <td class="paramname"><em>newPath</em></td><td>)</td>

  1832.           <td></td>

  1833.         </tr>

  1834.       </table>

  1835.   </td>

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

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

  1838.   </tr>

  1839. </table>

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

  1841. <p>Rename a file or subdirectory.</p>

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

  1843.   <table class="params">

  1844.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  1845.   </table>

  1846.   </dd>

  1847. </dl>

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

  1849. 

  1850. </div>

  1851. </div>

  1852. <a id="a4e4347f6e89bf0b487824dbdc5b82068"></a>

  1853. <h2 class="memtitle"><span class="permalink"><a href="#a4e4347f6e89bf0b487824dbdc5b82068">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  1854. 

  1855. <div class="memitem">

  1856. <div class="memproto">

  1857. <table class="mlabels">

  1858.   <tr>

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

  1860.       <table class="memname">

  1861.         <tr>

  1862.           <td class="memname">bool FsBaseFile::rename </td>

  1863.           <td>(</td>

  1864.           <td class="paramtype"><a class="el" href="class_fs_base_file.html">FsBaseFile</a> *&#160;</td>

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

  1866.         </tr>

  1867.         <tr>

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

  1869.           <td></td>

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

  1871.           <td class="paramname"><em>newPath</em>&#160;</td>

  1872.         </tr>

  1873.         <tr>

  1874.           <td></td>

  1875.           <td>)</td>

  1876.           <td></td><td></td>

  1877.         </tr>

  1878.       </table>

  1879.   </td>

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

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

  1882.   </tr>

  1883. </table>

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

  1885. <p>Rename a file or subdirectory.</p>

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

  1887.   <table class="params">

  1888.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  1889.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  1890.   </table>

  1891.   </dd>

  1892. </dl>

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

  1894. 

  1895. </div>

  1896. </div>

  1897. <a id="a22f8ef845d610493ebe314e19ddda561"></a>

  1898. <h2 class="memtitle"><span class="permalink"><a href="#a22f8ef845d610493ebe314e19ddda561">&#9670;&nbsp;</a></span>rewind()</h2>

  1899. 

  1900. <div class="memitem">

  1901. <div class="memproto">

  1902. <table class="mlabels">

  1903.   <tr>

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

  1905.       <table class="memname">

  1906.         <tr>

  1907.           <td class="memname">void FsBaseFile::rewind </td>

  1908.           <td>(</td>

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

  1910.           <td></td>

  1911.         </tr>

  1912.       </table>

  1913.   </td>

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

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

  1916.   </tr>

  1917. </table>

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

  1919. <p>Set the file's current position to zero. </p>

  1920. 

  1921. </div>

  1922. </div>

  1923. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  1924. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  1925. 

  1926. <div class="memitem">

  1927. <div class="memproto">

  1928. <table class="mlabels">

  1929.   <tr>

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

  1931.       <table class="memname">

  1932.         <tr>

  1933.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::rewindDirectory </td>

  1934.           <td>(</td>

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

  1936.           <td></td>

  1937.         </tr>

  1938.       </table>

  1939.   </td>

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

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

  1942.   </tr>

  1943. </table>

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

  1945. <p>Rewind a file if it is a directory </p>

  1946. 

  1947. </div>

  1948. </div>

  1949. <a id="ac47870fd89b0849cda33f2780918a286"></a>

  1950. <h2 class="memtitle"><span class="permalink"><a href="#ac47870fd89b0849cda33f2780918a286">&#9670;&nbsp;</a></span>rmdir()</h2>

  1951. 

  1952. <div class="memitem">

  1953. <div class="memproto">

  1954. <table class="mlabels">

  1955.   <tr>

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

  1957.       <table class="memname">

  1958.         <tr>

  1959.           <td class="memname">bool FsBaseFile::rmdir </td>

  1960.           <td>(</td>

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

  1962.           <td></td>

  1963.         </tr>

  1964.       </table>

  1965.   </td>

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

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

  1968.   </tr>

  1969. </table>

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

  1971. <p>Remove a directory file.</p>

  1972. <p>The directory file will be removed only if it is empty and is not the root directory. <a class="el" href="class_fs_base_file.html#ac47870fd89b0849cda33f2780918a286">rmdir()</a> follows DOS and Windows and ignores the read-only attribute for the directory.</p>

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

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

  1975. 

  1976. </div>

  1977. </div>

  1978. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  1979. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  1980. 

  1981. <div class="memitem">

  1982. <div class="memproto">

  1983. <table class="mlabels">

  1984.   <tr>

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

  1986.       <table class="memname">

  1987.         <tr>

  1988.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::seek </td>

  1989.           <td>(</td>

  1990.           <td class="paramtype">uint64_t&#160;</td>

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

  1992.           <td></td>

  1993.         </tr>

  1994.       </table>

  1995.   </td>

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

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

  1998.   </tr>

  1999. </table>

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

  2001. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

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

  2003.   <table class="params">

  2004.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2005.   </table>

  2006.   </dd>

  2007. </dl>

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

  2009. 

  2010. </div>

  2011. </div>

  2012. <a id="a5fa242a4598eab5caa6efd4bdf62f5c0"></a>

  2013. <h2 class="memtitle"><span class="permalink"><a href="#a5fa242a4598eab5caa6efd4bdf62f5c0">&#9670;&nbsp;</a></span>seekCur()</h2>

  2014. 

  2015. <div class="memitem">

  2016. <div class="memproto">

  2017. <table class="mlabels">

  2018.   <tr>

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

  2020.       <table class="memname">

  2021.         <tr>

  2022.           <td class="memname">bool FsBaseFile::seekCur </td>

  2023.           <td>(</td>

  2024.           <td class="paramtype">int64_t&#160;</td>

  2025.           <td class="paramname"><em>offset</em></td><td>)</td>

  2026.           <td></td>

  2027.         </tr>

  2028.       </table>

  2029.   </td>

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

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

  2032.   </tr>

  2033. </table>

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

  2035. <p>Set the files position to current position + <em>pos</em>. See <a class="el" href="class_fs_base_file.html#a460f7598c903b8a4b4fe868dacccb6dd">seekSet()</a>. </p><dl class="params"><dt>Parameters</dt><dd>

  2036.   <table class="params">

  2037.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2038.   </table>

  2039.   </dd>

  2040. </dl>

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

  2042. 

  2043. </div>

  2044. </div>

  2045. <a id="ade9f9a9ac4d3e0a392a6cc45c9551767"></a>

  2046. <h2 class="memtitle"><span class="permalink"><a href="#ade9f9a9ac4d3e0a392a6cc45c9551767">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2047. 

  2048. <div class="memitem">

  2049. <div class="memproto">

  2050. <table class="mlabels">

  2051.   <tr>

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

  2053.       <table class="memname">

  2054.         <tr>

  2055.           <td class="memname">bool FsBaseFile::seekEnd </td>

  2056.           <td>(</td>

  2057.           <td class="paramtype">int64_t&#160;</td>

  2058.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2059.           <td></td>

  2060.         </tr>

  2061.       </table>

  2062.   </td>

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

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

  2065.   </tr>

  2066. </table>

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

  2068. <p>Set the files position to end-of-file + <em>offset</em>. See <a class="el" href="class_fs_base_file.html#a460f7598c903b8a4b4fe868dacccb6dd">seekSet()</a>. Can't be used for directory files since file size is not defined. </p><dl class="params"><dt>Parameters</dt><dd>

  2069.   <table class="params">

  2070.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2071.   </table>

  2072.   </dd>

  2073. </dl>

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

  2075. 

  2076. </div>

  2077. </div>

  2078. <a id="a460f7598c903b8a4b4fe868dacccb6dd"></a>

  2079. <h2 class="memtitle"><span class="permalink"><a href="#a460f7598c903b8a4b4fe868dacccb6dd">&#9670;&nbsp;</a></span>seekSet()</h2>

  2080. 

  2081. <div class="memitem">

  2082. <div class="memproto">

  2083. <table class="mlabels">

  2084.   <tr>

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

  2086.       <table class="memname">

  2087.         <tr>

  2088.           <td class="memname">bool FsBaseFile::seekSet </td>

  2089.           <td>(</td>

  2090.           <td class="paramtype">uint64_t&#160;</td>

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

  2092.           <td></td>

  2093.         </tr>

  2094.       </table>

  2095.   </td>

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

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

  2098.   </tr>

  2099. </table>

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

  2101. <p>Sets a file's position.</p>

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

  2103.   <table class="params">

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

  2105.   </table>

  2106.   </dd>

  2107. </dl>

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

  2109. 

  2110. </div>

  2111. </div>

  2112. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  2113. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  2114. 

  2115. <div class="memitem">

  2116. <div class="memproto">

  2117. <table class="mlabels">

  2118.   <tr>

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

  2120.       <table class="memname">

  2121.         <tr>

  2122.           <td class="memname">uint64_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::size </td>

  2123.           <td>(</td>

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

  2125.           <td></td>

  2126.         </tr>

  2127.       </table>

  2128.   </td>

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

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

  2131.   </tr>

  2132. </table>

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

  2134. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  2135. 

  2136. </div>

  2137. </div>

  2138. <a id="acf2d9261c5c1b1b022a0414cdfe0a17b"></a>

  2139. <h2 class="memtitle"><span class="permalink"><a href="#acf2d9261c5c1b1b022a0414cdfe0a17b">&#9670;&nbsp;</a></span>sync()</h2>

  2140. 

  2141. <div class="memitem">

  2142. <div class="memproto">

  2143. <table class="mlabels">

  2144.   <tr>

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

  2146.       <table class="memname">

  2147.         <tr>

  2148.           <td class="memname">bool FsBaseFile::sync </td>

  2149.           <td>(</td>

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

  2151.           <td></td>

  2152.         </tr>

  2153.       </table>

  2154.   </td>

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

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

  2157.   </tr>

  2158. </table>

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

  2160. <p>The <a class="el" href="class_fs_base_file.html#acf2d9261c5c1b1b022a0414cdfe0a17b">sync()</a> call causes all modified data and directory fields to be written to the storage device.</p>

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

  2162. 

  2163. </div>

  2164. </div>

  2165. <a id="acea65e639feebaac01964af02a77d324"></a>

  2166. <h2 class="memtitle"><span class="permalink"><a href="#acea65e639feebaac01964af02a77d324">&#9670;&nbsp;</a></span>timestamp()</h2>

  2167. 

  2168. <div class="memitem">

  2169. <div class="memproto">

  2170. <table class="mlabels">

  2171.   <tr>

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

  2173.       <table class="memname">

  2174.         <tr>

  2175.           <td class="memname">bool FsBaseFile::timestamp </td>

  2176.           <td>(</td>

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

  2178.           <td class="paramname"><em>flags</em>, </td>

  2179.         </tr>

  2180.         <tr>

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

  2182.           <td></td>

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

  2184.           <td class="paramname"><em>year</em>, </td>

  2185.         </tr>

  2186.         <tr>

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

  2188.           <td></td>

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

  2190.           <td class="paramname"><em>month</em>, </td>

  2191.         </tr>

  2192.         <tr>

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

  2194.           <td></td>

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

  2196.           <td class="paramname"><em>day</em>, </td>

  2197.         </tr>

  2198.         <tr>

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

  2200.           <td></td>

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

  2202.           <td class="paramname"><em>hour</em>, </td>

  2203.         </tr>

  2204.         <tr>

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

  2206.           <td></td>

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

  2208.           <td class="paramname"><em>minute</em>, </td>

  2209.         </tr>

  2210.         <tr>

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

  2212.           <td></td>

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

  2214.           <td class="paramname"><em>second</em>&#160;</td>

  2215.         </tr>

  2216.         <tr>

  2217.           <td></td>

  2218.           <td>)</td>

  2219.           <td></td><td></td>

  2220.         </tr>

  2221.       </table>

  2222.   </td>

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

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

  2225.   </tr>

  2226. </table>

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

  2228. <p>Set a file's timestamps in its directory entry.</p>

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

  2230.   <table class="params">

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

  2232.   </table>

  2233.   </dd>

  2234. </dl>

  2235. <p>T_ACCESS - Set the file's last access date.</p>

  2236. <p>T_CREATE - Set the file's creation date and time.</p>

  2237. <p>T_WRITE - Set the file's last write/modification date and time.</p>

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

  2239.   <table class="params">

  2240.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2241.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2242.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2243.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2244.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2245.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2246.   </table>

  2247.   </dd>

  2248. </dl>

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

  2250. <dd>

  2251. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

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

  2253. 

  2254. </div>

  2255. </div>

  2256. <a id="a2a0bf00241df08a604f054512746986b"></a>

  2257. <h2 class="memtitle"><span class="permalink"><a href="#a2a0bf00241df08a604f054512746986b">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2258. 

  2259. <div class="memitem">

  2260. <div class="memproto">

  2261. <table class="mlabels">

  2262.   <tr>

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

  2264.       <table class="memname">

  2265.         <tr>

  2266.           <td class="memname">bool FsBaseFile::truncate </td>

  2267.           <td>(</td>

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

  2269.           <td></td>

  2270.         </tr>

  2271.       </table>

  2272.   </td>

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

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

  2275.   </tr>

  2276. </table>

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

  2278. <p>Truncate a file to the current position.</p>

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

  2280. 

  2281. </div>

  2282. </div>

  2283. <a id="a47247cc54157ef79e0752f55ba01cf7e"></a>

  2284. <h2 class="memtitle"><span class="permalink"><a href="#a47247cc54157ef79e0752f55ba01cf7e">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2285. 

  2286. <div class="memitem">

  2287. <div class="memproto">

  2288. <table class="mlabels">

  2289.   <tr>

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

  2291.       <table class="memname">

  2292.         <tr>

  2293.           <td class="memname">bool FsBaseFile::truncate </td>

  2294.           <td>(</td>

  2295.           <td class="paramtype">uint64_t&#160;</td>

  2296.           <td class="paramname"><em>length</em></td><td>)</td>

  2297.           <td></td>

  2298.         </tr>

  2299.       </table>

  2300.   </td>

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

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

  2303.   </tr>

  2304. </table>

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

  2306. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

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

  2308.   <table class="params">

  2309.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2310.   </table>

  2311.   </dd>

  2312. </dl>

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

  2314. 

  2315. </div>

  2316. </div>

  2317. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  2318. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2319. 

  2320. <div class="memitem">

  2321. <div class="memproto">

  2322. <table class="mlabels">

  2323.   <tr>

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

  2325.       <table class="memname">

  2326.         <tr>

  2327.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::write </td>

  2328.           <td>(</td>

  2329.           <td class="paramtype">const uint8_t *&#160;</td>

  2330.           <td class="paramname"><em>buffer</em>, </td>

  2331.         </tr>

  2332.         <tr>

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

  2334.           <td></td>

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

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

  2337.         </tr>

  2338.         <tr>

  2339.           <td></td>

  2340.           <td>)</td>

  2341.           <td></td><td></td>

  2342.         </tr>

  2343.       </table>

  2344.   </td>

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

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

  2347.   </tr>

  2348. </table>

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

  2350. <p>Write data to an open file.</p>

  2351. <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_fs_base_file.html#acf2d9261c5c1b1b022a0414cdfe0a17b">sync()</a> is called.</dd></dl>

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

  2353.   <table class="params">

  2354.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  2355.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  2356.   </table>

  2357.   </dd>

  2358. </dl>

  2359. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns the number of bytes written, always <em>size</em>. </dd></dl>

  2360. 

  2361. </div>

  2362. </div>

  2363. <a id="aa763e83fea4889828effc3308f13113a"></a>

  2364. <h2 class="memtitle"><span class="permalink"><a href="#aa763e83fea4889828effc3308f13113a">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2365. 

  2366. <div class="memitem">

  2367. <div class="memproto">

  2368. <table class="mlabels">

  2369.   <tr>

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

  2371.       <table class="memname">

  2372.         <tr>

  2373.           <td class="memname">size_t FsBaseFile::write </td>

  2374.           <td>(</td>

  2375.           <td class="paramtype">const void *&#160;</td>

  2376.           <td class="paramname"><em>buf</em>, </td>

  2377.         </tr>

  2378.         <tr>

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

  2380.           <td></td>

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

  2382.           <td class="paramname"><em>count</em>&#160;</td>

  2383.         </tr>

  2384.         <tr>

  2385.           <td></td>

  2386.           <td>)</td>

  2387.           <td></td><td></td>

  2388.         </tr>

  2389.       </table>

  2390.   </td>

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

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

  2393.   </tr>

  2394. </table>

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

  2396. <p>Write data to an open file.</p>

  2397. <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_fs_base_file.html#acf2d9261c5c1b1b022a0414cdfe0a17b">sync()</a> is called.</dd></dl>

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

  2399.   <table class="params">

  2400.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2401.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2402.   </table>

  2403.   </dd>

  2404. </dl>

  2405. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns -1. Possible errors include <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">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>

  2406. 

  2407. </div>

  2408. </div>

  2409. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  2410. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2411. 

  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 <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fs_base_file.html">FsBaseFile</a> , uint64_t  &gt;::write </td>

  2420.           <td>(</td>

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

  2422.           <td class="paramname"><em>b</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">inline</span><span class="mlabel">inherited</span></span>  </td>

  2429.   </tr>

  2430. </table>

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

  2432. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2433.   <table class="params">

  2434.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>the byte to be written. Use getWriteError to check for errors. </td></tr>

  2435.   </table>

  2436.   </dd>

  2437. </dl>

  2438. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  2439. 

  2440. </div>

  2441. </div>

  2442. <hr/>The documentation for this class was generated from the following file:<ul>

  2443. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/<a class="el" href="_fs_file_8h.html">FsFile.h</a></li>

  2444. </ul>

  2445. </div><!-- contents -->

  2446. <!-- start footer part -->

  2447. <hr class="footer"/><address class="footer"><small>

  2448. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2449. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2450. </a> 1.8.16

  2451. </small></address>

  2452. </body>

  2453. </html>