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

2818 lines
125KB
Raw Permalink Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

  72. <p>exFAT file with Arduino Stream.  

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

  74. 

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

  76. <div class="dynheader">

  77. Inheritance diagram for ExFile:</div>

  78. <div class="dyncontent">

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

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

  81. <area shape="rect" title="exFAT file with Arduino Stream." alt="" coords="62,169,121,196"/>

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

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

  84. <area shape="rect" href="class_ex_fat_file.html" title="Basic file class." alt="" coords="103,5,181,32"/>

  85. </map>

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

  87. <div class="dynheader">

  88. Collaboration diagram for ExFile:</div>

  89. <div class="dyncontent">

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

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

  92. <area shape="rect" title="exFAT file with Arduino Stream." alt="" coords="62,169,121,196"/>

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

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

  95. <area shape="rect" href="class_ex_fat_file.html" title="Basic file class." alt="" coords="103,5,181,32"/>

  96. </map>

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

  98. <table class="memberdecls">

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

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

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

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

  103. <tr class="memitem:adcf47e15b819fe2d6faac2a027ab30f5"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#adcf47e15b819fe2d6faac2a027ab30f5">available64</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

  113. <tr class="memitem:ada4dde9f2eed36bf556fcf1bd3d28ccf"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ada4dde9f2eed36bf556fcf1bd3d28ccf">dataLength</a> ()</td></tr>

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

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

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

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

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

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

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

  121. <tr class="memitem:abc69c9dfc8fdb4ebf9db3bc37c879dc6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#abc69c9dfc8fdb4ebf9db3bc37c879dc6">fgets</a> (char *str, int num, char *delim=<a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>

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

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

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

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

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

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

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

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

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

  131. <tr class="memitem:aba93e2c18be9fa4df7e067b7d6ac5906"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aba93e2c18be9fa4df7e067b7d6ac5906">getName</a> (ExChar_t *<a class="el" href="class_stream_file.html#a8792c863080576eb65ce6cacbe1dd931">name</a>, size_t <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  161. <tr class="memitem:a3a393624d52854e74bf385c9e513a86d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a3a393624d52854e74bf385c9e513a86d">mkdir</a> (<a class="el" href="class_ex_fat_file.html">ExFatFile</a> *parent, const ExChar_t *path, bool pFlag=true)</td></tr>

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

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

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

  165. <tr class="memitem:ab1e224aba9eb796c7ad48062cc1434c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ab1e224aba9eb796c7ad48062cc1434c2">open</a> (const ExChar_t *path, int oflag=0X00)</td></tr>

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

  167. <tr class="memitem:ad0be05c5c7092317089872778052cbd7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ad0be05c5c7092317089872778052cbd7">open</a> (<a class="el" href="class_ex_fat_file.html">ExFatFile</a> *dirFile, const ExChar_t *path, oflag_t oflag)</td></tr>

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

  169. <tr class="memitem:a414b64dc30551e05dcc46f04e0f6413a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a414b64dc30551e05dcc46f04e0f6413a">open</a> (<a class="el" href="class_ex_fat_file.html">ExFatFile</a> *dirFile, uint32_t index, oflag_t oflag)</td></tr>

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

  171. <tr class="memitem:a825447643e6c9e8284a3ed78e3363788"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a825447643e6c9e8284a3ed78e3363788">open</a> (<a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *vol, const ExChar_t *path, int oflag)</td></tr>

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

  173. <tr class="memitem:a89b6021cf70b7adb9feb162260d5a101"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a89b6021cf70b7adb9feb162260d5a101">openNext</a> (<a class="el" href="class_ex_fat_file.html">ExFatFile</a> *dirFile, oflag_t oflag=0X00)</td></tr>

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

  175. <tr class="memitem:ada8cd27e9a2f604f5c05088024a46a63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ex_file.html">ExFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_file.html#ada8cd27e9a2f604f5c05088024a46a63">openNextFile</a> (oflag_t oflag=0X00)</td></tr>

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

  177. <tr class="memitem:af664c1da1bfa0bb5f6eb933bc25f757e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#af664c1da1bfa0bb5f6eb933bc25f757e">openRoot</a> (<a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *vol)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  214. <tr class="memitem:aea570a3b6afbe633d874803b137a46b8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aea570a3b6afbe633d874803b137a46b8">rename</a> (<a class="el" href="class_ex_fat_file.html">ExFatFile</a> *dirFile, const ExChar_t *newPath)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  240. <tr class="memitem:afc8af11ba8e3a830dff1dd5e59446243"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#afc8af11ba8e3a830dff1dd5e59446243">validLength</a> ()</td></tr>

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

  242. <tr class="memitem:a6fb2905a5e363554a5118b5d1322cd87"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a6fb2905a5e363554a5118b5d1322cd87">write</a> (const char *str)</td></tr>

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

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

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

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

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

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

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

  250. </table>

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

  252. <div class="textblock"><p>exFAT file with Arduino Stream. </p>

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

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

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

  256. 

  257. <div class="memitem">

  258. <div class="memproto">

  259. <table class="mlabels">

  260.   <tr>

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

  262.       <table class="memname">

  263.         <tr>

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

  265.           <td>(</td>

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

  267.           <td></td>

  268.         </tr>

  269.       </table>

  270.   </td>

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

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

  273.   </tr>

  274. </table>

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

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

  277. 

  278. </div>

  279. </div>

  280. <a id="adcf47e15b819fe2d6faac2a027ab30f5"></a>

  281. <h2 class="memtitle"><span class="permalink"><a href="#adcf47e15b819fe2d6faac2a027ab30f5">&#9670;&nbsp;</a></span>available64()</h2>

  282. 

  283. <div class="memitem">

  284. <div class="memproto">

  285. <table class="mlabels">

  286.   <tr>

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

  288.       <table class="memname">

  289.         <tr>

  290.           <td class="memname">uint64_t ExFatFile::available64 </td>

  291.           <td>(</td>

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

  293.           <td></td>

  294.         </tr>

  295.       </table>

  296.   </td>

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

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

  299.   </tr>

  300. </table>

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

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

  303. 

  304. </div>

  305. </div>

  306. <a id="ac2004e7bf328b3edda7d4c3acba2726f"></a>

  307. <h2 class="memtitle"><span class="permalink"><a href="#ac2004e7bf328b3edda7d4c3acba2726f">&#9670;&nbsp;</a></span>clearError()</h2>

  308. 

  309. <div class="memitem">

  310. <div class="memproto">

  311. <table class="mlabels">

  312.   <tr>

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

  314.       <table class="memname">

  315.         <tr>

  316.           <td class="memname">void ExFatFile::clearError </td>

  317.           <td>(</td>

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

  319.           <td></td>

  320.         </tr>

  321.       </table>

  322.   </td>

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

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

  325.   </tr>

  326. </table>

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

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

  329. 

  330. </div>

  331. </div>

  332. <a id="abc0d3863895c17df53930bdfa84cb06f"></a>

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

  334. 

  335. <div class="memitem">

  336. <div class="memproto">

  337. <table class="mlabels">

  338.   <tr>

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

  340.       <table class="memname">

  341.         <tr>

  342.           <td class="memname">void ExFatFile::clearWriteError </td>

  343.           <td>(</td>

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

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348.   </td>

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

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

  351.   </tr>

  352. </table>

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

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

  355. 

  356. </div>

  357. </div>

  358. <a id="a7ba9e04099bdf8fd34220ebfdde72867"></a>

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

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

  368.           <td class="memname">bool ExFatFile::close </td>

  369.           <td>(</td>

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

  371.           <td></td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

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

  382. 

  383. </div>

  384. </div>

  385. <a id="ab49396aad3f6500aa19f75490dc26719"></a>

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

  387. 

  388. <div class="memitem">

  389. <div class="memproto">

  390. <table class="mlabels">

  391.   <tr>

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

  393.       <table class="memname">

  394.         <tr>

  395.           <td class="memname">uint64_t ExFatFile::curPosition </td>

  396.           <td>(</td>

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

  398.           <td> const</td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

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

  408. 

  409. </div>

  410. </div>

  411. <a id="ada4dde9f2eed36bf556fcf1bd3d28ccf"></a>

  412. <h2 class="memtitle"><span class="permalink"><a href="#ada4dde9f2eed36bf556fcf1bd3d28ccf">&#9670;&nbsp;</a></span>dataLength()</h2>

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

  421.           <td class="memname">uint64_t ExFatFile::dataLength </td>

  422.           <td>(</td>

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

  424.           <td></td>

  425.         </tr>

  426.       </table>

  427.   </td>

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

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

  430.   </tr>

  431. </table>

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

  433. <dl class="section return"><dt>Returns</dt><dd>Total data length for file. </dd></dl>

  434. 

  435. </div>

  436. </div>

  437. <a id="a5e3baa5d5269c2948cfaf604c42f6a16"></a>

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

  439. 

  440. <div class="memitem">

  441. <div class="memproto">

  442. <table class="mlabels">

  443.   <tr>

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

  445.       <table class="memname">

  446.         <tr>

  447.           <td class="memname">uint32_t ExFatFile::dirIndex </td>

  448.           <td>(</td>

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

  450.           <td></td>

  451.         </tr>

  452.       </table>

  453.   </td>

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

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

  456.   </tr>

  457. </table>

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

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

  460. 

  461. </div>

  462. </div>

  463. <a id="a22a717ddc6d2004c540c67a14264d9dd"></a>

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

  465. 

  466. <div class="memitem">

  467. <div class="memproto">

  468. <table class="mlabels">

  469.   <tr>

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

  471.       <table class="memname">

  472.         <tr>

  473.           <td class="memname">bool ExFatFile::exists </td>

  474.           <td>(</td>

  475.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  477.           <td></td>

  478.         </tr>

  479.       </table>

  480.   </td>

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

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

  483.   </tr>

  484. </table>

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

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

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

  488.   <table class="params">

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

  490.   </table>

  491.   </dd>

  492. </dl>

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

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

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

  496. 

  497. </div>

  498. </div>

  499. <a id="a8614bcbf04b7bbfc70fe36d2fa7f70c1"></a>

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

  501. 

  502. <div class="memitem">

  503. <div class="memproto">

  504. <table class="mlabels">

  505.   <tr>

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

  507.       <table class="memname">

  508.         <tr>

  509.           <td class="memname">void ExFatFile::fgetpos </td>

  510.           <td>(</td>

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

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

  513.           <td></td>

  514.         </tr>

  515.       </table>

  516.   </td>

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

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

  519.   </tr>

  520. </table>

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

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

  523.   <table class="params">

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

  525.   </table>

  526.   </dd>

  527. </dl>

  528. 

  529. </div>

  530. </div>

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

  532. <h2 class="memtitle"><span class="permalink"><a href="#abc69c9dfc8fdb4ebf9db3bc37c879dc6">&#9670;&nbsp;</a></span>fgets()</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">int ExFatFile::fgets </td>

  542.           <td>(</td>

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

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

  545.         </tr>

  546.         <tr>

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

  548.           <td></td>

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

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

  551.         </tr>

  552.         <tr>

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

  554.           <td></td>

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

  556.           <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code>&#160;</td>

  557.         </tr>

  558.         <tr>

  559.           <td></td>

  560.           <td>)</td>

  561.           <td></td><td></td>

  562.         </tr>

  563.       </table>

  564.   </td>

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

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

  567.   </tr>

  568. </table>

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

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

  571. <p><a class="el" href="class_ex_fat_file.html#abc69c9dfc8fdb4ebf9db3bc37c879dc6">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>

  572. <p><a class="el" href="class_ex_fat_file.html#abc69c9dfc8fdb4ebf9db3bc37c879dc6">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>

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

  574.   <table class="params">

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

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

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

  578.   </table>

  579.   </dd>

  580. </dl>

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

  582. 

  583. </div>

  584. </div>

  585. <a id="af2c08909b62b01f3edc4ee0c51ea7435"></a>

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

  587. 

  588. <div class="memitem">

  589. <div class="memproto">

  590. <table class="mlabels">

  591.   <tr>

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

  593.       <table class="memname">

  594.         <tr>

  595.           <td class="memname">uint64_t ExFatFile::fileSize </td>

  596.           <td>(</td>

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

  598.           <td></td>

  599.         </tr>

  600.       </table>

  601.   </td>

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

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

  604.   </tr>

  605. </table>

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

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

  608. 

  609. </div>

  610. </div>

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

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

  613. 

  614. <div class="memitem">

  615. <div class="memproto">

  616. <table class="mlabels">

  617.   <tr>

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

  619.       <table class="memname">

  620.         <tr>

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

  622.           <td>(</td>

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

  624.           <td></td>

  625.         </tr>

  626.       </table>

  627.   </td>

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

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

  630.   </tr>

  631. </table>

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

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

  634. 

  635. </div>

  636. </div>

  637. <a id="aea1e4d0c0981081774dc3c7cd3c55264"></a>

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

  639. 

  640. <div class="memitem">

  641. <div class="memproto">

  642. <table class="mlabels">

  643.   <tr>

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

  645.       <table class="memname">

  646.         <tr>

  647.           <td class="memname">void ExFatFile::fsetpos </td>

  648.           <td>(</td>

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

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

  651.           <td></td>

  652.         </tr>

  653.       </table>

  654.   </td>

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

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

  657.   </tr>

  658. </table>

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

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

  661.   <table class="params">

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

  663.   </table>

  664.   </dd>

  665. </dl>

  666. 

  667. </div>

  668. </div>

  669. <a id="ac697224450ca216c60585d25f5f6e310"></a>

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

  671. 

  672. <div class="memitem">

  673. <div class="memproto">

  674. <table class="mlabels">

  675.   <tr>

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

  677.       <table class="memname">

  678.         <tr>

  679.           <td class="memname">uint8_t ExFatFile::getError </td>

  680.           <td>(</td>

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

  682.           <td></td>

  683.         </tr>

  684.       </table>

  685.   </td>

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

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

  688.   </tr>

  689. </table>

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

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

  692. 

  693. </div>

  694. </div>

  695. <a id="aba93e2c18be9fa4df7e067b7d6ac5906"></a>

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

  697. 

  698. <div class="memitem">

  699. <div class="memproto">

  700. <table class="mlabels">

  701.   <tr>

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

  703.       <table class="memname">

  704.         <tr>

  705.           <td class="memname">size_t ExFatFile::getName </td>

  706.           <td>(</td>

  707.           <td class="paramtype">ExChar_t *&#160;</td>

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

  709.         </tr>

  710.         <tr>

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

  712.           <td></td>

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

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

  715.         </tr>

  716.         <tr>

  717.           <td></td>

  718.           <td>)</td>

  719.           <td></td><td></td>

  720.         </tr>

  721.       </table>

  722.   </td>

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

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

  725.   </tr>

  726. </table>

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

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

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

  730.   <table class="params">

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

  732.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in characters. </td></tr>

  733.   </table>

  734.   </dd>

  735. </dl>

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

  737. 

  738. </div>

  739. </div>

  740. <a id="a01da9896a59671a61f90dd20c3ac5d07"></a>

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

  742. 

  743. <div class="memitem">

  744. <div class="memproto">

  745. <table class="mlabels">

  746.   <tr>

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

  748.       <table class="memname">

  749.         <tr>

  750.           <td class="memname">bool ExFatFile::getWriteError </td>

  751.           <td>(</td>

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

  753.           <td></td>

  754.         </tr>

  755.       </table>

  756.   </td>

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

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

  759.   </tr>

  760. </table>

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

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

  763. 

  764. </div>

  765. </div>

  766. <a id="a7a167102bd47b7cf91167b69f8cc57d1"></a>

  767. <h2 class="memtitle"><span class="permalink"><a href="#a7a167102bd47b7cf91167b69f8cc57d1">&#9670;&nbsp;</a></span>isContiguous()</h2>

  768. 

  769. <div class="memitem">

  770. <div class="memproto">

  771. <table class="mlabels">

  772.   <tr>

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

  774.       <table class="memname">

  775.         <tr>

  776.           <td class="memname">bool ExFatFile::isContiguous </td>

  777.           <td>(</td>

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

  779.           <td> const</td>

  780.         </tr>

  781.       </table>

  782.   </td>

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

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

  785.   </tr>

  786. </table>

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

  788. <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>

  789. 

  790. </div>

  791. </div>

  792. <a id="ad0a3687bd95bed5b216651335e66b500"></a>

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

  794. 

  795. <div class="memitem">

  796. <div class="memproto">

  797. <table class="mlabels">

  798.   <tr>

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

  800.       <table class="memname">

  801.         <tr>

  802.           <td class="memname">bool ExFatFile::isDir </td>

  803.           <td>(</td>

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

  805.           <td> const</td>

  806.         </tr>

  807.       </table>

  808.   </td>

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

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

  811.   </tr>

  812. </table>

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

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

  815. 

  816. </div>

  817. </div>

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

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

  820. 

  821. <div class="memitem">

  822. <div class="memproto">

  823. <table class="mlabels">

  824.   <tr>

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

  826.       <table class="memname">

  827.         <tr>

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

  829.           <td>(</td>

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

  831.           <td></td>

  832.         </tr>

  833.       </table>

  834.   </td>

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

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

  837.   </tr>

  838. </table>

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

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

  841. 

  842. </div>

  843. </div>

  844. <a id="af601285f95db8398c140b3927cf9111c"></a>

  845. <h2 class="memtitle"><span class="permalink"><a href="#af601285f95db8398c140b3927cf9111c">&#9670;&nbsp;</a></span>isFile()</h2>

  846. 

  847. <div class="memitem">

  848. <div class="memproto">

  849. <table class="mlabels">

  850.   <tr>

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

  852.       <table class="memname">

  853.         <tr>

  854.           <td class="memname">bool ExFatFile::isFile </td>

  855.           <td>(</td>

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

  857.           <td> const</td>

  858.         </tr>

  859.       </table>

  860.   </td>

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

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

  863.   </tr>

  864. </table>

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

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

  867. 

  868. </div>

  869. </div>

  870. <a id="ac926285fa4321ebee28fa91beb511eae"></a>

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

  872. 

  873. <div class="memitem">

  874. <div class="memproto">

  875. <table class="mlabels">

  876.   <tr>

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

  878.       <table class="memname">

  879.         <tr>

  880.           <td class="memname">bool ExFatFile::isHidden </td>

  881.           <td>(</td>

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

  883.           <td> const</td>

  884.         </tr>

  885.       </table>

  886.   </td>

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

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

  889.   </tr>

  890. </table>

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

  892. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden. </dd></dl>

  893. 

  894. </div>

  895. </div>

  896. <a id="a804c34bbe3ebefe2b6c1d77ff8d49a35"></a>

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

  898. 

  899. <div class="memitem">

  900. <div class="memproto">

  901. <table class="mlabels">

  902.   <tr>

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

  904.       <table class="memname">

  905.         <tr>

  906.           <td class="memname">bool ExFatFile::isOpen </td>

  907.           <td>(</td>

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

  909.           <td> const</td>

  910.         </tr>

  911.       </table>

  912.   </td>

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

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

  915.   </tr>

  916. </table>

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

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

  919. 

  920. </div>

  921. </div>

  922. <a id="a9ca137dfba2c7772910f4d2b3fdd9411"></a>

  923. <h2 class="memtitle"><span class="permalink"><a href="#a9ca137dfba2c7772910f4d2b3fdd9411">&#9670;&nbsp;</a></span>isReadable()</h2>

  924. 

  925. <div class="memitem">

  926. <div class="memproto">

  927. <table class="mlabels">

  928.   <tr>

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

  930.       <table class="memname">

  931.         <tr>

  932.           <td class="memname">bool ExFatFile::isReadable </td>

  933.           <td>(</td>

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

  935.           <td> const</td>

  936.         </tr>

  937.       </table>

  938.   </td>

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

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

  941.   </tr>

  942. </table>

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

  944. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>

  945. 

  946. </div>

  947. </div>

  948. <a id="a14d160bfbfb39717746b93fa2eda5739"></a>

  949. <h2 class="memtitle"><span class="permalink"><a href="#a14d160bfbfb39717746b93fa2eda5739">&#9670;&nbsp;</a></span>isReadOnly()</h2>

  950. 

  951. <div class="memitem">

  952. <div class="memproto">

  953. <table class="mlabels">

  954.   <tr>

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

  956.       <table class="memname">

  957.         <tr>

  958.           <td class="memname">bool ExFatFile::isReadOnly </td>

  959.           <td>(</td>

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

  961.           <td> const</td>

  962.         </tr>

  963.       </table>

  964.   </td>

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

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

  967.   </tr>

  968. </table>

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

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

  971. 

  972. </div>

  973. </div>

  974. <a id="ad9f8e7afcf749ebcaaf055bd569dc7da"></a>

  975. <h2 class="memtitle"><span class="permalink"><a href="#ad9f8e7afcf749ebcaaf055bd569dc7da">&#9670;&nbsp;</a></span>isRoot()</h2>

  976. 

  977. <div class="memitem">

  978. <div class="memproto">

  979. <table class="mlabels">

  980.   <tr>

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

  982.       <table class="memname">

  983.         <tr>

  984.           <td class="memname">bool ExFatFile::isRoot </td>

  985.           <td>(</td>

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

  987.           <td> const</td>

  988.         </tr>

  989.       </table>

  990.   </td>

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

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

  993.   </tr>

  994. </table>

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

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

  997. 

  998. </div>

  999. </div>

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

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

  1002. 

  1003. <div class="memitem">

  1004. <div class="memproto">

  1005. <table class="mlabels">

  1006.   <tr>

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

  1008.       <table class="memname">

  1009.         <tr>

  1010.           <td class="memname">bool ExFatFile::isSubDir </td>

  1011.           <td>(</td>

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

  1013.           <td> const</td>

  1014.         </tr>

  1015.       </table>

  1016.   </td>

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

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

  1019.   </tr>

  1020. </table>

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

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

  1023. 

  1024. </div>

  1025. </div>

  1026. <a id="a04d1c43e80743f8c1a51b64062ce16dd"></a>

  1027. <h2 class="memtitle"><span class="permalink"><a href="#a04d1c43e80743f8c1a51b64062ce16dd">&#9670;&nbsp;</a></span>isWritable()</h2>

  1028. 

  1029. <div class="memitem">

  1030. <div class="memproto">

  1031. <table class="mlabels">

  1032.   <tr>

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

  1034.       <table class="memname">

  1035.         <tr>

  1036.           <td class="memname">bool ExFatFile::isWritable </td>

  1037.           <td>(</td>

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

  1039.           <td> const</td>

  1040.         </tr>

  1041.       </table>

  1042.   </td>

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

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

  1045.   </tr>

  1046. </table>

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

  1048. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>

  1049. 

  1050. </div>

  1051. </div>

  1052. <a id="aa0e074c891f3db5ea2ebd491667b03a6"></a>

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

  1054. 

  1055. <div class="memitem">

  1056. <div class="memproto">

  1057. <table class="mlabels">

  1058.   <tr>

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

  1060.       <table class="memname">

  1061.         <tr>

  1062.           <td class="memname">bool ExFatFile::ls </td>

  1063.           <td>(</td>

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

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

  1066.           <td></td>

  1067.         </tr>

  1068.       </table>

  1069.   </td>

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

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

  1072.   </tr>

  1073. </table>

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

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

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

  1077.   <table class="params">

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

  1079.   </table>

  1080.   </dd>

  1081. </dl>

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

  1083. 

  1084. </div>

  1085. </div>

  1086. <a id="a09f8beb55f939874e93c1df6c8a046d4"></a>

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

  1088. 

  1089. <div class="memitem">

  1090. <div class="memproto">

  1091. <table class="mlabels">

  1092.   <tr>

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

  1094.       <table class="memname">

  1095.         <tr>

  1096.           <td class="memname">bool ExFatFile::ls </td>

  1097.           <td>(</td>

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

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

  1100.         </tr>

  1101.         <tr>

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

  1103.           <td></td>

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

  1105.           <td class="paramname"><em>flags</em>, </td>

  1106.         </tr>

  1107.         <tr>

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

  1109.           <td></td>

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

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

  1112.         </tr>

  1113.         <tr>

  1114.           <td></td>

  1115.           <td>)</td>

  1116.           <td></td><td></td>

  1117.         </tr>

  1118.       </table>

  1119.   </td>

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

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

  1122.   </tr>

  1123. </table>

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

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

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

  1127.   <table class="params">

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

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

  1130.   </table>

  1131.   </dd>

  1132. </dl>

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

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

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

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

  1137.   <table class="params">

  1138.     <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>Amount of space before file name. Used for recursive list to indicate subdirectory level.</td></tr>

  1139.   </table>

  1140.   </dd>

  1141. </dl>

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

  1143. 

  1144. </div>

  1145. </div>

  1146. <a id="a3a393624d52854e74bf385c9e513a86d"></a>

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

  1148. 

  1149. <div class="memitem">

  1150. <div class="memproto">

  1151. <table class="mlabels">

  1152.   <tr>

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

  1154.       <table class="memname">

  1155.         <tr>

  1156.           <td class="memname">bool ExFatFile::mkdir </td>

  1157.           <td>(</td>

  1158.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

  1159.           <td class="paramname"><em>parent</em>, </td>

  1160.         </tr>

  1161.         <tr>

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

  1163.           <td></td>

  1164.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  1166.         </tr>

  1167.         <tr>

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

  1169.           <td></td>

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

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

  1172.         </tr>

  1173.         <tr>

  1174.           <td></td>

  1175.           <td>)</td>

  1176.           <td></td><td></td>

  1177.         </tr>

  1178.       </table>

  1179.   </td>

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

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

  1182.   </tr>

  1183. </table>

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

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

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

  1187.   <table class="params">

  1188.     <tr><td class="paramdir">[in]</td><td class="paramname">parent</td><td>An open directory file that will contain the new directory.</td></tr>

  1189.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the new directory.</td></tr>

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

  1191.   </table>

  1192.   </dd>

  1193. </dl>

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

  1195. 

  1196. </div>

  1197. </div>

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

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

  1200. 

  1201. <div class="memitem">

  1202. <div class="memproto">

  1203. <table class="mlabels">

  1204.   <tr>

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

  1206.       <table class="memname">

  1207.         <tr>

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

  1209.           <td>(</td>

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

  1211.           <td> const</td>

  1212.         </tr>

  1213.       </table>

  1214.   </td>

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

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

  1217.   </tr>

  1218. </table>

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

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

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

  1222. 

  1223. </div>

  1224. </div>

  1225. <a id="ab1e224aba9eb796c7ad48062cc1434c2"></a>

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

  1227. 

  1228. <div class="memitem">

  1229. <div class="memproto">

  1230. <table class="mlabels">

  1231.   <tr>

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

  1233.       <table class="memname">

  1234.         <tr>

  1235.           <td class="memname">bool ExFatFile::open </td>

  1236.           <td>(</td>

  1237.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  1239.         </tr>

  1240.         <tr>

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

  1242.           <td></td>

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

  1244.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1245.         </tr>

  1246.         <tr>

  1247.           <td></td>

  1248.           <td>)</td>

  1249.           <td></td><td></td>

  1250.         </tr>

  1251.       </table>

  1252.   </td>

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

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

  1255.   </tr>

  1256. </table>

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

  1258. <p>Open a file in the current working directory.</p>

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

  1260.   <table class="params">

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

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

  1263.   </table>

  1264.   </dd>

  1265. </dl>

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

  1267. 

  1268. </div>

  1269. </div>

  1270. <a id="ad0be05c5c7092317089872778052cbd7"></a>

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

  1272. 

  1273. <div class="memitem">

  1274. <div class="memproto">

  1275. <table class="mlabels">

  1276.   <tr>

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

  1278.       <table class="memname">

  1279.         <tr>

  1280.           <td class="memname">bool ExFatFile::open </td>

  1281.           <td>(</td>

  1282.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

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

  1284.         </tr>

  1285.         <tr>

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

  1287.           <td></td>

  1288.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  1290.         </tr>

  1291.         <tr>

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

  1293.           <td></td>

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

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

  1296.         </tr>

  1297.         <tr>

  1298.           <td></td>

  1299.           <td>)</td>

  1300.           <td></td><td></td>

  1301.         </tr>

  1302.       </table>

  1303.   </td>

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

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

  1306.   </tr>

  1307. </table>

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

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

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

  1311.   <table class="params">

  1312.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open directory containing the file to be opened.</td></tr>

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

  1314.     <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. Only one of O_RDONLY, O_READ, O_WRONLY, O_WRITE, or O_RDWR is allowed.</td></tr>

  1315.   </table>

  1316.   </dd>

  1317. </dl>

  1318. <p>O_RDONLY - Open for reading.</p>

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

  1320. <p>O_WRONLY - Open for writing.</p>

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

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

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

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

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

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

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

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

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

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

  1331. 

  1332. </div>

  1333. </div>

  1334. <a id="a414b64dc30551e05dcc46f04e0f6413a"></a>

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

  1336. 

  1337. <div class="memitem">

  1338. <div class="memproto">

  1339. <table class="mlabels">

  1340.   <tr>

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

  1342.       <table class="memname">

  1343.         <tr>

  1344.           <td class="memname">bool ExFatFile::open </td>

  1345.           <td>(</td>

  1346.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

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

  1348.         </tr>

  1349.         <tr>

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

  1351.           <td></td>

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

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

  1354.         </tr>

  1355.         <tr>

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

  1357.           <td></td>

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

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

  1360.         </tr>

  1361.         <tr>

  1362.           <td></td>

  1363.           <td>)</td>

  1364.           <td></td><td></td>

  1365.         </tr>

  1366.       </table>

  1367.   </td>

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

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

  1370.   </tr>

  1371. </table>

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

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

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

  1375.   <table class="params">

  1376.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_ex_fat_file.html" title="Basic file class.">ExFatFile</a> instance for the directory.</td></tr>

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

  1378.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open flags. See see <a class="el" href="class_ex_fat_file.html#ad0be05c5c7092317089872778052cbd7">ExFatFile::open(ExFatFile*, const ExChar_t*, uint8_t)</a>.</td></tr>

  1379.   </table>

  1380.   </dd>

  1381. </dl>

  1382. <p>See <a class="el" href="class_ex_fat_file.html#ad0be05c5c7092317089872778052cbd7">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>

  1383. 

  1384. </div>

  1385. </div>

  1386. <a id="a825447643e6c9e8284a3ed78e3363788"></a>

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

  1388. 

  1389. <div class="memitem">

  1390. <div class="memproto">

  1391. <table class="mlabels">

  1392.   <tr>

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

  1394.       <table class="memname">

  1395.         <tr>

  1396.           <td class="memname">bool ExFatFile::open </td>

  1397.           <td>(</td>

  1398.           <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *&#160;</td>

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

  1400.         </tr>

  1401.         <tr>

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

  1403.           <td></td>

  1404.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  1406.         </tr>

  1407.         <tr>

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

  1409.           <td></td>

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

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

  1412.         </tr>

  1413.         <tr>

  1414.           <td></td>

  1415.           <td>)</td>

  1416.           <td></td><td></td>

  1417.         </tr>

  1418.       </table>

  1419.   </td>

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

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

  1422.   </tr>

  1423. </table>

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

  1425. <p>Open a file in the volume working directory.</p>

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

  1427.   <table class="params">

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

  1429.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>

  1430.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open flags. See see <a class="el" href="class_ex_fat_file.html#ad0be05c5c7092317089872778052cbd7">open(ExFatFile*, const char*, uint8_t)</a>.</td></tr>

  1431.   </table>

  1432.   </dd>

  1433. </dl>

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

  1435. 

  1436. </div>

  1437. </div>

  1438. <a id="a89b6021cf70b7adb9feb162260d5a101"></a>

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

  1440. 

  1441. <div class="memitem">

  1442. <div class="memproto">

  1443. <table class="mlabels">

  1444.   <tr>

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

  1446.       <table class="memname">

  1447.         <tr>

  1448.           <td class="memname">bool ExFatFile::openNext </td>

  1449.           <td>(</td>

  1450.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

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

  1452.         </tr>

  1453.         <tr>

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

  1455.           <td></td>

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

  1457.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1458.         </tr>

  1459.         <tr>

  1460.           <td></td>

  1461.           <td>)</td>

  1462.           <td></td><td></td>

  1463.         </tr>

  1464.       </table>

  1465.   </td>

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

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

  1468.   </tr>

  1469. </table>

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

  1471. <p>Open the next file or subdirectory in a directory.</p>

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

  1473.   <table class="params">

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

  1475.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open flags. See see <a class="el" href="class_ex_fat_file.html#ad0be05c5c7092317089872778052cbd7">open(ExFatFile*, const char*, uint8_t)</a>.</td></tr>

  1476.   </table>

  1477.   </dd>

  1478. </dl>

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

  1480. 

  1481. </div>

  1482. </div>

  1483. <a id="ada8cd27e9a2f604f5c05088024a46a63"></a>

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

  1485. 

  1486. <div class="memitem">

  1487. <div class="memproto">

  1488. <table class="mlabels">

  1489.   <tr>

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

  1491.       <table class="memname">

  1492.         <tr>

  1493.           <td class="memname"><a class="el" href="class_ex_file.html">ExFile</a> ExFile::openNextFile </td>

  1494.           <td>(</td>

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

  1496.           <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>

  1497.           <td></td>

  1498.         </tr>

  1499.       </table>

  1500.   </td>

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

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

  1503.   </tr>

  1504. </table>

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

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

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

  1508.   <table class="params">

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

  1510.   </table>

  1511.   </dd>

  1512. </dl>

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

  1514. 

  1515. </div>

  1516. </div>

  1517. <a id="af664c1da1bfa0bb5f6eb933bc25f757e"></a>

  1518. <h2 class="memtitle"><span class="permalink"><a href="#af664c1da1bfa0bb5f6eb933bc25f757e">&#9670;&nbsp;</a></span>openRoot()</h2>

  1519. 

  1520. <div class="memitem">

  1521. <div class="memproto">

  1522. <table class="mlabels">

  1523.   <tr>

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

  1525.       <table class="memname">

  1526.         <tr>

  1527.           <td class="memname">bool ExFatFile::openRoot </td>

  1528.           <td>(</td>

  1529.           <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *&#160;</td>

  1530.           <td class="paramname"><em>vol</em></td><td>)</td>

  1531.           <td></td>

  1532.         </tr>

  1533.       </table>

  1534.   </td>

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

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

  1537.   </tr>

  1538. </table>

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

  1540. <p>Open a volume's root directory.</p>

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

  1542.   <table class="params">

  1543.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1544.   </table>

  1545.   </dd>

  1546. </dl>

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

  1548. 

  1549. </div>

  1550. </div>

  1551. <a id="aa1abbd813f27d488f0ff439ccbc9ca98"></a>

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

  1553. 

  1554. <div class="memitem">

  1555. <div class="memproto">

  1556. <table class="mlabels">

  1557.   <tr>

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

  1559.       <table class="memname">

  1560.         <tr>

  1561.           <td class="memname">ExFatFile::operator bool </td>

  1562.           <td>(</td>

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

  1564.           <td></td>

  1565.         </tr>

  1566.       </table>

  1567.   </td>

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

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

  1570.   </tr>

  1571. </table>

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

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

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

  1575. 

  1576. </div>

  1577. </div>

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

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

  1580. 

  1581. <div class="memitem">

  1582. <div class="memproto">

  1583. <table class="mlabels">

  1584.   <tr>

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

  1586.       <table class="memname">

  1587.         <tr>

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

  1589.           <td>(</td>

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

  1591.           <td></td>

  1592.         </tr>

  1593.       </table>

  1594.   </td>

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

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

  1597.   </tr>

  1598. </table>

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

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

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

  1602. 

  1603. </div>

  1604. </div>

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

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

  1607. 

  1608. <div class="memitem">

  1609. <div class="memproto">

  1610. <table class="mlabels">

  1611.   <tr>

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

  1613.       <table class="memname">

  1614.         <tr>

  1615.           <td class="memname">uint64_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::position </td>

  1616.           <td>(</td>

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

  1618.           <td></td>

  1619.         </tr>

  1620.       </table>

  1621.   </td>

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

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

  1624.   </tr>

  1625. </table>

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

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

  1628. 

  1629. </div>

  1630. </div>

  1631. <a id="a35a5093014e80965e49c84b61780556f"></a>

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

  1633. 

  1634. <div class="memitem">

  1635. <div class="memproto">

  1636. <table class="mlabels">

  1637.   <tr>

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

  1639.       <table class="memname">

  1640.         <tr>

  1641.           <td class="memname">bool ExFatFile::preAllocate </td>

  1642.           <td>(</td>

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

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

  1645.           <td></td>

  1646.         </tr>

  1647.       </table>

  1648.   </td>

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

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

  1651.   </tr>

  1652. </table>

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

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

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

  1656. <p>The file will have zero validLength and dataLength will equal the requested length.</p>

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

  1658.   <table class="params">

  1659.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of allocated space in bytes. </td></tr>

  1660.   </table>

  1661.   </dd>

  1662. </dl>

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

  1664. 

  1665. </div>

  1666. </div>

  1667. <a id="ad9ba8aa00b9db683d40fc2989dbe1922"></a>

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

  1669. 

  1670. <div class="memitem">

  1671. <div class="memproto">

  1672. <table class="mlabels">

  1673.   <tr>

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

  1675.       <table class="memname">

  1676.         <tr>

  1677.           <td class="memname">size_t ExFatFile::printAccessDateTime </td>

  1678.           <td>(</td>

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

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

  1681.           <td></td>

  1682.         </tr>

  1683.       </table>

  1684.   </td>

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

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

  1687.   </tr>

  1688. </table>

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

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

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

  1692.   <table class="params">

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

  1694.   </table>

  1695.   </dd>

  1696. </dl>

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

  1698. 

  1699. </div>

  1700. </div>

  1701. <a id="a7318b2d7594d6ba52421c413f5fc35cd"></a>

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

  1703. 

  1704. <div class="memitem">

  1705. <div class="memproto">

  1706. <table class="mlabels">

  1707.   <tr>

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

  1709.       <table class="memname">

  1710.         <tr>

  1711.           <td class="memname">size_t ExFatFile::printCreateDateTime </td>

  1712.           <td>(</td>

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

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

  1715.           <td></td>

  1716.         </tr>

  1717.       </table>

  1718.   </td>

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

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

  1721.   </tr>

  1722. </table>

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

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

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

  1726.   <table class="params">

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

  1728.   </table>

  1729.   </dd>

  1730. </dl>

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

  1732. 

  1733. </div>

  1734. </div>

  1735. <a id="a496ac61e367a24665425d54956a46346"></a>

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

  1737. 

  1738. <div class="memitem">

  1739. <div class="memproto">

  1740. <table class="mlabels">

  1741.   <tr>

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

  1743.       <table class="memname">

  1744.         <tr>

  1745.           <td class="memname">size_t ExFatFile::printField </td>

  1746.           <td>(</td>

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

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

  1749.         </tr>

  1750.         <tr>

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

  1752.           <td></td>

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

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

  1755.         </tr>

  1756.         <tr>

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

  1758.           <td></td>

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

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

  1761.         </tr>

  1762.         <tr>

  1763.           <td></td>

  1764.           <td>)</td>

  1765.           <td></td><td></td>

  1766.         </tr>

  1767.       </table>

  1768.   </td>

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

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

  1771.   </tr>

  1772. </table>

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

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

  1775.   <table class="params">

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

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

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

  1779.   </table>

  1780.   </dd>

  1781. </dl>

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

  1783. 

  1784. </div>

  1785. </div>

  1786. <a id="a70eda4191df90f608694c1faede7fb33"></a>

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

  1788. 

  1789. <div class="memitem">

  1790. <div class="memproto">

  1791. <table class="mlabels">

  1792.   <tr>

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

  1794.       <table class="memname">

  1795.         <tr>

  1796.           <td class="memname">size_t ExFatFile::printField </td>

  1797.           <td>(</td>

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

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

  1800.         </tr>

  1801.         <tr>

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

  1803.           <td></td>

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

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

  1806.         </tr>

  1807.         <tr>

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

  1809.           <td></td>

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

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

  1812.         </tr>

  1813.         <tr>

  1814.           <td></td>

  1815.           <td>)</td>

  1816.           <td></td><td></td>

  1817.         </tr>

  1818.       </table>

  1819.   </td>

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

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

  1822.   </tr>

  1823. </table>

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

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

  1826.   <table class="params">

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

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

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

  1830.   </table>

  1831.   </dd>

  1832. </dl>

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

  1834. 

  1835. </div>

  1836. </div>

  1837. <a id="a9759c13e804c01ff9e7e2ac8fbabc5b8"></a>

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

  1839. 

  1840. <div class="memitem">

  1841. <div class="memproto">

  1842. <div class="memtemplate">

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

  1844. <table class="mlabels">

  1845.   <tr>

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

  1847.       <table class="memname">

  1848.         <tr>

  1849.           <td class="memname">size_t ExFatFile::printField </td>

  1850.           <td>(</td>

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

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

  1853.         </tr>

  1854.         <tr>

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

  1856.           <td></td>

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

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

  1859.         </tr>

  1860.         <tr>

  1861.           <td></td>

  1862.           <td>)</td>

  1863.           <td></td><td></td>

  1864.         </tr>

  1865.       </table>

  1866.   </td>

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

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

  1869.   </tr>

  1870. </table>

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

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

  1873.   <table class="params">

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

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

  1876.   </table>

  1877.   </dd>

  1878. </dl>

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

  1880. 

  1881. </div>

  1882. </div>

  1883. <a id="a16d527f98cff3ffd3ba8bc594a22d186"></a>

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

  1885. 

  1886. <div class="memitem">

  1887. <div class="memproto">

  1888. <table class="mlabels">

  1889.   <tr>

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

  1891.       <table class="memname">

  1892.         <tr>

  1893.           <td class="memname">size_t ExFatFile::printFileSize </td>

  1894.           <td>(</td>

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

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

  1897.           <td></td>

  1898.         </tr>

  1899.       </table>

  1900.   </td>

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

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

  1903.   </tr>

  1904. </table>

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

  1906. <p>Print a file's size in bytes. </p><dl class="params"><dt>Parameters</dt><dd>

  1907.   <table class="params">

  1908.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Prtin stream for the output. </td></tr>

  1909.   </table>

  1910.   </dd>

  1911. </dl>

  1912. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  1913. 

  1914. </div>

  1915. </div>

  1916. <a id="a16488d3e0d946f108240b7d6c536c6f4"></a>

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

  1918. 

  1919. <div class="memitem">

  1920. <div class="memproto">

  1921. <table class="mlabels">

  1922.   <tr>

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

  1924.       <table class="memname">

  1925.         <tr>

  1926.           <td class="memname">size_t ExFatFile::printModifyDateTime </td>

  1927.           <td>(</td>

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

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

  1930.           <td></td>

  1931.         </tr>

  1932.       </table>

  1933.   </td>

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

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

  1936.   </tr>

  1937. </table>

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

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

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

  1941.   <table class="params">

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

  1943.   </table>

  1944.   </dd>

  1945. </dl>

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

  1947. 

  1948. </div>

  1949. </div>

  1950. <a id="a095c0a865e5e5b6463c3dc0c90680635"></a>

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

  1952. 

  1953. <div class="memitem">

  1954. <div class="memproto">

  1955. <table class="mlabels">

  1956.   <tr>

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

  1958.       <table class="memname">

  1959.         <tr>

  1960.           <td class="memname">size_t ExFatFile::printName </td>

  1961.           <td>(</td>

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

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

  1964.           <td></td>

  1965.         </tr>

  1966.       </table>

  1967.   </td>

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

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

  1970.   </tr>

  1971. </table>

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

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

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

  1975.   <table class="params">

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

  1977.   </table>

  1978.   </dd>

  1979. </dl>

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

  1981. 

  1982. </div>

  1983. </div>

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

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

  1986. 

  1987. <div class="memitem">

  1988. <div class="memproto">

  1989. <table class="mlabels">

  1990.   <tr>

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

  1992.       <table class="memname">

  1993.         <tr>

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

  1995.           <td>(</td>

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

  1997.           <td></td>

  1998.         </tr>

  1999.       </table>

  2000.   </td>

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

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

  2003.   </tr>

  2004. </table>

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

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

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

  2008. 

  2009. </div>

  2010. </div>

  2011. <a id="a5ae5477efe55179cf07e173c62654313"></a>

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

  2013. 

  2014. <div class="memitem">

  2015. <div class="memproto">

  2016. <table class="mlabels">

  2017.   <tr>

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

  2019.       <table class="memname">

  2020.         <tr>

  2021.           <td class="memname">int ExFatFile::read </td>

  2022.           <td>(</td>

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

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

  2025.         </tr>

  2026.         <tr>

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

  2028.           <td></td>

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

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

  2031.         </tr>

  2032.         <tr>

  2033.           <td></td>

  2034.           <td>)</td>

  2035.           <td></td><td></td>

  2036.         </tr>

  2037.       </table>

  2038.   </td>

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

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

  2041.   </tr>

  2042. </table>

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

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

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

  2046.   <table class="params">

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

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

  2049.   </table>

  2050.   </dd>

  2051. </dl>

  2052. <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>nbyte</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. </dd></dl>

  2053. 

  2054. </div>

  2055. </div>

  2056. <a id="a8e88c8e79551a72cc98310038514c47a"></a>

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

  2058. 

  2059. <div class="memitem">

  2060. <div class="memproto">

  2061. <table class="mlabels">

  2062.   <tr>

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

  2064.       <table class="memname">

  2065.         <tr>

  2066.           <td class="memname">bool ExFatFile::remove </td>

  2067.           <td>(</td>

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

  2069.           <td></td>

  2070.         </tr>

  2071.       </table>

  2072.   </td>

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

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

  2075.   </tr>

  2076. </table>

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

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

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

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

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

  2082. 

  2083. </div>

  2084. </div>

  2085. <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>

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

  2087. 

  2088. <div class="memitem">

  2089. <div class="memproto">

  2090. <table class="mlabels">

  2091.   <tr>

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

  2093.       <table class="memname">

  2094.         <tr>

  2095.           <td class="memname">bool ExFatFile::remove </td>

  2096.           <td>(</td>

  2097.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  2099.           <td></td>

  2100.         </tr>

  2101.       </table>

  2102.   </td>

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

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

  2105.   </tr>

  2106. </table>

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

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

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

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

  2111.   <table class="params">

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

  2113.   </table>

  2114.   </dd>

  2115. </dl>

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

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

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

  2119. 

  2120. </div>

  2121. </div>

  2122. <a id="aab50b2646035f76834c75230d2b55c64"></a>

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

  2124. 

  2125. <div class="memitem">

  2126. <div class="memproto">

  2127. <table class="mlabels">

  2128.   <tr>

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

  2130.       <table class="memname">

  2131.         <tr>

  2132.           <td class="memname">bool ExFatFile::rename </td>

  2133.           <td>(</td>

  2134.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  2136.           <td></td>

  2137.         </tr>

  2138.       </table>

  2139.   </td>

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

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

  2142.   </tr>

  2143. </table>

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

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

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

  2147.   <table class="params">

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

  2149.   </table>

  2150.   </dd>

  2151. </dl>

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

  2153. 

  2154. </div>

  2155. </div>

  2156. <a id="aea570a3b6afbe633d874803b137a46b8"></a>

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

  2158. 

  2159. <div class="memitem">

  2160. <div class="memproto">

  2161. <table class="mlabels">

  2162.   <tr>

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

  2164.       <table class="memname">

  2165.         <tr>

  2166.           <td class="memname">bool ExFatFile::rename </td>

  2167.           <td>(</td>

  2168.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

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

  2170.         </tr>

  2171.         <tr>

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

  2173.           <td></td>

  2174.           <td class="paramtype">const ExChar_t *&#160;</td>

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

  2176.         </tr>

  2177.         <tr>

  2178.           <td></td>

  2179.           <td>)</td>

  2180.           <td></td><td></td>

  2181.         </tr>

  2182.       </table>

  2183.   </td>

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

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

  2186.   </tr>

  2187. </table>

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

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

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

  2191.   <table class="params">

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

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

  2194.   </table>

  2195.   </dd>

  2196. </dl>

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

  2198. 

  2199. </div>

  2200. </div>

  2201. <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>

  2202. <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">&#9670;&nbsp;</a></span>rewind()</h2>

  2203. 

  2204. <div class="memitem">

  2205. <div class="memproto">

  2206. <table class="mlabels">

  2207.   <tr>

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

  2209.       <table class="memname">

  2210.         <tr>

  2211.           <td class="memname">void ExFatFile::rewind </td>

  2212.           <td>(</td>

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

  2214.           <td></td>

  2215.         </tr>

  2216.       </table>

  2217.   </td>

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

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

  2220.   </tr>

  2221. </table>

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

  2223. <p>Set the file's current position to zero. </p>

  2224. 

  2225. </div>

  2226. </div>

  2227. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  2228. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  2229. 

  2230. <div class="memitem">

  2231. <div class="memproto">

  2232. <table class="mlabels">

  2233.   <tr>

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

  2235.       <table class="memname">

  2236.         <tr>

  2237.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::rewindDirectory </td>

  2238.           <td>(</td>

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

  2240.           <td></td>

  2241.         </tr>

  2242.       </table>

  2243.   </td>

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

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

  2246.   </tr>

  2247. </table>

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

  2249. <p>Rewind a file if it is a directory </p>

  2250. 

  2251. </div>

  2252. </div>

  2253. <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>

  2254. <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">&#9670;&nbsp;</a></span>rmdir()</h2>

  2255. 

  2256. <div class="memitem">

  2257. <div class="memproto">

  2258. <table class="mlabels">

  2259.   <tr>

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

  2261.       <table class="memname">

  2262.         <tr>

  2263.           <td class="memname">bool ExFatFile::rmdir </td>

  2264.           <td>(</td>

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

  2266.           <td></td>

  2267.         </tr>

  2268.       </table>

  2269.   </td>

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

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

  2272.   </tr>

  2273. </table>

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

  2275. <p>Remove a directory file.</p>

  2276. <p>The directory file will be removed only if it is empty and is not the root directory. <a class="el" href="class_ex_fat_file.html#a0165e0fde12a53e419bd92cd37f9cfed">rmdir()</a> follows DOS and Windows and ignores the read-only attribute for the directory.</p>

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

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

  2279. 

  2280. </div>

  2281. </div>

  2282. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  2283. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  2284. 

  2285. <div class="memitem">

  2286. <div class="memproto">

  2287. <table class="mlabels">

  2288.   <tr>

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

  2290.       <table class="memname">

  2291.         <tr>

  2292.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::seek </td>

  2293.           <td>(</td>

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

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

  2296.           <td></td>

  2297.         </tr>

  2298.       </table>

  2299.   </td>

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

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

  2302.   </tr>

  2303. </table>

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

  2305. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

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

  2307.   <table class="params">

  2308.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2309.   </table>

  2310.   </dd>

  2311. </dl>

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

  2313. 

  2314. </div>

  2315. </div>

  2316. <a id="ab42494880cf229adfb0fc8edb0647686"></a>

  2317. <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">&#9670;&nbsp;</a></span>seekCur()</h2>

  2318. 

  2319. <div class="memitem">

  2320. <div class="memproto">

  2321. <table class="mlabels">

  2322.   <tr>

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

  2324.       <table class="memname">

  2325.         <tr>

  2326.           <td class="memname">bool ExFatFile::seekCur </td>

  2327.           <td>(</td>

  2328.           <td class="paramtype">int64_t&#160;</td>

  2329.           <td class="paramname"><em>offset</em></td><td>)</td>

  2330.           <td></td>

  2331.         </tr>

  2332.       </table>

  2333.   </td>

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

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

  2336.   </tr>

  2337. </table>

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

  2339. <p>Set the files position to current position + <em>pos</em>. See <a class="el" href="class_ex_fat_file.html#a9834c4da2f14c66f4bda26938ebb36f6">seekSet()</a>. </p><dl class="params"><dt>Parameters</dt><dd>

  2340.   <table class="params">

  2341.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2342.   </table>

  2343.   </dd>

  2344. </dl>

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

  2346. 

  2347. </div>

  2348. </div>

  2349. <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>

  2350. <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2351. 

  2352. <div class="memitem">

  2353. <div class="memproto">

  2354. <table class="mlabels">

  2355.   <tr>

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

  2357.       <table class="memname">

  2358.         <tr>

  2359.           <td class="memname">bool ExFatFile::seekEnd </td>

  2360.           <td>(</td>

  2361.           <td class="paramtype">int64_t&#160;</td>

  2362.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2363.           <td></td>

  2364.         </tr>

  2365.       </table>

  2366.   </td>

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

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

  2369.   </tr>

  2370. </table>

  2371. </div><div class="memdoc">

  2372. <p>Set the files position to end-of-file + <em>offset</em>. See <a class="el" href="class_ex_fat_file.html#a9834c4da2f14c66f4bda26938ebb36f6">seekSet()</a>. Can't be used for directory files since file size is not defined. </p><dl class="params"><dt>Parameters</dt><dd>

  2373.   <table class="params">

  2374.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2375.   </table>

  2376.   </dd>

  2377. </dl>

  2378. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2379. 

  2380. </div>

  2381. </div>

  2382. <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>

  2383. <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">&#9670;&nbsp;</a></span>seekSet()</h2>

  2384. 

  2385. <div class="memitem">

  2386. <div class="memproto">

  2387. <table class="mlabels">

  2388.   <tr>

  2389.   <td class="mlabels-left">

  2390.       <table class="memname">

  2391.         <tr>

  2392.           <td class="memname">bool ExFatFile::seekSet </td>

  2393.           <td>(</td>

  2394.           <td class="paramtype">uint64_t&#160;</td>

  2395.           <td class="paramname"><em>pos</em></td><td>)</td>

  2396.           <td></td>

  2397.         </tr>

  2398.       </table>

  2399.   </td>

  2400.   <td class="mlabels-right">

  2401. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2402.   </tr>

  2403. </table>

  2404. </div><div class="memdoc">

  2405. <p>Sets a file's position.</p>

  2406. <dl class="params"><dt>Parameters</dt><dd>

  2407.   <table class="params">

  2408.     <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>

  2409.   </table>

  2410.   </dd>

  2411. </dl>

  2412. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2413. 

  2414. </div>

  2415. </div>

  2416. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  2417. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  2418. 

  2419. <div class="memitem">

  2420. <div class="memproto">

  2421. <table class="mlabels">

  2422.   <tr>

  2423.   <td class="mlabels-left">

  2424.       <table class="memname">

  2425.         <tr>

  2426.           <td class="memname">uint64_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::size </td>

  2427.           <td>(</td>

  2428.           <td class="paramname"></td><td>)</td>

  2429.           <td></td>

  2430.         </tr>

  2431.       </table>

  2432.   </td>

  2433.   <td class="mlabels-right">

  2434. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2435.   </tr>

  2436. </table>

  2437. </div><div class="memdoc">

  2438. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  2439. 

  2440. </div>

  2441. </div>

  2442. <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>

  2443. <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">&#9670;&nbsp;</a></span>sync()</h2>

  2444. 

  2445. <div class="memitem">

  2446. <div class="memproto">

  2447. <table class="mlabels">

  2448.   <tr>

  2449.   <td class="mlabels-left">

  2450.       <table class="memname">

  2451.         <tr>

  2452.           <td class="memname">bool ExFatFile::sync </td>

  2453.           <td>(</td>

  2454.           <td class="paramname"></td><td>)</td>

  2455.           <td></td>

  2456.         </tr>

  2457.       </table>

  2458.   </td>

  2459.   <td class="mlabels-right">

  2460. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2461.   </tr>

  2462. </table>

  2463. </div><div class="memdoc">

  2464. <p>The <a class="el" href="class_ex_fat_file.html#a2cb3638069afd2d01b79e5dff1a66f55">sync()</a> call causes all modified data and directory fields to be written to the storage device.</p>

  2465. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2466. 

  2467. </div>

  2468. </div>

  2469. <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>

  2470. <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">&#9670;&nbsp;</a></span>timestamp()</h2>

  2471. 

  2472. <div class="memitem">

  2473. <div class="memproto">

  2474. <table class="mlabels">

  2475.   <tr>

  2476.   <td class="mlabels-left">

  2477.       <table class="memname">

  2478.         <tr>

  2479.           <td class="memname">bool ExFatFile::timestamp </td>

  2480.           <td>(</td>

  2481.           <td class="paramtype">uint8_t&#160;</td>

  2482.           <td class="paramname"><em>flags</em>, </td>

  2483.         </tr>

  2484.         <tr>

  2485.           <td class="paramkey"></td>

  2486.           <td></td>

  2487.           <td class="paramtype">uint16_t&#160;</td>

  2488.           <td class="paramname"><em>year</em>, </td>

  2489.         </tr>

  2490.         <tr>

  2491.           <td class="paramkey"></td>

  2492.           <td></td>

  2493.           <td class="paramtype">uint8_t&#160;</td>

  2494.           <td class="paramname"><em>month</em>, </td>

  2495.         </tr>

  2496.         <tr>

  2497.           <td class="paramkey"></td>

  2498.           <td></td>

  2499.           <td class="paramtype">uint8_t&#160;</td>

  2500.           <td class="paramname"><em>day</em>, </td>

  2501.         </tr>

  2502.         <tr>

  2503.           <td class="paramkey"></td>

  2504.           <td></td>

  2505.           <td class="paramtype">uint8_t&#160;</td>

  2506.           <td class="paramname"><em>hour</em>, </td>

  2507.         </tr>

  2508.         <tr>

  2509.           <td class="paramkey"></td>

  2510.           <td></td>

  2511.           <td class="paramtype">uint8_t&#160;</td>

  2512.           <td class="paramname"><em>minute</em>, </td>

  2513.         </tr>

  2514.         <tr>

  2515.           <td class="paramkey"></td>

  2516.           <td></td>

  2517.           <td class="paramtype">uint8_t&#160;</td>

  2518.           <td class="paramname"><em>second</em>&#160;</td>

  2519.         </tr>

  2520.         <tr>

  2521.           <td></td>

  2522.           <td>)</td>

  2523.           <td></td><td></td>

  2524.         </tr>

  2525.       </table>

  2526.   </td>

  2527.   <td class="mlabels-right">

  2528. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2529.   </tr>

  2530. </table>

  2531. </div><div class="memdoc">

  2532. <p>Truncate a file at the current file position.</p>

  2533. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. Set a file's timestamps in its directory entry.</dd></dl>

  2534. <dl class="params"><dt>Parameters</dt><dd>

  2535.   <table class="params">

  2536.     <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>

  2537.   </table>

  2538.   </dd>

  2539. </dl>

  2540. <p>T_ACCESS - Set the file's last access date.</p>

  2541. <p>T_CREATE - Set the file's creation date and time.</p>

  2542. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2543. <dl class="params"><dt>Parameters</dt><dd>

  2544.   <table class="params">

  2545.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2546.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2547.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2548.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2549.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2550.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2551.   </table>

  2552.   </dd>

  2553. </dl>

  2554. <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>

  2555. <dd>

  2556. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2557. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2558. 

  2559. </div>

  2560. </div>

  2561. <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>

  2562. <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2563. 

  2564. <div class="memitem">

  2565. <div class="memproto">

  2566. <table class="mlabels">

  2567.   <tr>

  2568.   <td class="mlabels-left">

  2569.       <table class="memname">

  2570.         <tr>

  2571.           <td class="memname">bool ExFatFile::truncate </td>

  2572.           <td>(</td>

  2573.           <td class="paramname"></td><td>)</td>

  2574.           <td></td>

  2575.         </tr>

  2576.       </table>

  2577.   </td>

  2578.   <td class="mlabels-right">

  2579. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2580.   </tr>

  2581. </table>

  2582. </div><div class="memdoc">

  2583. <p>Truncate a file at the current file position. will be maintained if it is less than or equal to <em>length</em> otherwise it will be set to end of file.</p>

  2584. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2585. 

  2586. </div>

  2587. </div>

  2588. <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>

  2589. <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2590. 

  2591. <div class="memitem">

  2592. <div class="memproto">

  2593. <table class="mlabels">

  2594.   <tr>

  2595.   <td class="mlabels-left">

  2596.       <table class="memname">

  2597.         <tr>

  2598.           <td class="memname">bool ExFatFile::truncate </td>

  2599.           <td>(</td>

  2600.           <td class="paramtype">uint64_t&#160;</td>

  2601.           <td class="paramname"><em>length</em></td><td>)</td>

  2602.           <td></td>

  2603.         </tr>

  2604.       </table>

  2605.   </td>

  2606.   <td class="mlabels-right">

  2607. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2608.   </tr>

  2609. </table>

  2610. </div><div class="memdoc">

  2611. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2612. <dl class="params"><dt>Parameters</dt><dd>

  2613.   <table class="params">

  2614.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2615.   </table>

  2616.   </dd>

  2617. </dl>

  2618. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2619. 

  2620. </div>

  2621. </div>

  2622. <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>

  2623. <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">&#9670;&nbsp;</a></span>validLength()</h2>

  2624. 

  2625. <div class="memitem">

  2626. <div class="memproto">

  2627. <table class="mlabels">

  2628.   <tr>

  2629.   <td class="mlabels-left">

  2630.       <table class="memname">

  2631.         <tr>

  2632.           <td class="memname">uint64_t ExFatFile::validLength </td>

  2633.           <td>(</td>

  2634.           <td class="paramname"></td><td>)</td>

  2635.           <td></td>

  2636.         </tr>

  2637.       </table>

  2638.   </td>

  2639.   <td class="mlabels-right">

  2640. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2641.   </tr>

  2642. </table>

  2643. </div><div class="memdoc">

  2644. <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>

  2645. 

  2646. </div>

  2647. </div>

  2648. <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>

  2649. <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>

  2650. 

  2651. <div class="memitem">

  2652. <div class="memproto">

  2653. <table class="mlabels">

  2654.   <tr>

  2655.   <td class="mlabels-left">

  2656.       <table class="memname">

  2657.         <tr>

  2658.           <td class="memname">size_t ExFatFile::write </td>

  2659.           <td>(</td>

  2660.           <td class="paramtype">const char *&#160;</td>

  2661.           <td class="paramname"><em>str</em></td><td>)</td>

  2662.           <td></td>

  2663.         </tr>

  2664.       </table>

  2665.   </td>

  2666.   <td class="mlabels-right">

  2667. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2668.   </tr>

  2669. </table>

  2670. </div><div class="memdoc">

  2671. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2672.   <table class="params">

  2673.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2674.   </table>

  2675.   </dd>

  2676. </dl>

  2677. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2678. 

  2679. </div>

  2680. </div>

  2681. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  2682. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>

  2683. 

  2684. <div class="memitem">

  2685. <div class="memproto">

  2686. <table class="mlabels">

  2687.   <tr>

  2688.   <td class="mlabels-left">

  2689.       <table class="memname">

  2690.         <tr>

  2691.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::write </td>

  2692.           <td>(</td>

  2693.           <td class="paramtype">const uint8_t *&#160;</td>

  2694.           <td class="paramname"><em>buffer</em>, </td>

  2695.         </tr>

  2696.         <tr>

  2697.           <td class="paramkey"></td>

  2698.           <td></td>

  2699.           <td class="paramtype">size_t&#160;</td>

  2700.           <td class="paramname"><em>size</em>&#160;</td>

  2701.         </tr>

  2702.         <tr>

  2703.           <td></td>

  2704.           <td>)</td>

  2705.           <td></td><td></td>

  2706.         </tr>

  2707.       </table>

  2708.   </td>

  2709.   <td class="mlabels-right">

  2710. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2711.   </tr>

  2712. </table>

  2713. </div><div class="memdoc">

  2714. <p>Write data to an open file.</p>

  2715. <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_ex_fat_file.html#a2cb3638069afd2d01b79e5dff1a66f55">sync()</a> is called.</dd></dl>

  2716. <dl class="params"><dt>Parameters</dt><dd>

  2717.   <table class="params">

  2718.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  2719.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  2720.   </table>

  2721.   </dd>

  2722. </dl>

  2723. <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>

  2724. 

  2725. </div>

  2726. </div>

  2727. <a id="abc1423c7b550614d1067e7173f8b46a8"></a>

  2728. <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>

  2729. 

  2730. <div class="memitem">

  2731. <div class="memproto">

  2732. <table class="mlabels">

  2733.   <tr>

  2734.   <td class="mlabels-left">

  2735.       <table class="memname">

  2736.         <tr>

  2737.           <td class="memname">size_t ExFatFile::write </td>

  2738.           <td>(</td>

  2739.           <td class="paramtype">const void *&#160;</td>

  2740.           <td class="paramname"><em>buf</em>, </td>

  2741.         </tr>

  2742.         <tr>

  2743.           <td class="paramkey"></td>

  2744.           <td></td>

  2745.           <td class="paramtype">size_t&#160;</td>

  2746.           <td class="paramname"><em>count</em>&#160;</td>

  2747.         </tr>

  2748.         <tr>

  2749.           <td></td>

  2750.           <td>)</td>

  2751.           <td></td><td></td>

  2752.         </tr>

  2753.       </table>

  2754.   </td>

  2755.   <td class="mlabels-right">

  2756. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2757.   </tr>

  2758. </table>

  2759. </div><div class="memdoc">

  2760. <p>Write data to an open file.</p>

  2761. <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_ex_fat_file.html#a2cb3638069afd2d01b79e5dff1a66f55">sync()</a> is called.</dd></dl>

  2762. <dl class="params"><dt>Parameters</dt><dd>

  2763.   <table class="params">

  2764.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2765.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2766.   </table>

  2767.   </dd>

  2768. </dl>

  2769. <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>count</em>. </dd></dl>

  2770. 

  2771. </div>

  2772. </div>

  2773. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  2774. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>

  2775. 

  2776. <div class="memitem">

  2777. <div class="memproto">

  2778. <table class="mlabels">

  2779.   <tr>

  2780.   <td class="mlabels-left">

  2781.       <table class="memname">

  2782.         <tr>

  2783.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t  &gt;::write </td>

  2784.           <td>(</td>

  2785.           <td class="paramtype">uint8_t&#160;</td>

  2786.           <td class="paramname"><em>b</em></td><td>)</td>

  2787.           <td></td>

  2788.         </tr>

  2789.       </table>

  2790.   </td>

  2791.   <td class="mlabels-right">

  2792. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2793.   </tr>

  2794. </table>

  2795. </div><div class="memdoc">

  2796. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2797.   <table class="params">

  2798.     <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>

  2799.   </table>

  2800.   </dd>

  2801. </dl>

  2802. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  2803. 

  2804. </div>

  2805. </div>

  2806. <hr/>The documentation for this class was generated from the following file:<ul>

  2807. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>

  2808. </ul>

  2809. </div><!-- contents -->

  2810. <!-- start footer part -->

  2811. <hr class="footer"/><address class="footer"><small>

  2812. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2813. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2814. </a> 1.8.16

  2815. </small></address>

  2816. </body>

  2817. </html>