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.
47 Commits
1 Branch
Tree: 3205c6919d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3205c6919d'
${ noResults }
teensy-sdfat/extras/html/class_fs_file.html

2450 lines
110KB
Raw Blame History 

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

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

  3. <head>

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

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

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

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

  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" id="node2" href="class_stream_file.html" title="StreamFile\&lt; FsBaseFile,\l uint64_t \&gt;" alt="" coords="11,80,177,121"/>

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

  83. </map>

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

  85. <div class="dynheader">

  86. Collaboration diagram for FsFile:</div>

  87. <div class="dyncontent">

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

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

  90. <area shape="rect" id="node2" href="class_stream_file.html" title="StreamFile\&lt; FsBaseFile,\l uint64_t \&gt;" alt="" coords="11,80,177,121"/>

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

  92. </map>

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

  94. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  135. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

  137. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  163. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

  165. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

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

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

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

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

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

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

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

  174. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

  176. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

  178. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  222. </table>

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

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

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

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

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

  228. 

  229. <div class="memitem">

  230. <div class="memproto">

  231. <table class="mlabels">

  232.   <tr>

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

  234.       <table class="memname">

  235.         <tr>

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

  237.           <td>(</td>

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

  239.           <td></td>

  240.         </tr>

  241.       </table>

  242.   </td>

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

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

  245.   </tr>

  246. </table>

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

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

  249. 

  250. </div>

  251. </div>

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

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

  254. 

  255. <div class="memitem">

  256. <div class="memproto">

  257. <table class="mlabels">

  258.   <tr>

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

  260.       <table class="memname">

  261.         <tr>

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

  263.           <td>(</td>

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

  265.           <td></td>

  266.         </tr>

  267.       </table>

  268.   </td>

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

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

  271.   </tr>

  272. </table>

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

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

  275. 

  276. </div>

  277. </div>

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

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

  280. 

  281. <div class="memitem">

  282. <div class="memproto">

  283. <table class="mlabels">

  284.   <tr>

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

  286.       <table class="memname">

  287.         <tr>

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

  289.           <td>(</td>

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

  291.           <td></td>

  292.         </tr>

  293.       </table>

  294.   </td>

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

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

  297.   </tr>

  298. </table>

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

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

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

  302. 

  303. </div>

  304. </div>

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

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

  307. 

  308. <div class="memitem">

  309. <div class="memproto">

  310. <table class="mlabels">

  311.   <tr>

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

  313.       <table class="memname">

  314.         <tr>

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

  316.           <td>(</td>

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

  318.           <td></td>

  319.         </tr>

  320.       </table>

  321.   </td>

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

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

  324.   </tr>

  325. </table>

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

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

  328. 

  329. </div>

  330. </div>

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

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

  333. 

  334. <div class="memitem">

  335. <div class="memproto">

  336. <table class="mlabels">

  337.   <tr>

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

  339.       <table class="memname">

  340.         <tr>

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

  342.           <td>(</td>

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

  344.           <td></td>

  345.         </tr>

  346.       </table>

  347.   </td>

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

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

  350.   </tr>

  351. </table>

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

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

  354. 

  355. </div>

  356. </div>

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

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

  359. 

  360. <div class="memitem">

  361. <div class="memproto">

  362. <table class="mlabels">

  363.   <tr>

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

  365.       <table class="memname">

  366.         <tr>

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

  368.           <td>(</td>

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

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

  371.           <td></td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

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

  382.   <table class="params">

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

  384.   </table>

  385.   </dd>

  386. </dl>

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

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

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

  390. 

  391. </div>

  392. </div>

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

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

  395. 

  396. <div class="memitem">

  397. <div class="memproto">

  398. <table class="mlabels">

  399.   <tr>

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

  401.       <table class="memname">

  402.         <tr>

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

  404.           <td>(</td>

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

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

  407.           <td></td>

  408.         </tr>

  409.       </table>

  410.   </td>

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

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

  413.   </tr>

  414. </table>

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

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

  417.   <table class="params">

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

  419.   </table>

  420.   </dd>

  421. </dl>

  422. 

  423. </div>

  424. </div>

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

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

  427. 

  428. <div class="memitem">

  429. <div class="memproto">

  430. <table class="mlabels">

  431.   <tr>

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

  433.       <table class="memname">

  434.         <tr>

  435.           <td class="memname">int FsBaseFile::fgets </td>

  436.           <td>(</td>

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

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

  439.         </tr>

  440.         <tr>

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

  442.           <td></td>

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

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

  445.         </tr>

  446.         <tr>

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

  448.           <td></td>

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

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

  451.         </tr>

  452.         <tr>

  453.           <td></td>

  454.           <td>)</td>

  455.           <td></td><td></td>

  456.         </tr>

  457.       </table>

  458.   </td>

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

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

  461.   </tr>

  462. </table>

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

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

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

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

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

  468.   <table class="params">

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

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

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

  472.   </table>

  473.   </dd>

  474. </dl>

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

  476. 

  477. </div>

  478. </div>

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

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

  481. 

  482. <div class="memitem">

  483. <div class="memproto">

  484. <table class="mlabels">

  485.   <tr>

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

  487.       <table class="memname">

  488.         <tr>

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

  490.           <td>(</td>

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

  492.           <td></td>

  493.         </tr>

  494.       </table>

  495.   </td>

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

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

  498.   </tr>

  499. </table>

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

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

  502. 

  503. </div>

  504. </div>

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

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

  507. 

  508. <div class="memitem">

  509. <div class="memproto">

  510. <table class="mlabels">

  511.   <tr>

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

  513.       <table class="memname">

  514.         <tr>

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

  516.           <td>(</td>

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

  518.           <td></td>

  519.         </tr>

  520.       </table>

  521.   </td>

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

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

  524.   </tr>

  525. </table>

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

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

  528. 

  529. </div>

  530. </div>

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

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

  533. 

  534. <div class="memitem">

  535. <div class="memproto">

  536. <table class="mlabels">

  537.   <tr>

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

  539.       <table class="memname">

  540.         <tr>

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

  542.           <td>(</td>

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

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

  545.           <td></td>

  546.         </tr>

  547.       </table>

  548.   </td>

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

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

  551.   </tr>

  552. </table>

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

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

  555.   <table class="params">

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

  557.   </table>

  558.   </dd>

  559. </dl>

  560. 

  561. </div>

  562. </div>

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

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

  565. 

  566. <div class="memitem">

  567. <div class="memproto">

  568. <table class="mlabels">

  569.   <tr>

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

  571.       <table class="memname">

  572.         <tr>

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

  574.           <td>(</td>

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

  576.           <td></td>

  577.         </tr>

  578.       </table>

  579.   </td>

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

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

  582.   </tr>

  583. </table>

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

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

  586. 

  587. </div>

  588. </div>

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

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

  591. 

  592. <div class="memitem">

  593. <div class="memproto">

  594. <table class="mlabels">

  595.   <tr>

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

  597.       <table class="memname">

  598.         <tr>

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

  600.           <td>(</td>

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

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

  603.         </tr>

  604.         <tr>

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

  606.           <td></td>

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

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

  609.         </tr>

  610.         <tr>

  611.           <td></td>

  612.           <td>)</td>

  613.           <td></td><td></td>

  614.         </tr>

  615.       </table>

  616.   </td>

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

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

  619.   </tr>

  620. </table>

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

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

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

  624.   <table class="params">

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

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

  627.   </table>

  628.   </dd>

  629. </dl>

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

  631. 

  632. </div>

  633. </div>

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

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

  636. 

  637. <div class="memitem">

  638. <div class="memproto">

  639. <table class="mlabels">

  640.   <tr>

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

  642.       <table class="memname">

  643.         <tr>

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

  645.           <td>(</td>

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

  647.           <td></td>

  648.         </tr>

  649.       </table>

  650.   </td>

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

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

  653.   </tr>

  654. </table>

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

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

  657. 

  658. </div>

  659. </div>

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

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

  662. 

  663. <div class="memitem">

  664. <div class="memproto">

  665. <table class="mlabels">

  666.   <tr>

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

  668.       <table class="memname">

  669.         <tr>

  670.           <td class="memname">bool FsBaseFile::isDir </td>

  671.           <td>(</td>

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

  673.           <td></td>

  674.         </tr>

  675.       </table>

  676.   </td>

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

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

  679.   </tr>

  680. </table>

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

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

  683. 

  684. </div>

  685. </div>

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

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

  688. 

  689. <div class="memitem">

  690. <div class="memproto">

  691. <table class="mlabels">

  692.   <tr>

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

  694.       <table class="memname">

  695.         <tr>

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

  697.           <td>(</td>

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

  699.           <td></td>

  700.         </tr>

  701.       </table>

  702.   </td>

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

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

  705.   </tr>

  706. </table>

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

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

  709. 

  710. </div>

  711. </div>

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

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

  714. 

  715. <div class="memitem">

  716. <div class="memproto">

  717. <table class="mlabels">

  718.   <tr>

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

  720.       <table class="memname">

  721.         <tr>

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

  723.           <td>(</td>

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

  725.           <td></td>

  726.         </tr>

  727.       </table>

  728.   </td>

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

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

  731.   </tr>

  732. </table>

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

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

  735. 

  736. </div>

  737. </div>

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

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

  740. 

  741. <div class="memitem">

  742. <div class="memproto">

  743. <table class="mlabels">

  744.   <tr>

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

  746.       <table class="memname">

  747.         <tr>

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

  749.           <td>(</td>

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

  751.           <td></td>

  752.         </tr>

  753.       </table>

  754.   </td>

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

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

  757.   </tr>

  758. </table>

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

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

  761. 

  762. </div>

  763. </div>

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

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

  766. 

  767. <div class="memitem">

  768. <div class="memproto">

  769. <table class="mlabels">

  770.   <tr>

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

  772.       <table class="memname">

  773.         <tr>

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

  775.           <td>(</td>

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

  777.           <td></td>

  778.         </tr>

  779.       </table>

  780.   </td>

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

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

  783.   </tr>

  784. </table>

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

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

  787. 

  788. </div>

  789. </div>

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

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

  792. 

  793. <div class="memitem">

  794. <div class="memproto">

  795. <table class="mlabels">

  796.   <tr>

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

  798.       <table class="memname">

  799.         <tr>

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

  801.           <td>(</td>

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

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

  804.           <td></td>

  805.         </tr>

  806.       </table>

  807.   </td>

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

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

  810.   </tr>

  811. </table>

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

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

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

  815.   <table class="params">

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

  817.   </table>

  818.   </dd>

  819. </dl>

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

  821. 

  822. </div>

  823. </div>

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

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

  826. 

  827. <div class="memitem">

  828. <div class="memproto">

  829. <table class="mlabels">

  830.   <tr>

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

  832.       <table class="memname">

  833.         <tr>

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

  835.           <td>(</td>

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

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

  838.         </tr>

  839.         <tr>

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

  841.           <td></td>

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

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

  844.         </tr>

  845.         <tr>

  846.           <td></td>

  847.           <td>)</td>

  848.           <td></td><td></td>

  849.         </tr>

  850.       </table>

  851.   </td>

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

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

  854.   </tr>

  855. </table>

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

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

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

  859.   <table class="params">

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

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

  862.   </table>

  863.   </dd>

  864. </dl>

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

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

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

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

  869. 

  870. </div>

  871. </div>

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

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

  874. 

  875. <div class="memitem">

  876. <div class="memproto">

  877. <table class="mlabels">

  878.   <tr>

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

  880.       <table class="memname">

  881.         <tr>

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

  883.           <td>(</td>

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

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

  886.         </tr>

  887.         <tr>

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

  889.           <td></td>

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

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

  892.         </tr>

  893.         <tr>

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

  895.           <td></td>

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

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

  898.         </tr>

  899.         <tr>

  900.           <td></td>

  901.           <td>)</td>

  902.           <td></td><td></td>

  903.         </tr>

  904.       </table>

  905.   </td>

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

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

  908.   </tr>

  909. </table>

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

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

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

  913.   <table class="params">

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

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

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

  917.   </table>

  918.   </dd>

  919. </dl>

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

  921. 

  922. </div>

  923. </div>

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

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

  926. 

  927. <div class="memitem">

  928. <div class="memproto">

  929. <table class="mlabels">

  930.   <tr>

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

  932.       <table class="memname">

  933.         <tr>

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

  935.           <td>(</td>

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

  937.           <td> const</td>

  938.         </tr>

  939.       </table>

  940.   </td>

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

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

  943.   </tr>

  944. </table>

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

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

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

  948. 

  949. </div>

  950. </div>

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

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

  953. 

  954. <div class="memitem">

  955. <div class="memproto">

  956. <table class="mlabels">

  957.   <tr>

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

  959.       <table class="memname">

  960.         <tr>

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

  962.           <td>(</td>

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

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

  965.         </tr>

  966.         <tr>

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

  968.           <td></td>

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

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

  971.         </tr>

  972.         <tr>

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

  974.           <td></td>

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

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

  977.         </tr>

  978.         <tr>

  979.           <td></td>

  980.           <td>)</td>

  981.           <td></td><td></td>

  982.         </tr>

  983.       </table>

  984.   </td>

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

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

  987.   </tr>

  988. </table>

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

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

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

  992.   <table class="params">

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

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

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

  996.   </table>

  997.   </dd>

  998. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1012. 

  1013. </div>

  1014. </div>

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

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

  1017. 

  1018. <div class="memitem">

  1019. <div class="memproto">

  1020. <table class="mlabels">

  1021.   <tr>

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

  1023.       <table class="memname">

  1024.         <tr>

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

  1026.           <td>(</td>

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

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

  1029.         </tr>

  1030.         <tr>

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

  1032.           <td></td>

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

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

  1035.         </tr>

  1036.         <tr>

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

  1038.           <td></td>

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

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

  1041.         </tr>

  1042.         <tr>

  1043.           <td></td>

  1044.           <td>)</td>

  1045.           <td></td><td></td>

  1046.         </tr>

  1047.       </table>

  1048.   </td>

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

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

  1051.   </tr>

  1052. </table>

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

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

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

  1056.   <table class="params">

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

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

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

  1060.   </table>

  1061.   </dd>

  1062. </dl>

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

  1064. 

  1065. </div>

  1066. </div>

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

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

  1069. 

  1070. <div class="memitem">

  1071. <div class="memproto">

  1072. <table class="mlabels">

  1073.   <tr>

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

  1075.       <table class="memname">

  1076.         <tr>

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

  1078.           <td>(</td>

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

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

  1081.         </tr>

  1082.         <tr>

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

  1084.           <td></td>

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

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

  1087.         </tr>

  1088.         <tr>

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

  1090.           <td></td>

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

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

  1093.         </tr>

  1094.         <tr>

  1095.           <td></td>

  1096.           <td>)</td>

  1097.           <td></td><td></td>

  1098.         </tr>

  1099.       </table>

  1100.   </td>

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

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

  1103.   </tr>

  1104. </table>

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

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

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

  1108.   <table class="params">

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

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

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

  1112.   </table>

  1113.   </dd>

  1114. </dl>

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

  1116. 

  1117. </div>

  1118. </div>

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

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

  1121. 

  1122. <div class="memitem">

  1123. <div class="memproto">

  1124. <table class="mlabels">

  1125.   <tr>

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

  1127.       <table class="memname">

  1128.         <tr>

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

  1130.           <td>(</td>

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

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

  1133.         </tr>

  1134.         <tr>

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

  1136.           <td></td>

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

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

  1139.         </tr>

  1140.         <tr>

  1141.           <td></td>

  1142.           <td>)</td>

  1143.           <td></td><td></td>

  1144.         </tr>

  1145.       </table>

  1146.   </td>

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

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

  1149.   </tr>

  1150. </table>

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

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

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

  1154.   <table class="params">

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

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

  1157.   </table>

  1158.   </dd>

  1159. </dl>

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

  1161. 

  1162. </div>

  1163. </div>

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

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

  1166. 

  1167. <div class="memitem">

  1168. <div class="memproto">

  1169. <table class="mlabels">

  1170.   <tr>

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

  1172.       <table class="memname">

  1173.         <tr>

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

  1175.           <td>(</td>

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

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

  1178.         </tr>

  1179.         <tr>

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

  1181.           <td></td>

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

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

  1184.         </tr>

  1185.         <tr>

  1186.           <td></td>

  1187.           <td>)</td>

  1188.           <td></td><td></td>

  1189.         </tr>

  1190.       </table>

  1191.   </td>

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

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

  1194.   </tr>

  1195. </table>

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

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

  1198.   <table class="params">

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

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

  1201.   </table>

  1202.   </dd>

  1203. </dl>

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

  1205. 

  1206. </div>

  1207. </div>

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

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

  1210. 

  1211. <div class="memitem">

  1212. <div class="memproto">

  1213. <table class="mlabels">

  1214.   <tr>

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

  1216.       <table class="memname">

  1217.         <tr>

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

  1219.           <td>(</td>

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

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

  1222.           <td></td>

  1223.         </tr>

  1224.       </table>

  1225.   </td>

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

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

  1228.   </tr>

  1229. </table>

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

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

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

  1233.   <table class="params">

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

  1235.   </table>

  1236.   </dd>

  1237. </dl>

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

  1239. 

  1240. </div>

  1241. </div>

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

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

  1244. 

  1245. <div class="memitem">

  1246. <div class="memproto">

  1247. <table class="mlabels">

  1248.   <tr>

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

  1250.       <table class="memname">

  1251.         <tr>

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

  1253.           <td>(</td>

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

  1255.           <td></td>

  1256.         </tr>

  1257.       </table>

  1258.   </td>

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

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

  1261.   </tr>

  1262. </table>

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

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

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

  1266. 

  1267. </div>

  1268. </div>

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

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

  1271. 

  1272. <div class="memitem">

  1273. <div class="memproto">

  1274. <table class="mlabels">

  1275.   <tr>

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

  1277.       <table class="memname">

  1278.         <tr>

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

  1280.           <td>(</td>

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

  1282.           <td></td>

  1283.         </tr>

  1284.       </table>

  1285.   </td>

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

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

  1288.   </tr>

  1289. </table>

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

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

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

  1293. 

  1294. </div>

  1295. </div>

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

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

  1298. 

  1299. <div class="memitem">

  1300. <div class="memproto">

  1301. <table class="mlabels">

  1302.   <tr>

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

  1304.       <table class="memname">

  1305.         <tr>

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

  1307.           <td>(</td>

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

  1309.           <td></td>

  1310.         </tr>

  1311.       </table>

  1312.   </td>

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

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

  1315.   </tr>

  1316. </table>

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

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

  1319. 

  1320. </div>

  1321. </div>

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

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

  1324. 

  1325. <div class="memitem">

  1326. <div class="memproto">

  1327. <table class="mlabels">

  1328.   <tr>

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

  1330.       <table class="memname">

  1331.         <tr>

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

  1333.           <td>(</td>

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

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

  1336.           <td></td>

  1337.         </tr>

  1338.       </table>

  1339.   </td>

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

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

  1342.   </tr>

  1343. </table>

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

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

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

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

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

  1349.   <table class="params">

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

  1351.   </table>

  1352.   </dd>

  1353. </dl>

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

  1355. 

  1356. </div>

  1357. </div>

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

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

  1360. 

  1361. <div class="memitem">

  1362. <div class="memproto">

  1363. <table class="mlabels">

  1364.   <tr>

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

  1366.       <table class="memname">

  1367.         <tr>

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

  1369.           <td>(</td>

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

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

  1372.           <td></td>

  1373.         </tr>

  1374.       </table>

  1375.   </td>

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

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

  1378.   </tr>

  1379. </table>

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

  1381. <p>Print a file's access date and time</p>

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

  1383.   <table class="params">

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

  1385.   </table>

  1386.   </dd>

  1387. </dl>

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

  1389. 

  1390. </div>

  1391. </div>

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

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

  1394. 

  1395. <div class="memitem">

  1396. <div class="memproto">

  1397. <table class="mlabels">

  1398.   <tr>

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

  1400.       <table class="memname">

  1401.         <tr>

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

  1403.           <td>(</td>

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

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

  1406.           <td></td>

  1407.         </tr>

  1408.       </table>

  1409.   </td>

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

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

  1412.   </tr>

  1413. </table>

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

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

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

  1417.   <table class="params">

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

  1419.   </table>

  1420.   </dd>

  1421. </dl>

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

  1423. 

  1424. </div>

  1425. </div>

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

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

  1428. 

  1429. <div class="memitem">

  1430. <div class="memproto">

  1431. <table class="mlabels">

  1432.   <tr>

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

  1434.       <table class="memname">

  1435.         <tr>

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

  1437.           <td>(</td>

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

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

  1440.         </tr>

  1441.         <tr>

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

  1443.           <td></td>

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

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

  1446.         </tr>

  1447.         <tr>

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

  1449.           <td></td>

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

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

  1452.         </tr>

  1453.         <tr>

  1454.           <td></td>

  1455.           <td>)</td>

  1456.           <td></td><td></td>

  1457.         </tr>

  1458.       </table>

  1459.   </td>

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

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

  1462.   </tr>

  1463. </table>

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

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

  1466.   <table class="params">

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

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

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

  1470.   </table>

  1471.   </dd>

  1472. </dl>

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

  1474. 

  1475. </div>

  1476. </div>

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

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

  1479. 

  1480. <div class="memitem">

  1481. <div class="memproto">

  1482. <table class="mlabels">

  1483.   <tr>

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

  1485.       <table class="memname">

  1486.         <tr>

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

  1488.           <td>(</td>

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

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

  1491.         </tr>

  1492.         <tr>

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

  1494.           <td></td>

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

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

  1497.         </tr>

  1498.         <tr>

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

  1500.           <td></td>

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

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

  1503.         </tr>

  1504.         <tr>

  1505.           <td></td>

  1506.           <td>)</td>

  1507.           <td></td><td></td>

  1508.         </tr>

  1509.       </table>

  1510.   </td>

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

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

  1513.   </tr>

  1514. </table>

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

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

  1517.   <table class="params">

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

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

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

  1521.   </table>

  1522.   </dd>

  1523. </dl>

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

  1525. 

  1526. </div>

  1527. </div>

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

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

  1530. 

  1531. <div class="memitem">

  1532. <div class="memproto">

  1533. <div class="memtemplate">

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

  1535. <table class="mlabels">

  1536.   <tr>

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

  1538.       <table class="memname">

  1539.         <tr>

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

  1541.           <td>(</td>

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

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

  1544.         </tr>

  1545.         <tr>

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

  1547.           <td></td>

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

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

  1550.         </tr>

  1551.         <tr>

  1552.           <td></td>

  1553.           <td>)</td>

  1554.           <td></td><td></td>

  1555.         </tr>

  1556.       </table>

  1557.   </td>

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

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

  1560.   </tr>

  1561. </table>

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

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

  1564.   <table class="params">

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

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

  1567.   </table>

  1568.   </dd>

  1569. </dl>

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

  1571. 

  1572. </div>

  1573. </div>

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

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

  1576. 

  1577. <div class="memitem">

  1578. <div class="memproto">

  1579. <table class="mlabels">

  1580.   <tr>

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

  1582.       <table class="memname">

  1583.         <tr>

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

  1585.           <td>(</td>

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

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

  1588.           <td></td>

  1589.         </tr>

  1590.       </table>

  1591.   </td>

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

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

  1594.   </tr>

  1595. </table>

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

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

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

  1599.   <table class="params">

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

  1601.   </table>

  1602.   </dd>

  1603. </dl>

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

  1605. 

  1606. </div>

  1607. </div>

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

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

  1610. 

  1611. <div class="memitem">

  1612. <div class="memproto">

  1613. <table class="mlabels">

  1614.   <tr>

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

  1616.       <table class="memname">

  1617.         <tr>

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

  1619.           <td>(</td>

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

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

  1622.           <td></td>

  1623.         </tr>

  1624.       </table>

  1625.   </td>

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

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

  1628.   </tr>

  1629. </table>

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

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

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

  1633.   <table class="params">

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

  1635.   </table>

  1636.   </dd>

  1637. </dl>

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

  1639. 

  1640. </div>

  1641. </div>

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

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

  1644. 

  1645. <div class="memitem">

  1646. <div class="memproto">

  1647. <table class="mlabels">

  1648.   <tr>

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

  1650.       <table class="memname">

  1651.         <tr>

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

  1653.           <td>(</td>

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

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

  1656.           <td></td>

  1657.         </tr>

  1658.       </table>

  1659.   </td>

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

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

  1662.   </tr>

  1663. </table>

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

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

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

  1667.   <table class="params">

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

  1669.   </table>

  1670.   </dd>

  1671. </dl>

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

  1673. 

  1674. </div>

  1675. </div>

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

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

  1678. 

  1679. <div class="memitem">

  1680. <div class="memproto">

  1681. <table class="mlabels">

  1682.   <tr>

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

  1684.       <table class="memname">

  1685.         <tr>

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

  1687.           <td>(</td>

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

  1689.           <td></td>

  1690.         </tr>

  1691.       </table>

  1692.   </td>

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

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

  1695.   </tr>

  1696. </table>

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

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

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

  1700. 

  1701. </div>

  1702. </div>

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

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

  1705. 

  1706. <div class="memitem">

  1707. <div class="memproto">

  1708. <table class="mlabels">

  1709.   <tr>

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

  1711.       <table class="memname">

  1712.         <tr>

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

  1714.           <td>(</td>

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

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

  1717.         </tr>

  1718.         <tr>

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

  1720.           <td></td>

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

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

  1723.         </tr>

  1724.         <tr>

  1725.           <td></td>

  1726.           <td>)</td>

  1727.           <td></td><td></td>

  1728.         </tr>

  1729.       </table>

  1730.   </td>

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

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

  1733.   </tr>

  1734. </table>

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

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

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

  1738.   <table class="params">

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

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

  1741.   </table>

  1742.   </dd>

  1743. </dl>

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

  1745. 

  1746. </div>

  1747. </div>

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

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

  1750. 

  1751. <div class="memitem">

  1752. <div class="memproto">

  1753. <table class="mlabels">

  1754.   <tr>

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

  1756.       <table class="memname">

  1757.         <tr>

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

  1759.           <td>(</td>

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

  1761.           <td></td>

  1762.         </tr>

  1763.       </table>

  1764.   </td>

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

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

  1767.   </tr>

  1768. </table>

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

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

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

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

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

  1774. 

  1775. </div>

  1776. </div>

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

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

  1779. 

  1780. <div class="memitem">

  1781. <div class="memproto">

  1782. <table class="mlabels">

  1783.   <tr>

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

  1785.       <table class="memname">

  1786.         <tr>

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

  1788.           <td>(</td>

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

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

  1791.           <td></td>

  1792.         </tr>

  1793.       </table>

  1794.   </td>

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

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

  1797.   </tr>

  1798. </table>

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

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

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

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

  1803.   <table class="params">

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

  1805.   </table>

  1806.   </dd>

  1807. </dl>

  1808. <p>Example use: dirFile.remove(filenameToRemove);</p>

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

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

  1811. 

  1812. </div>

  1813. </div>

  1814. <a id="af532d87177e86995a053503eb9152115"></a>

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

  1816. 

  1817. <div class="memitem">

  1818. <div class="memproto">

  1819. <table class="mlabels">

  1820.   <tr>

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

  1822.       <table class="memname">

  1823.         <tr>

  1824.           <td class="memname">bool FsBaseFile::rename </td>

  1825.           <td>(</td>

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

  1827.           <td class="paramname"><em>newPath</em></td><td>)</td>

  1828.           <td></td>

  1829.         </tr>

  1830.       </table>

  1831.   </td>

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

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

  1834.   </tr>

  1835. </table>

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

  1837. <p>Rename a file or subdirectory.</p>

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

  1839.   <table class="params">

  1840.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  1841.   </table>

  1842.   </dd>

  1843. </dl>

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

  1845. 

  1846. </div>

  1847. </div>

  1848. <a id="a4e4347f6e89bf0b487824dbdc5b82068"></a>

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

  1850. 

  1851. <div class="memitem">

  1852. <div class="memproto">

  1853. <table class="mlabels">

  1854.   <tr>

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

  1856.       <table class="memname">

  1857.         <tr>

  1858.           <td class="memname">bool FsBaseFile::rename </td>

  1859.           <td>(</td>

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

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

  1862.         </tr>

  1863.         <tr>

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

  1865.           <td></td>

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

  1867.           <td class="paramname"><em>newPath</em>&#160;</td>

  1868.         </tr>

  1869.         <tr>

  1870.           <td></td>

  1871.           <td>)</td>

  1872.           <td></td><td></td>

  1873.         </tr>

  1874.       </table>

  1875.   </td>

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

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

  1878.   </tr>

  1879. </table>

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

  1881. <p>Rename a file or subdirectory.</p>

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

  1883.   <table class="params">

  1884.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  1885.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  1886.   </table>

  1887.   </dd>

  1888. </dl>

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

  1890. 

  1891. </div>

  1892. </div>

  1893. <a id="a22f8ef845d610493ebe314e19ddda561"></a>

  1894. <h2 class="memtitle"><span class="permalink"><a href="#a22f8ef845d610493ebe314e19ddda561">&#9670;&nbsp;</a></span>rewind()</h2>

  1895. 

  1896. <div class="memitem">

  1897. <div class="memproto">

  1898. <table class="mlabels">

  1899.   <tr>

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

  1901.       <table class="memname">

  1902.         <tr>

  1903.           <td class="memname">void FsBaseFile::rewind </td>

  1904.           <td>(</td>

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

  1906.           <td></td>

  1907.         </tr>

  1908.       </table>

  1909.   </td>

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

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

  1912.   </tr>

  1913. </table>

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

  1915. <p>Set the file's current position to zero. </p>

  1916. 

  1917. </div>

  1918. </div>

  1919. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  1920. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  1921. 

  1922. <div class="memitem">

  1923. <div class="memproto">

  1924. <table class="mlabels">

  1925.   <tr>

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

  1927.       <table class="memname">

  1928.         <tr>

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

  1930.           <td>(</td>

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

  1932.           <td></td>

  1933.         </tr>

  1934.       </table>

  1935.   </td>

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

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

  1938.   </tr>

  1939. </table>

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

  1941. <p>Rewind a file if it is a directory </p>

  1942. 

  1943. </div>

  1944. </div>

  1945. <a id="ac47870fd89b0849cda33f2780918a286"></a>

  1946. <h2 class="memtitle"><span class="permalink"><a href="#ac47870fd89b0849cda33f2780918a286">&#9670;&nbsp;</a></span>rmdir()</h2>

  1947. 

  1948. <div class="memitem">

  1949. <div class="memproto">

  1950. <table class="mlabels">

  1951.   <tr>

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

  1953.       <table class="memname">

  1954.         <tr>

  1955.           <td class="memname">bool FsBaseFile::rmdir </td>

  1956.           <td>(</td>

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

  1958.           <td></td>

  1959.         </tr>

  1960.       </table>

  1961.   </td>

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

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

  1964.   </tr>

  1965. </table>

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

  1967. <p>Remove a directory file.</p>

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

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

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

  1971. 

  1972. </div>

  1973. </div>

  1974. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  1975. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  1976. 

  1977. <div class="memitem">

  1978. <div class="memproto">

  1979. <table class="mlabels">

  1980.   <tr>

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

  1982.       <table class="memname">

  1983.         <tr>

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

  1985.           <td>(</td>

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

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

  1988.           <td></td>

  1989.         </tr>

  1990.       </table>

  1991.   </td>

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

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

  1994.   </tr>

  1995. </table>

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

  1997. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

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

  1999.   <table class="params">

  2000.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2001.   </table>

  2002.   </dd>

  2003. </dl>

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

  2005. 

  2006. </div>

  2007. </div>

  2008. <a id="a5fa242a4598eab5caa6efd4bdf62f5c0"></a>

  2009. <h2 class="memtitle"><span class="permalink"><a href="#a5fa242a4598eab5caa6efd4bdf62f5c0">&#9670;&nbsp;</a></span>seekCur()</h2>

  2010. 

  2011. <div class="memitem">

  2012. <div class="memproto">

  2013. <table class="mlabels">

  2014.   <tr>

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

  2016.       <table class="memname">

  2017.         <tr>

  2018.           <td class="memname">bool FsBaseFile::seekCur </td>

  2019.           <td>(</td>

  2020.           <td class="paramtype">int64_t&#160;</td>

  2021.           <td class="paramname"><em>offset</em></td><td>)</td>

  2022.           <td></td>

  2023.         </tr>

  2024.       </table>

  2025.   </td>

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

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

  2028.   </tr>

  2029. </table>

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

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

  2032.   <table class="params">

  2033.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2034.   </table>

  2035.   </dd>

  2036. </dl>

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

  2038. 

  2039. </div>

  2040. </div>

  2041. <a id="ade9f9a9ac4d3e0a392a6cc45c9551767"></a>

  2042. <h2 class="memtitle"><span class="permalink"><a href="#ade9f9a9ac4d3e0a392a6cc45c9551767">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2043. 

  2044. <div class="memitem">

  2045. <div class="memproto">

  2046. <table class="mlabels">

  2047.   <tr>

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

  2049.       <table class="memname">

  2050.         <tr>

  2051.           <td class="memname">bool FsBaseFile::seekEnd </td>

  2052.           <td>(</td>

  2053.           <td class="paramtype">int64_t&#160;</td>

  2054.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2055.           <td></td>

  2056.         </tr>

  2057.       </table>

  2058.   </td>

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

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

  2061.   </tr>

  2062. </table>

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

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

  2065.   <table class="params">

  2066.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2067.   </table>

  2068.   </dd>

  2069. </dl>

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

  2071. 

  2072. </div>

  2073. </div>

  2074. <a id="a460f7598c903b8a4b4fe868dacccb6dd"></a>

  2075. <h2 class="memtitle"><span class="permalink"><a href="#a460f7598c903b8a4b4fe868dacccb6dd">&#9670;&nbsp;</a></span>seekSet()</h2>

  2076. 

  2077. <div class="memitem">

  2078. <div class="memproto">

  2079. <table class="mlabels">

  2080.   <tr>

  2081.   <td class="mlabels-left">

  2082.       <table class="memname">

  2083.         <tr>

  2084.           <td class="memname">bool FsBaseFile::seekSet </td>

  2085.           <td>(</td>

  2086.           <td class="paramtype">uint64_t&#160;</td>

  2087.           <td class="paramname"><em>pos</em></td><td>)</td>

  2088.           <td></td>

  2089.         </tr>

  2090.       </table>

  2091.   </td>

  2092.   <td class="mlabels-right">

  2093. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2094.   </tr>

  2095. </table>

  2096. </div><div class="memdoc">

  2097. <p>Sets a file's position.</p>

  2098. <dl class="params"><dt>Parameters</dt><dd>

  2099.   <table class="params">

  2100.     <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>

  2101.   </table>

  2102.   </dd>

  2103. </dl>

  2104. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2105. 

  2106. </div>

  2107. </div>

  2108. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  2109. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  2110. 

  2111. <div class="memitem">

  2112. <div class="memproto">

  2113. <table class="mlabels">

  2114.   <tr>

  2115.   <td class="mlabels-left">

  2116.       <table class="memname">

  2117.         <tr>

  2118.           <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>

  2119.           <td>(</td>

  2120.           <td class="paramname"></td><td>)</td>

  2121.           <td></td>

  2122.         </tr>

  2123.       </table>

  2124.   </td>

  2125.   <td class="mlabels-right">

  2126. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2127.   </tr>

  2128. </table>

  2129. </div><div class="memdoc">

  2130. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  2131. 

  2132. </div>

  2133. </div>

  2134. <a id="acf2d9261c5c1b1b022a0414cdfe0a17b"></a>

  2135. <h2 class="memtitle"><span class="permalink"><a href="#acf2d9261c5c1b1b022a0414cdfe0a17b">&#9670;&nbsp;</a></span>sync()</h2>

  2136. 

  2137. <div class="memitem">

  2138. <div class="memproto">

  2139. <table class="mlabels">

  2140.   <tr>

  2141.   <td class="mlabels-left">

  2142.       <table class="memname">

  2143.         <tr>

  2144.           <td class="memname">bool FsBaseFile::sync </td>

  2145.           <td>(</td>

  2146.           <td class="paramname"></td><td>)</td>

  2147.           <td></td>

  2148.         </tr>

  2149.       </table>

  2150.   </td>

  2151.   <td class="mlabels-right">

  2152. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2153.   </tr>

  2154. </table>

  2155. </div><div class="memdoc">

  2156. <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>

  2157. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2158. 

  2159. </div>

  2160. </div>

  2161. <a id="acea65e639feebaac01964af02a77d324"></a>

  2162. <h2 class="memtitle"><span class="permalink"><a href="#acea65e639feebaac01964af02a77d324">&#9670;&nbsp;</a></span>timestamp()</h2>

  2163. 

  2164. <div class="memitem">

  2165. <div class="memproto">

  2166. <table class="mlabels">

  2167.   <tr>

  2168.   <td class="mlabels-left">

  2169.       <table class="memname">

  2170.         <tr>

  2171.           <td class="memname">bool FsBaseFile::timestamp </td>

  2172.           <td>(</td>

  2173.           <td class="paramtype">uint8_t&#160;</td>

  2174.           <td class="paramname"><em>flags</em>, </td>

  2175.         </tr>

  2176.         <tr>

  2177.           <td class="paramkey"></td>

  2178.           <td></td>

  2179.           <td class="paramtype">uint16_t&#160;</td>

  2180.           <td class="paramname"><em>year</em>, </td>

  2181.         </tr>

  2182.         <tr>

  2183.           <td class="paramkey"></td>

  2184.           <td></td>

  2185.           <td class="paramtype">uint8_t&#160;</td>

  2186.           <td class="paramname"><em>month</em>, </td>

  2187.         </tr>

  2188.         <tr>

  2189.           <td class="paramkey"></td>

  2190.           <td></td>

  2191.           <td class="paramtype">uint8_t&#160;</td>

  2192.           <td class="paramname"><em>day</em>, </td>

  2193.         </tr>

  2194.         <tr>

  2195.           <td class="paramkey"></td>

  2196.           <td></td>

  2197.           <td class="paramtype">uint8_t&#160;</td>

  2198.           <td class="paramname"><em>hour</em>, </td>

  2199.         </tr>

  2200.         <tr>

  2201.           <td class="paramkey"></td>

  2202.           <td></td>

  2203.           <td class="paramtype">uint8_t&#160;</td>

  2204.           <td class="paramname"><em>minute</em>, </td>

  2205.         </tr>

  2206.         <tr>

  2207.           <td class="paramkey"></td>

  2208.           <td></td>

  2209.           <td class="paramtype">uint8_t&#160;</td>

  2210.           <td class="paramname"><em>second</em>&#160;</td>

  2211.         </tr>

  2212.         <tr>

  2213.           <td></td>

  2214.           <td>)</td>

  2215.           <td></td><td></td>

  2216.         </tr>

  2217.       </table>

  2218.   </td>

  2219.   <td class="mlabels-right">

  2220. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2221.   </tr>

  2222. </table>

  2223. </div><div class="memdoc">

  2224. <p>Set a file's timestamps in its directory entry.</p>

  2225. <dl class="params"><dt>Parameters</dt><dd>

  2226.   <table class="params">

  2227.     <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>

  2228.   </table>

  2229.   </dd>

  2230. </dl>

  2231. <p>T_ACCESS - Set the file's last access date.</p>

  2232. <p>T_CREATE - Set the file's creation date and time.</p>

  2233. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2234. <dl class="params"><dt>Parameters</dt><dd>

  2235.   <table class="params">

  2236.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2237.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2238.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2239.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2240.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2241.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2242.   </table>

  2243.   </dd>

  2244. </dl>

  2245. <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>

  2246. <dd>

  2247. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2248. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2249. 

  2250. </div>

  2251. </div>

  2252. <a id="a2a0bf00241df08a604f054512746986b"></a>

  2253. <h2 class="memtitle"><span class="permalink"><a href="#a2a0bf00241df08a604f054512746986b">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2254. 

  2255. <div class="memitem">

  2256. <div class="memproto">

  2257. <table class="mlabels">

  2258.   <tr>

  2259.   <td class="mlabels-left">

  2260.       <table class="memname">

  2261.         <tr>

  2262.           <td class="memname">bool FsBaseFile::truncate </td>

  2263.           <td>(</td>

  2264.           <td class="paramname"></td><td>)</td>

  2265.           <td></td>

  2266.         </tr>

  2267.       </table>

  2268.   </td>

  2269.   <td class="mlabels-right">

  2270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2271.   </tr>

  2272. </table>

  2273. </div><div class="memdoc">

  2274. <p>Truncate a file to the current position.</p>

  2275. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2276. 

  2277. </div>

  2278. </div>

  2279. <a id="a47247cc54157ef79e0752f55ba01cf7e"></a>

  2280. <h2 class="memtitle"><span class="permalink"><a href="#a47247cc54157ef79e0752f55ba01cf7e">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2281. 

  2282. <div class="memitem">

  2283. <div class="memproto">

  2284. <table class="mlabels">

  2285.   <tr>

  2286.   <td class="mlabels-left">

  2287.       <table class="memname">

  2288.         <tr>

  2289.           <td class="memname">bool FsBaseFile::truncate </td>

  2290.           <td>(</td>

  2291.           <td class="paramtype">uint64_t&#160;</td>

  2292.           <td class="paramname"><em>length</em></td><td>)</td>

  2293.           <td></td>

  2294.         </tr>

  2295.       </table>

  2296.   </td>

  2297.   <td class="mlabels-right">

  2298. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2299.   </tr>

  2300. </table>

  2301. </div><div class="memdoc">

  2302. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2303. <dl class="params"><dt>Parameters</dt><dd>

  2304.   <table class="params">

  2305.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2306.   </table>

  2307.   </dd>

  2308. </dl>

  2309. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2310. 

  2311. </div>

  2312. </div>

  2313. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  2314. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2315. 

  2316. <div class="memitem">

  2317. <div class="memproto">

  2318. <table class="mlabels">

  2319.   <tr>

  2320.   <td class="mlabels-left">

  2321.       <table class="memname">

  2322.         <tr>

  2323.           <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>

  2324.           <td>(</td>

  2325.           <td class="paramtype">uint8_t&#160;</td>

  2326.           <td class="paramname"><em>b</em></td><td>)</td>

  2327.           <td></td>

  2328.         </tr>

  2329.       </table>

  2330.   </td>

  2331.   <td class="mlabels-right">

  2332. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2333.   </tr>

  2334. </table>

  2335. </div><div class="memdoc">

  2336. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2337.   <table class="params">

  2338.     <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>

  2339.   </table>

  2340.   </dd>

  2341. </dl>

  2342. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  2343. 

  2344. </div>

  2345. </div>

  2346. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  2347. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2348. 

  2349. <div class="memitem">

  2350. <div class="memproto">

  2351. <table class="mlabels">

  2352.   <tr>

  2353.   <td class="mlabels-left">

  2354.       <table class="memname">

  2355.         <tr>

  2356.           <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>

  2357.           <td>(</td>

  2358.           <td class="paramtype">const uint8_t *&#160;</td>

  2359.           <td class="paramname"><em>buffer</em>, </td>

  2360.         </tr>

  2361.         <tr>

  2362.           <td class="paramkey"></td>

  2363.           <td></td>

  2364.           <td class="paramtype">size_t&#160;</td>

  2365.           <td class="paramname"><em>size</em>&#160;</td>

  2366.         </tr>

  2367.         <tr>

  2368.           <td></td>

  2369.           <td>)</td>

  2370.           <td></td><td></td>

  2371.         </tr>

  2372.       </table>

  2373.   </td>

  2374.   <td class="mlabels-right">

  2375. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2376.   </tr>

  2377. </table>

  2378. </div><div class="memdoc">

  2379. <p>Write data to an open file.</p>

  2380. <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>

  2381. <dl class="params"><dt>Parameters</dt><dd>

  2382.   <table class="params">

  2383.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  2384.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  2385.   </table>

  2386.   </dd>

  2387. </dl>

  2388. <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>

  2389. 

  2390. </div>

  2391. </div>

  2392. <a id="aa763e83fea4889828effc3308f13113a"></a>

  2393. <h2 class="memtitle"><span class="permalink"><a href="#aa763e83fea4889828effc3308f13113a">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2394. 

  2395. <div class="memitem">

  2396. <div class="memproto">

  2397. <table class="mlabels">

  2398.   <tr>

  2399.   <td class="mlabels-left">

  2400.       <table class="memname">

  2401.         <tr>

  2402.           <td class="memname">size_t FsBaseFile::write </td>

  2403.           <td>(</td>

  2404.           <td class="paramtype">const void *&#160;</td>

  2405.           <td class="paramname"><em>buf</em>, </td>

  2406.         </tr>

  2407.         <tr>

  2408.           <td class="paramkey"></td>

  2409.           <td></td>

  2410.           <td class="paramtype">size_t&#160;</td>

  2411.           <td class="paramname"><em>count</em>&#160;</td>

  2412.         </tr>

  2413.         <tr>

  2414.           <td></td>

  2415.           <td>)</td>

  2416.           <td></td><td></td>

  2417.         </tr>

  2418.       </table>

  2419.   </td>

  2420.   <td class="mlabels-right">

  2421. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2422.   </tr>

  2423. </table>

  2424. </div><div class="memdoc">

  2425. <p>Write data to an open file.</p>

  2426. <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>

  2427. <dl class="params"><dt>Parameters</dt><dd>

  2428.   <table class="params">

  2429.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2430.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2431.   </table>

  2432.   </dd>

  2433. </dl>

  2434. <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>

  2435. 

  2436. </div>

  2437. </div>

  2438. <hr/>The documentation for this class was generated from the following file:<ul>

  2439. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/<a class="el" href="_fs_file_8h.html">FsFile.h</a></li>

  2440. </ul>

  2441. </div><!-- contents -->

  2442. <!-- start footer part -->

  2443. <hr class="footer"/><address class="footer"><small>

  2444. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2445. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2446. </a> 1.8.14

  2447. </small></address>

  2448. </body>

  2449. </html>