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.

2814 satır
125KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: 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.14 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="class_ex_file-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">ExFile Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>exFAT file with Arduino Stream.
  70. <a href="class_ex_file.html#details">More...</a></p>
  71. <p><code>#include &lt;ExFatFile.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for ExFile:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_ex_file__inherit__graph.png" border="0" usemap="#_ex_file_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_ex_file_inherit__map" id="_ex_file_inherit__map">
  77. <area shape="rect" id="node2" href="class_stream_file.html" title="StreamFile\&lt; ExFatFile,\l uint64_t \&gt;" alt="" coords="13,80,170,121"/>
  78. <area shape="rect" id="node4" href="class_ex_fat_file.html" title="Basic file class. " alt="" coords="103,5,181,32"/>
  79. </map>
  80. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  81. <div class="dynheader">
  82. Collaboration diagram for ExFile:</div>
  83. <div class="dyncontent">
  84. <div class="center"><img src="class_ex_file__coll__graph.png" border="0" usemap="#_ex_file_coll__map" alt="Collaboration graph"/></div>
  85. <map name="_ex_file_coll__map" id="_ex_file_coll__map">
  86. <area shape="rect" id="node2" href="class_stream_file.html" title="StreamFile\&lt; ExFatFile,\l uint64_t \&gt;" alt="" coords="13,80,170,121"/>
  87. <area shape="rect" id="node4" href="class_ex_fat_file.html" title="Basic file class. " alt="" coords="103,5,181,32"/>
  88. </map>
  89. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  92. Public Member Functions</h2></td></tr>
  93. <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>
  94. <tr class="separator:a0112cc39b64aac6f1ec47741397a7582"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:adcf47e15b819fe2d6faac2a027ab30f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:ac2004e7bf328b3edda7d4c3acba2726f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:abc0d3863895c17df53930bdfa84cb06f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:a7ba9e04099bdf8fd34220ebfdde72867"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:ab49396aad3f6500aa19f75490dc26719"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:ada4dde9f2eed36bf556fcf1bd3d28ccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:a5e3baa5d5269c2948cfaf604c42f6a16"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a22a717ddc6d2004c540c67a14264d9dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:a8614bcbf04b7bbfc70fe36d2fa7f70c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:abc69c9dfc8fdb4ebf9db3bc37c879dc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:af2c08909b62b01f3edc4ee0c51ea7435"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a32f813e659414892a58aa5157fe14f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:aea1e4d0c0981081774dc3c7cd3c55264"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:ac697224450ca216c60585d25f5f6e310"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:aba93e2c18be9fa4df7e067b7d6ac5906"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a01da9896a59671a61f90dd20c3ac5d07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a7a167102bd47b7cf91167b69f8cc57d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:ad0a3687bd95bed5b216651335e66b500"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a586ad44055eca4c1b2b457299b829d44"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a586ad44055eca4c1b2b457299b829d44">isDirectory</a> ()</td></tr>
  132. <tr class="separator:a586ad44055eca4c1b2b457299b829d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem: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>
  134. <tr class="separator:af601285f95db8398c140b3927cf9111c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:ac926285fa4321ebee28fa91beb511eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a804c34bbe3ebefe2b6c1d77ff8d49a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a9ca137dfba2c7772910f4d2b3fdd9411"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a14d160bfbfb39717746b93fa2eda5739"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:ad9f8e7afcf749ebcaaf055bd569dc7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:ad7e02a1db8fb5a90288bb4679e9ddcb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:a04d1c43e80743f8c1a51b64062ce16dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  150. <tr class="separator:aa0e074c891f3db5ea2ebd491667b03a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags, uint8_t indent=0)</td></tr>
  152. <tr class="separator:a09f8beb55f939874e93c1df6c8a046d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <tr class="separator:a3a393624d52854e74bf385c9e513a86d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <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>
  156. <tr class="separator:a8792c863080576eb65ce6cacbe1dd931"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <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>
  158. <tr class="separator:ad0be05c5c7092317089872778052cbd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <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>
  160. <tr class="separator:a825447643e6c9e8284a3ed78e3363788"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <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>
  162. <tr class="separator:a414b64dc30551e05dcc46f04e0f6413a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <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>
  164. <tr class="separator:ab1e224aba9eb796c7ad48062cc1434c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <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>
  166. <tr class="separator:a89b6021cf70b7adb9feb162260d5a101"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:ada8cd27e9a2f604f5c05088024a46a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <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>
  170. <tr class="separator:af664c1da1bfa0bb5f6eb933bc25f757e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <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>
  172. <tr class="separator:aa1abbd813f27d488f0ff439ccbc9ca98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <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>
  174. <tr class="separator:af0da96e502485133ca0cff27fa130082"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <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>
  176. <tr class="separator:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <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>
  178. <tr class="separator:a35a5093014e80965e49c84b61780556f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  180. <tr class="separator:ad9ba8aa00b9db683d40fc2989dbe1922"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  182. <tr class="separator:a7318b2d7594d6ba52421c413f5fc35cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <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>
  184. <tr class="separator:a496ac61e367a24665425d54956a46346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <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>
  186. <tr class="separator:a70eda4191df90f608694c1faede7fb33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a9759c13e804c01ff9e7e2ac8fbabc5b8"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  188. <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>
  189. <tr class="separator:a9759c13e804c01ff9e7e2ac8fbabc5b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  191. <tr class="separator:a16d527f98cff3ffd3ba8bc594a22d186"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  193. <tr class="separator:a16488d3e0d946f108240b7d6c536c6f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  195. <tr class="separator:a095c0a865e5e5b6463c3dc0c90680635"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <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>
  197. <tr class="separator:a249a5d428f303e2a8e7c3ae476e74829"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <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>
  199. <tr class="separator:a5ae5477efe55179cf07e173c62654313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <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>
  201. <tr class="separator:a8e88c8e79551a72cc98310038514c47a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <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>
  203. <tr class="separator:ad10417a851dba3d40a78eb2c0eb11fff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <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>
  205. <tr class="separator:aab50b2646035f76834c75230d2b55c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <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>
  207. <tr class="separator:aea570a3b6afbe633d874803b137a46b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <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>
  209. <tr class="separator:a3c1d3ef65284ffb13ed3ceee472adf9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <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>
  211. <tr class="separator:a91e8cfbde27d6879b4f51d2ceb2a9f06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <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>
  213. <tr class="separator:a0165e0fde12a53e419bd92cd37f9cfed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <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>
  215. <tr class="separator:a773ee6f661fc689a5187f51cb5498086"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <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>
  217. <tr class="separator:ab42494880cf229adfb0fc8edb0647686"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <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>
  219. <tr class="separator:a2994a71751ed4f137f48b2e9a7d94091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <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>
  221. <tr class="separator:a9834c4da2f14c66f4bda26938ebb36f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <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>
  223. <tr class="separator:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  224. <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>
  225. <tr class="separator:a2cb3638069afd2d01b79e5dff1a66f55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <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>
  227. <tr class="separator:a6d3ab10983e206401ebd5c24a1c46174"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <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>
  229. <tr class="separator:aca37955d3c7cce40f7f9e1ea078e5636"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. <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>
  231. <tr class="separator:a6262b0d6d43d2a426953a0a7d90f624f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <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>
  233. <tr class="separator:afc8af11ba8e3a830dff1dd5e59446243"><td class="memSeparator" colspan="2">&#160;</td></tr>
  234. <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>
  235. <tr class="separator:a0695220134825199b39dee82f18ab1ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  236. <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>
  237. <tr class="separator:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  238. <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>
  239. <tr class="separator:a6fb2905a5e363554a5118b5d1322cd87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  240. <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>
  241. <tr class="separator:abc1423c7b550614d1067e7173f8b46a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. </table>
  243. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  244. <div class="textblock"><p>exFAT file with Arduino Stream. </p>
  245. </div><h2 class="groupheader">Member Function Documentation</h2>
  246. <a id="a0112cc39b64aac6f1ec47741397a7582"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#a0112cc39b64aac6f1ec47741397a7582">&#9670;&nbsp;</a></span>available()</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="mlabels">
  251. <tr>
  252. <td class="mlabels-left">
  253. <table class="memname">
  254. <tr>
  255. <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>
  256. <td>(</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </td>
  262. <td class="mlabels-right">
  263. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <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>
  268. </div>
  269. </div>
  270. <a id="adcf47e15b819fe2d6faac2a027ab30f5"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#adcf47e15b819fe2d6faac2a027ab30f5">&#9670;&nbsp;</a></span>available64()</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">uint64_t ExFatFile::available64 </td>
  280. <td>(</td>
  281. <td class="paramname"></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </td>
  286. <td class="mlabels-right">
  287. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <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>
  292. </div>
  293. </div>
  294. <a id="ac2004e7bf328b3edda7d4c3acba2726f"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#ac2004e7bf328b3edda7d4c3acba2726f">&#9670;&nbsp;</a></span>clearError()</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="mlabels">
  299. <tr>
  300. <td class="mlabels-left">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname">void ExFatFile::clearError </td>
  304. <td>(</td>
  305. <td class="paramname"></td><td>)</td>
  306. <td></td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Clear all error bits. </p>
  316. </div>
  317. </div>
  318. <a id="abc0d3863895c17df53930bdfa84cb06f"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#abc0d3863895c17df53930bdfa84cb06f">&#9670;&nbsp;</a></span>clearWriteError()</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="mlabels">
  323. <tr>
  324. <td class="mlabels-left">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">void ExFatFile::clearWriteError </td>
  328. <td>(</td>
  329. <td class="paramname"></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Set writeError to zero </p>
  340. </div>
  341. </div>
  342. <a id="a7ba9e04099bdf8fd34220ebfdde72867"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#a7ba9e04099bdf8fd34220ebfdde72867">&#9670;&nbsp;</a></span>close()</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="mlabels">
  347. <tr>
  348. <td class="mlabels-left">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">bool ExFatFile::close </td>
  352. <td>(</td>
  353. <td class="paramname"></td><td>)</td>
  354. <td></td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Close a file and force cached data and directory information to be written to the storage device.</p>
  364. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  365. </div>
  366. </div>
  367. <a id="ab49396aad3f6500aa19f75490dc26719"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#ab49396aad3f6500aa19f75490dc26719">&#9670;&nbsp;</a></span>curPosition()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">uint64_t ExFatFile::curPosition </td>
  377. <td>(</td>
  378. <td class="paramname"></td><td>)</td>
  379. <td> const</td>
  380. </tr>
  381. </table>
  382. </td>
  383. <td class="mlabels-right">
  384. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>
  389. </div>
  390. </div>
  391. <a id="ada4dde9f2eed36bf556fcf1bd3d28ccf"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#ada4dde9f2eed36bf556fcf1bd3d28ccf">&#9670;&nbsp;</a></span>dataLength()</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">uint64_t ExFatFile::dataLength </td>
  401. <td>(</td>
  402. <td class="paramname"></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <dl class="section return"><dt>Returns</dt><dd>Total data length for file. </dd></dl>
  413. </div>
  414. </div>
  415. <a id="a5e3baa5d5269c2948cfaf604c42f6a16"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a5e3baa5d5269c2948cfaf604c42f6a16">&#9670;&nbsp;</a></span>dirIndex()</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">uint32_t ExFatFile::dirIndex </td>
  425. <td>(</td>
  426. <td class="paramname"></td><td>)</td>
  427. <td></td>
  428. </tr>
  429. </table>
  430. </td>
  431. <td class="mlabels-right">
  432. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>
  437. </div>
  438. </div>
  439. <a id="a22a717ddc6d2004c540c67a14264d9dd"></a>
  440. <h2 class="memtitle"><span class="permalink"><a href="#a22a717ddc6d2004c540c67a14264d9dd">&#9670;&nbsp;</a></span>exists()</h2>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="mlabels">
  444. <tr>
  445. <td class="mlabels-left">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">bool ExFatFile::exists </td>
  449. <td>(</td>
  450. <td class="paramtype">const ExChar_t *&#160;</td>
  451. <td class="paramname"><em>path</em></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </td>
  456. <td class="mlabels-right">
  457. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Test for the existence of a file in a directory</p>
  462. <dl class="params"><dt>Parameters</dt><dd>
  463. <table class="params">
  464. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. <p>The calling instance must be an open directory file.</p>
  469. <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>
  470. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  471. </div>
  472. </div>
  473. <a id="a8614bcbf04b7bbfc70fe36d2fa7f70c1"></a>
  474. <h2 class="memtitle"><span class="permalink"><a href="#a8614bcbf04b7bbfc70fe36d2fa7f70c1">&#9670;&nbsp;</a></span>fgetpos()</h2>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="mlabels">
  478. <tr>
  479. <td class="mlabels-left">
  480. <table class="memname">
  481. <tr>
  482. <td class="memname">void ExFatFile::fgetpos </td>
  483. <td>(</td>
  484. <td class="paramtype">fspos_t *&#160;</td>
  485. <td class="paramname"><em>pos</em></td><td>)</td>
  486. <td></td>
  487. </tr>
  488. </table>
  489. </td>
  490. <td class="mlabels-right">
  491. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  496. <table class="params">
  497. <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>
  498. </table>
  499. </dd>
  500. </dl>
  501. </div>
  502. </div>
  503. <a id="abc69c9dfc8fdb4ebf9db3bc37c879dc6"></a>
  504. <h2 class="memtitle"><span class="permalink"><a href="#abc69c9dfc8fdb4ebf9db3bc37c879dc6">&#9670;&nbsp;</a></span>fgets()</h2>
  505. <div class="memitem">
  506. <div class="memproto">
  507. <table class="mlabels">
  508. <tr>
  509. <td class="mlabels-left">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname">int ExFatFile::fgets </td>
  513. <td>(</td>
  514. <td class="paramtype">char *&#160;</td>
  515. <td class="paramname"><em>str</em>, </td>
  516. </tr>
  517. <tr>
  518. <td class="paramkey"></td>
  519. <td></td>
  520. <td class="paramtype">int&#160;</td>
  521. <td class="paramname"><em>num</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">char *&#160;</td>
  527. <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code>&#160;</td>
  528. </tr>
  529. <tr>
  530. <td></td>
  531. <td>)</td>
  532. <td></td><td></td>
  533. </tr>
  534. </table>
  535. </td>
  536. <td class="mlabels-right">
  537. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Get a string from a file.</p>
  542. <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>
  543. <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>
  544. <dl class="params"><dt>Parameters</dt><dd>
  545. <table class="params">
  546. <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>
  547. <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>
  548. <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>
  549. </table>
  550. </dd>
  551. </dl>
  552. <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>
  553. </div>
  554. </div>
  555. <a id="af2c08909b62b01f3edc4ee0c51ea7435"></a>
  556. <h2 class="memtitle"><span class="permalink"><a href="#af2c08909b62b01f3edc4ee0c51ea7435">&#9670;&nbsp;</a></span>fileSize()</h2>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="mlabels">
  560. <tr>
  561. <td class="mlabels-left">
  562. <table class="memname">
  563. <tr>
  564. <td class="memname">uint64_t ExFatFile::fileSize </td>
  565. <td>(</td>
  566. <td class="paramname"></td><td>)</td>
  567. <td></td>
  568. </tr>
  569. </table>
  570. </td>
  571. <td class="mlabels-right">
  572. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  573. </tr>
  574. </table>
  575. </div><div class="memdoc">
  576. <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>
  577. </div>
  578. </div>
  579. <a id="a32f813e659414892a58aa5157fe14f82"></a>
  580. <h2 class="memtitle"><span class="permalink"><a href="#a32f813e659414892a58aa5157fe14f82">&#9670;&nbsp;</a></span>flush()</h2>
  581. <div class="memitem">
  582. <div class="memproto">
  583. <table class="mlabels">
  584. <tr>
  585. <td class="mlabels-left">
  586. <table class="memname">
  587. <tr>
  588. <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>
  589. <td>(</td>
  590. <td class="paramname"></td><td>)</td>
  591. <td></td>
  592. </tr>
  593. </table>
  594. </td>
  595. <td class="mlabels-right">
  596. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  597. </tr>
  598. </table>
  599. </div><div class="memdoc">
  600. <p>Ensure that any bytes written to the file are saved to the SD card. </p>
  601. </div>
  602. </div>
  603. <a id="aea1e4d0c0981081774dc3c7cd3c55264"></a>
  604. <h2 class="memtitle"><span class="permalink"><a href="#aea1e4d0c0981081774dc3c7cd3c55264">&#9670;&nbsp;</a></span>fsetpos()</h2>
  605. <div class="memitem">
  606. <div class="memproto">
  607. <table class="mlabels">
  608. <tr>
  609. <td class="mlabels-left">
  610. <table class="memname">
  611. <tr>
  612. <td class="memname">void ExFatFile::fsetpos </td>
  613. <td>(</td>
  614. <td class="paramtype">const fspos_t *&#160;</td>
  615. <td class="paramname"><em>pos</em></td><td>)</td>
  616. <td></td>
  617. </tr>
  618. </table>
  619. </td>
  620. <td class="mlabels-right">
  621. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  626. <table class="params">
  627. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>
  628. </table>
  629. </dd>
  630. </dl>
  631. </div>
  632. </div>
  633. <a id="ac697224450ca216c60585d25f5f6e310"></a>
  634. <h2 class="memtitle"><span class="permalink"><a href="#ac697224450ca216c60585d25f5f6e310">&#9670;&nbsp;</a></span>getError()</h2>
  635. <div class="memitem">
  636. <div class="memproto">
  637. <table class="mlabels">
  638. <tr>
  639. <td class="mlabels-left">
  640. <table class="memname">
  641. <tr>
  642. <td class="memname">uint8_t ExFatFile::getError </td>
  643. <td>(</td>
  644. <td class="paramname"></td><td>)</td>
  645. <td></td>
  646. </tr>
  647. </table>
  648. </td>
  649. <td class="mlabels-right">
  650. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  651. </tr>
  652. </table>
  653. </div><div class="memdoc">
  654. <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>
  655. </div>
  656. </div>
  657. <a id="aba93e2c18be9fa4df7e067b7d6ac5906"></a>
  658. <h2 class="memtitle"><span class="permalink"><a href="#aba93e2c18be9fa4df7e067b7d6ac5906">&#9670;&nbsp;</a></span>getName()</h2>
  659. <div class="memitem">
  660. <div class="memproto">
  661. <table class="mlabels">
  662. <tr>
  663. <td class="mlabels-left">
  664. <table class="memname">
  665. <tr>
  666. <td class="memname">size_t ExFatFile::getName </td>
  667. <td>(</td>
  668. <td class="paramtype">ExChar_t *&#160;</td>
  669. <td class="paramname"><em>name</em>, </td>
  670. </tr>
  671. <tr>
  672. <td class="paramkey"></td>
  673. <td></td>
  674. <td class="paramtype">size_t&#160;</td>
  675. <td class="paramname"><em>size</em>&#160;</td>
  676. </tr>
  677. <tr>
  678. <td></td>
  679. <td>)</td>
  680. <td></td><td></td>
  681. </tr>
  682. </table>
  683. </td>
  684. <td class="mlabels-right">
  685. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  686. </tr>
  687. </table>
  688. </div><div class="memdoc">
  689. <p>Get a file's name followed by a zero byte.</p>
  690. <dl class="params"><dt>Parameters</dt><dd>
  691. <table class="params">
  692. <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>
  693. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in characters. </td></tr>
  694. </table>
  695. </dd>
  696. </dl>
  697. <dl class="section return"><dt>Returns</dt><dd>the name length. </dd></dl>
  698. </div>
  699. </div>
  700. <a id="a01da9896a59671a61f90dd20c3ac5d07"></a>
  701. <h2 class="memtitle"><span class="permalink"><a href="#a01da9896a59671a61f90dd20c3ac5d07">&#9670;&nbsp;</a></span>getWriteError()</h2>
  702. <div class="memitem">
  703. <div class="memproto">
  704. <table class="mlabels">
  705. <tr>
  706. <td class="mlabels-left">
  707. <table class="memname">
  708. <tr>
  709. <td class="memname">bool ExFatFile::getWriteError </td>
  710. <td>(</td>
  711. <td class="paramname"></td><td>)</td>
  712. <td></td>
  713. </tr>
  714. </table>
  715. </td>
  716. <td class="mlabels-right">
  717. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>
  722. </div>
  723. </div>
  724. <a id="a7a167102bd47b7cf91167b69f8cc57d1"></a>
  725. <h2 class="memtitle"><span class="permalink"><a href="#a7a167102bd47b7cf91167b69f8cc57d1">&#9670;&nbsp;</a></span>isContiguous()</h2>
  726. <div class="memitem">
  727. <div class="memproto">
  728. <table class="mlabels">
  729. <tr>
  730. <td class="mlabels-left">
  731. <table class="memname">
  732. <tr>
  733. <td class="memname">bool ExFatFile::isContiguous </td>
  734. <td>(</td>
  735. <td class="paramname"></td><td>)</td>
  736. <td> const</td>
  737. </tr>
  738. </table>
  739. </td>
  740. <td class="mlabels-right">
  741. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  742. </tr>
  743. </table>
  744. </div><div class="memdoc">
  745. <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>
  746. </div>
  747. </div>
  748. <a id="ad0a3687bd95bed5b216651335e66b500"></a>
  749. <h2 class="memtitle"><span class="permalink"><a href="#ad0a3687bd95bed5b216651335e66b500">&#9670;&nbsp;</a></span>isDir()</h2>
  750. <div class="memitem">
  751. <div class="memproto">
  752. <table class="mlabels">
  753. <tr>
  754. <td class="mlabels-left">
  755. <table class="memname">
  756. <tr>
  757. <td class="memname">bool ExFatFile::isDir </td>
  758. <td>(</td>
  759. <td class="paramname"></td><td>)</td>
  760. <td> const</td>
  761. </tr>
  762. </table>
  763. </td>
  764. <td class="mlabels-right">
  765. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  766. </tr>
  767. </table>
  768. </div><div class="memdoc">
  769. <dl class="section return"><dt>Returns</dt><dd>True if this is a directory. </dd></dl>
  770. </div>
  771. </div>
  772. <a id="a586ad44055eca4c1b2b457299b829d44"></a>
  773. <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">&#9670;&nbsp;</a></span>isDirectory()</h2>
  774. <div class="memitem">
  775. <div class="memproto">
  776. <table class="mlabels">
  777. <tr>
  778. <td class="mlabels-left">
  779. <table class="memname">
  780. <tr>
  781. <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>
  782. <td>(</td>
  783. <td class="paramname"></td><td>)</td>
  784. <td></td>
  785. </tr>
  786. </table>
  787. </td>
  788. <td class="mlabels-right">
  789. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  790. </tr>
  791. </table>
  792. </div><div class="memdoc">
  793. <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>
  794. </div>
  795. </div>
  796. <a id="af601285f95db8398c140b3927cf9111c"></a>
  797. <h2 class="memtitle"><span class="permalink"><a href="#af601285f95db8398c140b3927cf9111c">&#9670;&nbsp;</a></span>isFile()</h2>
  798. <div class="memitem">
  799. <div class="memproto">
  800. <table class="mlabels">
  801. <tr>
  802. <td class="mlabels-left">
  803. <table class="memname">
  804. <tr>
  805. <td class="memname">bool ExFatFile::isFile </td>
  806. <td>(</td>
  807. <td class="paramname"></td><td>)</td>
  808. <td> const</td>
  809. </tr>
  810. </table>
  811. </td>
  812. <td class="mlabels-right">
  813. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file. </dd></dl>
  818. </div>
  819. </div>
  820. <a id="ac926285fa4321ebee28fa91beb511eae"></a>
  821. <h2 class="memtitle"><span class="permalink"><a href="#ac926285fa4321ebee28fa91beb511eae">&#9670;&nbsp;</a></span>isHidden()</h2>
  822. <div class="memitem">
  823. <div class="memproto">
  824. <table class="mlabels">
  825. <tr>
  826. <td class="mlabels-left">
  827. <table class="memname">
  828. <tr>
  829. <td class="memname">bool ExFatFile::isHidden </td>
  830. <td>(</td>
  831. <td class="paramname"></td><td>)</td>
  832. <td> const</td>
  833. </tr>
  834. </table>
  835. </td>
  836. <td class="mlabels-right">
  837. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  838. </tr>
  839. </table>
  840. </div><div class="memdoc">
  841. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden. </dd></dl>
  842. </div>
  843. </div>
  844. <a id="a804c34bbe3ebefe2b6c1d77ff8d49a35"></a>
  845. <h2 class="memtitle"><span class="permalink"><a href="#a804c34bbe3ebefe2b6c1d77ff8d49a35">&#9670;&nbsp;</a></span>isOpen()</h2>
  846. <div class="memitem">
  847. <div class="memproto">
  848. <table class="mlabels">
  849. <tr>
  850. <td class="mlabels-left">
  851. <table class="memname">
  852. <tr>
  853. <td class="memname">bool ExFatFile::isOpen </td>
  854. <td>(</td>
  855. <td class="paramname"></td><td>)</td>
  856. <td> const</td>
  857. </tr>
  858. </table>
  859. </td>
  860. <td class="mlabels-right">
  861. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  862. </tr>
  863. </table>
  864. </div><div class="memdoc">
  865. <dl class="section return"><dt>Returns</dt><dd>true if the file is open. </dd></dl>
  866. </div>
  867. </div>
  868. <a id="a9ca137dfba2c7772910f4d2b3fdd9411"></a>
  869. <h2 class="memtitle"><span class="permalink"><a href="#a9ca137dfba2c7772910f4d2b3fdd9411">&#9670;&nbsp;</a></span>isReadable()</h2>
  870. <div class="memitem">
  871. <div class="memproto">
  872. <table class="mlabels">
  873. <tr>
  874. <td class="mlabels-left">
  875. <table class="memname">
  876. <tr>
  877. <td class="memname">bool ExFatFile::isReadable </td>
  878. <td>(</td>
  879. <td class="paramname"></td><td>)</td>
  880. <td> const</td>
  881. </tr>
  882. </table>
  883. </td>
  884. <td class="mlabels-right">
  885. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  886. </tr>
  887. </table>
  888. </div><div class="memdoc">
  889. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  890. </div>
  891. </div>
  892. <a id="a14d160bfbfb39717746b93fa2eda5739"></a>
  893. <h2 class="memtitle"><span class="permalink"><a href="#a14d160bfbfb39717746b93fa2eda5739">&#9670;&nbsp;</a></span>isReadOnly()</h2>
  894. <div class="memitem">
  895. <div class="memproto">
  896. <table class="mlabels">
  897. <tr>
  898. <td class="mlabels-left">
  899. <table class="memname">
  900. <tr>
  901. <td class="memname">bool ExFatFile::isReadOnly </td>
  902. <td>(</td>
  903. <td class="paramname"></td><td>)</td>
  904. <td> const</td>
  905. </tr>
  906. </table>
  907. </td>
  908. <td class="mlabels-right">
  909. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  910. </tr>
  911. </table>
  912. </div><div class="memdoc">
  913. <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>
  914. </div>
  915. </div>
  916. <a id="ad9f8e7afcf749ebcaaf055bd569dc7da"></a>
  917. <h2 class="memtitle"><span class="permalink"><a href="#ad9f8e7afcf749ebcaaf055bd569dc7da">&#9670;&nbsp;</a></span>isRoot()</h2>
  918. <div class="memitem">
  919. <div class="memproto">
  920. <table class="mlabels">
  921. <tr>
  922. <td class="mlabels-left">
  923. <table class="memname">
  924. <tr>
  925. <td class="memname">bool ExFatFile::isRoot </td>
  926. <td>(</td>
  927. <td class="paramname"></td><td>)</td>
  928. <td> const</td>
  929. </tr>
  930. </table>
  931. </td>
  932. <td class="mlabels-right">
  933. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  934. </tr>
  935. </table>
  936. </div><div class="memdoc">
  937. <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>
  938. </div>
  939. </div>
  940. <a id="ad7e02a1db8fb5a90288bb4679e9ddcb9"></a>
  941. <h2 class="memtitle"><span class="permalink"><a href="#ad7e02a1db8fb5a90288bb4679e9ddcb9">&#9670;&nbsp;</a></span>isSubDir()</h2>
  942. <div class="memitem">
  943. <div class="memproto">
  944. <table class="mlabels">
  945. <tr>
  946. <td class="mlabels-left">
  947. <table class="memname">
  948. <tr>
  949. <td class="memname">bool ExFatFile::isSubDir </td>
  950. <td>(</td>
  951. <td class="paramname"></td><td>)</td>
  952. <td> const</td>
  953. </tr>
  954. </table>
  955. </td>
  956. <td class="mlabels-right">
  957. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  958. </tr>
  959. </table>
  960. </div><div class="memdoc">
  961. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory. </dd></dl>
  962. </div>
  963. </div>
  964. <a id="a04d1c43e80743f8c1a51b64062ce16dd"></a>
  965. <h2 class="memtitle"><span class="permalink"><a href="#a04d1c43e80743f8c1a51b64062ce16dd">&#9670;&nbsp;</a></span>isWritable()</h2>
  966. <div class="memitem">
  967. <div class="memproto">
  968. <table class="mlabels">
  969. <tr>
  970. <td class="mlabels-left">
  971. <table class="memname">
  972. <tr>
  973. <td class="memname">bool ExFatFile::isWritable </td>
  974. <td>(</td>
  975. <td class="paramname"></td><td>)</td>
  976. <td> const</td>
  977. </tr>
  978. </table>
  979. </td>
  980. <td class="mlabels-right">
  981. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  982. </tr>
  983. </table>
  984. </div><div class="memdoc">
  985. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  986. </div>
  987. </div>
  988. <a id="aa0e074c891f3db5ea2ebd491667b03a6"></a>
  989. <h2 class="memtitle"><span class="permalink"><a href="#aa0e074c891f3db5ea2ebd491667b03a6">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>
  990. <div class="memitem">
  991. <div class="memproto">
  992. <table class="mlabels">
  993. <tr>
  994. <td class="mlabels-left">
  995. <table class="memname">
  996. <tr>
  997. <td class="memname">bool ExFatFile::ls </td>
  998. <td>(</td>
  999. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1000. <td class="paramname"><em>pr</em></td><td>)</td>
  1001. <td></td>
  1002. </tr>
  1003. </table>
  1004. </td>
  1005. <td class="mlabels-right">
  1006. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1007. </tr>
  1008. </table>
  1009. </div><div class="memdoc">
  1010. <p>List directory contents.</p>
  1011. <dl class="params"><dt>Parameters</dt><dd>
  1012. <table class="params">
  1013. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list. </td></tr>
  1014. </table>
  1015. </dd>
  1016. </dl>
  1017. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1018. </div>
  1019. </div>
  1020. <a id="a09f8beb55f939874e93c1df6c8a046d4"></a>
  1021. <h2 class="memtitle"><span class="permalink"><a href="#a09f8beb55f939874e93c1df6c8a046d4">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>
  1022. <div class="memitem">
  1023. <div class="memproto">
  1024. <table class="mlabels">
  1025. <tr>
  1026. <td class="mlabels-left">
  1027. <table class="memname">
  1028. <tr>
  1029. <td class="memname">bool ExFatFile::ls </td>
  1030. <td>(</td>
  1031. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1032. <td class="paramname"><em>pr</em>, </td>
  1033. </tr>
  1034. <tr>
  1035. <td class="paramkey"></td>
  1036. <td></td>
  1037. <td class="paramtype">uint8_t&#160;</td>
  1038. <td class="paramname"><em>flags</em>, </td>
  1039. </tr>
  1040. <tr>
  1041. <td class="paramkey"></td>
  1042. <td></td>
  1043. <td class="paramtype">uint8_t&#160;</td>
  1044. <td class="paramname"><em>indent</em> = <code>0</code>&#160;</td>
  1045. </tr>
  1046. <tr>
  1047. <td></td>
  1048. <td>)</td>
  1049. <td></td><td></td>
  1050. </tr>
  1051. </table>
  1052. </td>
  1053. <td class="mlabels-right">
  1054. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1055. </tr>
  1056. </table>
  1057. </div><div class="memdoc">
  1058. <p>List directory contents.</p>
  1059. <dl class="params"><dt>Parameters</dt><dd>
  1060. <table class="params">
  1061. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1062. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1063. </table>
  1064. </dd>
  1065. </dl>
  1066. <p>LS_DATE - Print file modification date</p>
  1067. <p>LS_SIZE - Print file size.</p>
  1068. <p>LS_R - Recursive list of subdirectories.</p>
  1069. <dl class="params"><dt>Parameters</dt><dd>
  1070. <table class="params">
  1071. <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>
  1072. </table>
  1073. </dd>
  1074. </dl>
  1075. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1076. </div>
  1077. </div>
  1078. <a id="a3a393624d52854e74bf385c9e513a86d"></a>
  1079. <h2 class="memtitle"><span class="permalink"><a href="#a3a393624d52854e74bf385c9e513a86d">&#9670;&nbsp;</a></span>mkdir()</h2>
  1080. <div class="memitem">
  1081. <div class="memproto">
  1082. <table class="mlabels">
  1083. <tr>
  1084. <td class="mlabels-left">
  1085. <table class="memname">
  1086. <tr>
  1087. <td class="memname">bool ExFatFile::mkdir </td>
  1088. <td>(</td>
  1089. <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>
  1090. <td class="paramname"><em>parent</em>, </td>
  1091. </tr>
  1092. <tr>
  1093. <td class="paramkey"></td>
  1094. <td></td>
  1095. <td class="paramtype">const ExChar_t *&#160;</td>
  1096. <td class="paramname"><em>path</em>, </td>
  1097. </tr>
  1098. <tr>
  1099. <td class="paramkey"></td>
  1100. <td></td>
  1101. <td class="paramtype">bool&#160;</td>
  1102. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1103. </tr>
  1104. <tr>
  1105. <td></td>
  1106. <td>)</td>
  1107. <td></td><td></td>
  1108. </tr>
  1109. </table>
  1110. </td>
  1111. <td class="mlabels-right">
  1112. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1113. </tr>
  1114. </table>
  1115. </div><div class="memdoc">
  1116. <p>Make a new directory.</p>
  1117. <dl class="params"><dt>Parameters</dt><dd>
  1118. <table class="params">
  1119. <tr><td class="paramdir">[in]</td><td class="paramname">parent</td><td>An open directory file that will contain the new directory.</td></tr>
  1120. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the new directory.</td></tr>
  1121. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1122. </table>
  1123. </dd>
  1124. </dl>
  1125. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1126. </div>
  1127. </div>
  1128. <a id="a8792c863080576eb65ce6cacbe1dd931"></a>
  1129. <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">&#9670;&nbsp;</a></span>name()</h2>
  1130. <div class="memitem">
  1131. <div class="memproto">
  1132. <table class="mlabels">
  1133. <tr>
  1134. <td class="mlabels-left">
  1135. <table class="memname">
  1136. <tr>
  1137. <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>
  1138. <td>(</td>
  1139. <td class="paramname"></td><td>)</td>
  1140. <td> const</td>
  1141. </tr>
  1142. </table>
  1143. </td>
  1144. <td class="mlabels-right">
  1145. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1146. </tr>
  1147. </table>
  1148. </div><div class="memdoc">
  1149. <p>No longer implemented due to Long File Names.</p>
  1150. <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>
  1151. </div>
  1152. </div>
  1153. <a id="ad0be05c5c7092317089872778052cbd7"></a>
  1154. <h2 class="memtitle"><span class="permalink"><a href="#ad0be05c5c7092317089872778052cbd7">&#9670;&nbsp;</a></span>open() <span class="overload">[1/4]</span></h2>
  1155. <div class="memitem">
  1156. <div class="memproto">
  1157. <table class="mlabels">
  1158. <tr>
  1159. <td class="mlabels-left">
  1160. <table class="memname">
  1161. <tr>
  1162. <td class="memname">bool ExFatFile::open </td>
  1163. <td>(</td>
  1164. <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>
  1165. <td class="paramname"><em>dirFile</em>, </td>
  1166. </tr>
  1167. <tr>
  1168. <td class="paramkey"></td>
  1169. <td></td>
  1170. <td class="paramtype">const ExChar_t *&#160;</td>
  1171. <td class="paramname"><em>path</em>, </td>
  1172. </tr>
  1173. <tr>
  1174. <td class="paramkey"></td>
  1175. <td></td>
  1176. <td class="paramtype">oflag_t&#160;</td>
  1177. <td class="paramname"><em>oflag</em>&#160;</td>
  1178. </tr>
  1179. <tr>
  1180. <td></td>
  1181. <td>)</td>
  1182. <td></td><td></td>
  1183. </tr>
  1184. </table>
  1185. </td>
  1186. <td class="mlabels-right">
  1187. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1188. </tr>
  1189. </table>
  1190. </div><div class="memdoc">
  1191. <p>Open a file or directory by name.</p>
  1192. <dl class="params"><dt>Parameters</dt><dd>
  1193. <table class="params">
  1194. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open directory containing the file to be opened.</td></tr>
  1195. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path for a file to be opened.</td></tr>
  1196. <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>
  1197. </table>
  1198. </dd>
  1199. </dl>
  1200. <p>O_RDONLY - Open for reading.</p>
  1201. <p>O_READ - Same as O_RDONLY.</p>
  1202. <p>O_WRONLY - Open for writing.</p>
  1203. <p>O_WRITE - Same as O_WRONLY.</p>
  1204. <p>O_RDWR - Open for reading and writing.</p>
  1205. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>
  1206. <p>O_AT_END - Set the initial position at the end of the file.</p>
  1207. <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>
  1208. <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>
  1209. <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>
  1210. <p>WARNING: A given file must not be opened by more than one file object or file corruption may occur.</p>
  1211. <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>
  1212. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1213. </div>
  1214. </div>
  1215. <a id="a825447643e6c9e8284a3ed78e3363788"></a>
  1216. <h2 class="memtitle"><span class="permalink"><a href="#a825447643e6c9e8284a3ed78e3363788">&#9670;&nbsp;</a></span>open() <span class="overload">[2/4]</span></h2>
  1217. <div class="memitem">
  1218. <div class="memproto">
  1219. <table class="mlabels">
  1220. <tr>
  1221. <td class="mlabels-left">
  1222. <table class="memname">
  1223. <tr>
  1224. <td class="memname">bool ExFatFile::open </td>
  1225. <td>(</td>
  1226. <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *&#160;</td>
  1227. <td class="paramname"><em>vol</em>, </td>
  1228. </tr>
  1229. <tr>
  1230. <td class="paramkey"></td>
  1231. <td></td>
  1232. <td class="paramtype">const ExChar_t *&#160;</td>
  1233. <td class="paramname"><em>path</em>, </td>
  1234. </tr>
  1235. <tr>
  1236. <td class="paramkey"></td>
  1237. <td></td>
  1238. <td class="paramtype">int&#160;</td>
  1239. <td class="paramname"><em>oflag</em>&#160;</td>
  1240. </tr>
  1241. <tr>
  1242. <td></td>
  1243. <td>)</td>
  1244. <td></td><td></td>
  1245. </tr>
  1246. </table>
  1247. </td>
  1248. <td class="mlabels-right">
  1249. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1250. </tr>
  1251. </table>
  1252. </div><div class="memdoc">
  1253. <p>Open a file in the volume working directory.</p>
  1254. <dl class="params"><dt>Parameters</dt><dd>
  1255. <table class="params">
  1256. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>
  1257. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>
  1258. <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>
  1259. </table>
  1260. </dd>
  1261. </dl>
  1262. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1263. </div>
  1264. </div>
  1265. <a id="a414b64dc30551e05dcc46f04e0f6413a"></a>
  1266. <h2 class="memtitle"><span class="permalink"><a href="#a414b64dc30551e05dcc46f04e0f6413a">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>
  1267. <div class="memitem">
  1268. <div class="memproto">
  1269. <table class="mlabels">
  1270. <tr>
  1271. <td class="mlabels-left">
  1272. <table class="memname">
  1273. <tr>
  1274. <td class="memname">bool ExFatFile::open </td>
  1275. <td>(</td>
  1276. <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>
  1277. <td class="paramname"><em>dirFile</em>, </td>
  1278. </tr>
  1279. <tr>
  1280. <td class="paramkey"></td>
  1281. <td></td>
  1282. <td class="paramtype">uint32_t&#160;</td>
  1283. <td class="paramname"><em>index</em>, </td>
  1284. </tr>
  1285. <tr>
  1286. <td class="paramkey"></td>
  1287. <td></td>
  1288. <td class="paramtype">oflag_t&#160;</td>
  1289. <td class="paramname"><em>oflag</em>&#160;</td>
  1290. </tr>
  1291. <tr>
  1292. <td></td>
  1293. <td>)</td>
  1294. <td></td><td></td>
  1295. </tr>
  1296. </table>
  1297. </td>
  1298. <td class="mlabels-right">
  1299. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1300. </tr>
  1301. </table>
  1302. </div><div class="memdoc">
  1303. <p>Open a file by index.</p>
  1304. <dl class="params"><dt>Parameters</dt><dd>
  1305. <table class="params">
  1306. <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>
  1307. <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>
  1308. <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>
  1309. </table>
  1310. </dd>
  1311. </dl>
  1312. <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>
  1313. </div>
  1314. </div>
  1315. <a id="ab1e224aba9eb796c7ad48062cc1434c2"></a>
  1316. <h2 class="memtitle"><span class="permalink"><a href="#ab1e224aba9eb796c7ad48062cc1434c2">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>
  1317. <div class="memitem">
  1318. <div class="memproto">
  1319. <table class="mlabels">
  1320. <tr>
  1321. <td class="mlabels-left">
  1322. <table class="memname">
  1323. <tr>
  1324. <td class="memname">bool ExFatFile::open </td>
  1325. <td>(</td>
  1326. <td class="paramtype">const ExChar_t *&#160;</td>
  1327. <td class="paramname"><em>path</em>, </td>
  1328. </tr>
  1329. <tr>
  1330. <td class="paramkey"></td>
  1331. <td></td>
  1332. <td class="paramtype">int&#160;</td>
  1333. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1334. </tr>
  1335. <tr>
  1336. <td></td>
  1337. <td>)</td>
  1338. <td></td><td></td>
  1339. </tr>
  1340. </table>
  1341. </td>
  1342. <td class="mlabels-right">
  1343. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1344. </tr>
  1345. </table>
  1346. </div><div class="memdoc">
  1347. <p>Open a file in the current working directory.</p>
  1348. <dl class="params"><dt>Parameters</dt><dd>
  1349. <table class="params">
  1350. <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>
  1351. <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>
  1352. </table>
  1353. </dd>
  1354. </dl>
  1355. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1356. </div>
  1357. </div>
  1358. <a id="a89b6021cf70b7adb9feb162260d5a101"></a>
  1359. <h2 class="memtitle"><span class="permalink"><a href="#a89b6021cf70b7adb9feb162260d5a101">&#9670;&nbsp;</a></span>openNext()</h2>
  1360. <div class="memitem">
  1361. <div class="memproto">
  1362. <table class="mlabels">
  1363. <tr>
  1364. <td class="mlabels-left">
  1365. <table class="memname">
  1366. <tr>
  1367. <td class="memname">bool ExFatFile::openNext </td>
  1368. <td>(</td>
  1369. <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>
  1370. <td class="paramname"><em>dirFile</em>, </td>
  1371. </tr>
  1372. <tr>
  1373. <td class="paramkey"></td>
  1374. <td></td>
  1375. <td class="paramtype">oflag_t&#160;</td>
  1376. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1377. </tr>
  1378. <tr>
  1379. <td></td>
  1380. <td>)</td>
  1381. <td></td><td></td>
  1382. </tr>
  1383. </table>
  1384. </td>
  1385. <td class="mlabels-right">
  1386. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1387. </tr>
  1388. </table>
  1389. </div><div class="memdoc">
  1390. <p>Open the next file or subdirectory in a directory.</p>
  1391. <dl class="params"><dt>Parameters</dt><dd>
  1392. <table class="params">
  1393. <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>
  1394. <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>
  1395. </table>
  1396. </dd>
  1397. </dl>
  1398. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1399. </div>
  1400. </div>
  1401. <a id="ada8cd27e9a2f604f5c05088024a46a63"></a>
  1402. <h2 class="memtitle"><span class="permalink"><a href="#ada8cd27e9a2f604f5c05088024a46a63">&#9670;&nbsp;</a></span>openNextFile()</h2>
  1403. <div class="memitem">
  1404. <div class="memproto">
  1405. <table class="mlabels">
  1406. <tr>
  1407. <td class="mlabels-left">
  1408. <table class="memname">
  1409. <tr>
  1410. <td class="memname"><a class="el" href="class_ex_file.html">ExFile</a> ExFile::openNextFile </td>
  1411. <td>(</td>
  1412. <td class="paramtype">oflag_t&#160;</td>
  1413. <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>
  1414. <td></td>
  1415. </tr>
  1416. </table>
  1417. </td>
  1418. <td class="mlabels-right">
  1419. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1420. </tr>
  1421. </table>
  1422. </div><div class="memdoc">
  1423. <p>Opens the next file or folder in a directory.</p>
  1424. <dl class="params"><dt>Parameters</dt><dd>
  1425. <table class="params">
  1426. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1427. </table>
  1428. </dd>
  1429. </dl>
  1430. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>
  1431. </div>
  1432. </div>
  1433. <a id="af664c1da1bfa0bb5f6eb933bc25f757e"></a>
  1434. <h2 class="memtitle"><span class="permalink"><a href="#af664c1da1bfa0bb5f6eb933bc25f757e">&#9670;&nbsp;</a></span>openRoot()</h2>
  1435. <div class="memitem">
  1436. <div class="memproto">
  1437. <table class="mlabels">
  1438. <tr>
  1439. <td class="mlabels-left">
  1440. <table class="memname">
  1441. <tr>
  1442. <td class="memname">bool ExFatFile::openRoot </td>
  1443. <td>(</td>
  1444. <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> *&#160;</td>
  1445. <td class="paramname"><em>vol</em></td><td>)</td>
  1446. <td></td>
  1447. </tr>
  1448. </table>
  1449. </td>
  1450. <td class="mlabels-right">
  1451. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1452. </tr>
  1453. </table>
  1454. </div><div class="memdoc">
  1455. <p>Open a volume's root directory.</p>
  1456. <dl class="params"><dt>Parameters</dt><dd>
  1457. <table class="params">
  1458. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>
  1459. </table>
  1460. </dd>
  1461. </dl>
  1462. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1463. </div>
  1464. </div>
  1465. <a id="aa1abbd813f27d488f0ff439ccbc9ca98"></a>
  1466. <h2 class="memtitle"><span class="permalink"><a href="#aa1abbd813f27d488f0ff439ccbc9ca98">&#9670;&nbsp;</a></span>operator bool()</h2>
  1467. <div class="memitem">
  1468. <div class="memproto">
  1469. <table class="mlabels">
  1470. <tr>
  1471. <td class="mlabels-left">
  1472. <table class="memname">
  1473. <tr>
  1474. <td class="memname">ExFatFile::operator bool </td>
  1475. <td>(</td>
  1476. <td class="paramname"></td><td>)</td>
  1477. <td></td>
  1478. </tr>
  1479. </table>
  1480. </td>
  1481. <td class="mlabels-right">
  1482. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1483. </tr>
  1484. </table>
  1485. </div><div class="memdoc">
  1486. <p>The parenthesis operator.</p>
  1487. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>
  1488. </div>
  1489. </div>
  1490. <a id="af0da96e502485133ca0cff27fa130082"></a>
  1491. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>
  1492. <div class="memitem">
  1493. <div class="memproto">
  1494. <table class="mlabels">
  1495. <tr>
  1496. <td class="mlabels-left">
  1497. <table class="memname">
  1498. <tr>
  1499. <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>
  1500. <td>(</td>
  1501. <td class="paramname"></td><td>)</td>
  1502. <td></td>
  1503. </tr>
  1504. </table>
  1505. </td>
  1506. <td class="mlabels-right">
  1507. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1508. </tr>
  1509. </table>
  1510. </div><div class="memdoc">
  1511. <p>Return the next available byte without consuming it.</p>
  1512. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>
  1513. </div>
  1514. </div>
  1515. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>
  1516. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>
  1517. <div class="memitem">
  1518. <div class="memproto">
  1519. <table class="mlabels">
  1520. <tr>
  1521. <td class="mlabels-left">
  1522. <table class="memname">
  1523. <tr>
  1524. <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>
  1525. <td>(</td>
  1526. <td class="paramname"></td><td>)</td>
  1527. <td></td>
  1528. </tr>
  1529. </table>
  1530. </td>
  1531. <td class="mlabels-right">
  1532. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1533. </tr>
  1534. </table>
  1535. </div><div class="memdoc">
  1536. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>
  1537. </div>
  1538. </div>
  1539. <a id="a35a5093014e80965e49c84b61780556f"></a>
  1540. <h2 class="memtitle"><span class="permalink"><a href="#a35a5093014e80965e49c84b61780556f">&#9670;&nbsp;</a></span>preAllocate()</h2>
  1541. <div class="memitem">
  1542. <div class="memproto">
  1543. <table class="mlabels">
  1544. <tr>
  1545. <td class="mlabels-left">
  1546. <table class="memname">
  1547. <tr>
  1548. <td class="memname">bool ExFatFile::preAllocate </td>
  1549. <td>(</td>
  1550. <td class="paramtype">uint64_t&#160;</td>
  1551. <td class="paramname"><em>length</em></td><td>)</td>
  1552. <td></td>
  1553. </tr>
  1554. </table>
  1555. </td>
  1556. <td class="mlabels-right">
  1557. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1558. </tr>
  1559. </table>
  1560. </div><div class="memdoc">
  1561. <p>Allocate contiguous clusters to an empty file.</p>
  1562. <p>The file must be empty with no clusters allocated.</p>
  1563. <p>The file will have zero validLength and dataLength will equal the requested length.</p>
  1564. <dl class="params"><dt>Parameters</dt><dd>
  1565. <table class="params">
  1566. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of allocated space in bytes. </td></tr>
  1567. </table>
  1568. </dd>
  1569. </dl>
  1570. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1571. </div>
  1572. </div>
  1573. <a id="ad9ba8aa00b9db683d40fc2989dbe1922"></a>
  1574. <h2 class="memtitle"><span class="permalink"><a href="#ad9ba8aa00b9db683d40fc2989dbe1922">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>
  1575. <div class="memitem">
  1576. <div class="memproto">
  1577. <table class="mlabels">
  1578. <tr>
  1579. <td class="mlabels-left">
  1580. <table class="memname">
  1581. <tr>
  1582. <td class="memname">size_t ExFatFile::printAccessDateTime </td>
  1583. <td>(</td>
  1584. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1585. <td class="paramname"><em>pr</em></td><td>)</td>
  1586. <td></td>
  1587. </tr>
  1588. </table>
  1589. </td>
  1590. <td class="mlabels-right">
  1591. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1592. </tr>
  1593. </table>
  1594. </div><div class="memdoc">
  1595. <p>Print a file's access date and time</p>
  1596. <dl class="params"><dt>Parameters</dt><dd>
  1597. <table class="params">
  1598. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  1599. </table>
  1600. </dd>
  1601. </dl>
  1602. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1603. </div>
  1604. </div>
  1605. <a id="a7318b2d7594d6ba52421c413f5fc35cd"></a>
  1606. <h2 class="memtitle"><span class="permalink"><a href="#a7318b2d7594d6ba52421c413f5fc35cd">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>
  1607. <div class="memitem">
  1608. <div class="memproto">
  1609. <table class="mlabels">
  1610. <tr>
  1611. <td class="mlabels-left">
  1612. <table class="memname">
  1613. <tr>
  1614. <td class="memname">size_t ExFatFile::printCreateDateTime </td>
  1615. <td>(</td>
  1616. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1617. <td class="paramname"><em>pr</em></td><td>)</td>
  1618. <td></td>
  1619. </tr>
  1620. </table>
  1621. </td>
  1622. <td class="mlabels-right">
  1623. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1624. </tr>
  1625. </table>
  1626. </div><div class="memdoc">
  1627. <p>Print a file's creation date and time</p>
  1628. <dl class="params"><dt>Parameters</dt><dd>
  1629. <table class="params">
  1630. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  1631. </table>
  1632. </dd>
  1633. </dl>
  1634. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1635. </div>
  1636. </div>
  1637. <a id="a496ac61e367a24665425d54956a46346"></a>
  1638. <h2 class="memtitle"><span class="permalink"><a href="#a496ac61e367a24665425d54956a46346">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>
  1639. <div class="memitem">
  1640. <div class="memproto">
  1641. <table class="mlabels">
  1642. <tr>
  1643. <td class="mlabels-left">
  1644. <table class="memname">
  1645. <tr>
  1646. <td class="memname">size_t ExFatFile::printField </td>
  1647. <td>(</td>
  1648. <td class="paramtype">double&#160;</td>
  1649. <td class="paramname"><em>value</em>, </td>
  1650. </tr>
  1651. <tr>
  1652. <td class="paramkey"></td>
  1653. <td></td>
  1654. <td class="paramtype">char&#160;</td>
  1655. <td class="paramname"><em>term</em>, </td>
  1656. </tr>
  1657. <tr>
  1658. <td class="paramkey"></td>
  1659. <td></td>
  1660. <td class="paramtype">uint8_t&#160;</td>
  1661. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1662. </tr>
  1663. <tr>
  1664. <td></td>
  1665. <td>)</td>
  1666. <td></td><td></td>
  1667. </tr>
  1668. </table>
  1669. </td>
  1670. <td class="mlabels-right">
  1671. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1672. </tr>
  1673. </table>
  1674. </div><div class="memdoc">
  1675. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1676. <table class="params">
  1677. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1678. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  1679. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  1680. </table>
  1681. </dd>
  1682. </dl>
  1683. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1684. </div>
  1685. </div>
  1686. <a id="a70eda4191df90f608694c1faede7fb33"></a>
  1687. <h2 class="memtitle"><span class="permalink"><a href="#a70eda4191df90f608694c1faede7fb33">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>
  1688. <div class="memitem">
  1689. <div class="memproto">
  1690. <table class="mlabels">
  1691. <tr>
  1692. <td class="mlabels-left">
  1693. <table class="memname">
  1694. <tr>
  1695. <td class="memname">size_t ExFatFile::printField </td>
  1696. <td>(</td>
  1697. <td class="paramtype">float&#160;</td>
  1698. <td class="paramname"><em>value</em>, </td>
  1699. </tr>
  1700. <tr>
  1701. <td class="paramkey"></td>
  1702. <td></td>
  1703. <td class="paramtype">char&#160;</td>
  1704. <td class="paramname"><em>term</em>, </td>
  1705. </tr>
  1706. <tr>
  1707. <td class="paramkey"></td>
  1708. <td></td>
  1709. <td class="paramtype">uint8_t&#160;</td>
  1710. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1711. </tr>
  1712. <tr>
  1713. <td></td>
  1714. <td>)</td>
  1715. <td></td><td></td>
  1716. </tr>
  1717. </table>
  1718. </td>
  1719. <td class="mlabels-right">
  1720. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1721. </tr>
  1722. </table>
  1723. </div><div class="memdoc">
  1724. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1725. <table class="params">
  1726. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1727. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  1728. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  1729. </table>
  1730. </dd>
  1731. </dl>
  1732. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1733. </div>
  1734. </div>
  1735. <a id="a9759c13e804c01ff9e7e2ac8fbabc5b8"></a>
  1736. <h2 class="memtitle"><span class="permalink"><a href="#a9759c13e804c01ff9e7e2ac8fbabc5b8">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>
  1737. <div class="memitem">
  1738. <div class="memproto">
  1739. <div class="memtemplate">
  1740. template&lt;typename Type &gt; </div>
  1741. <table class="mlabels">
  1742. <tr>
  1743. <td class="mlabels-left">
  1744. <table class="memname">
  1745. <tr>
  1746. <td class="memname">size_t ExFatFile::printField </td>
  1747. <td>(</td>
  1748. <td class="paramtype">Type&#160;</td>
  1749. <td class="paramname"><em>value</em>, </td>
  1750. </tr>
  1751. <tr>
  1752. <td class="paramkey"></td>
  1753. <td></td>
  1754. <td class="paramtype">char&#160;</td>
  1755. <td class="paramname"><em>term</em>&#160;</td>
  1756. </tr>
  1757. <tr>
  1758. <td></td>
  1759. <td>)</td>
  1760. <td></td><td></td>
  1761. </tr>
  1762. </table>
  1763. </td>
  1764. <td class="mlabels-right">
  1765. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1766. </tr>
  1767. </table>
  1768. </div><div class="memdoc">
  1769. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1770. <table class="params">
  1771. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1772. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  1773. </table>
  1774. </dd>
  1775. </dl>
  1776. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1777. </div>
  1778. </div>
  1779. <a id="a16d527f98cff3ffd3ba8bc594a22d186"></a>
  1780. <h2 class="memtitle"><span class="permalink"><a href="#a16d527f98cff3ffd3ba8bc594a22d186">&#9670;&nbsp;</a></span>printFileSize()</h2>
  1781. <div class="memitem">
  1782. <div class="memproto">
  1783. <table class="mlabels">
  1784. <tr>
  1785. <td class="mlabels-left">
  1786. <table class="memname">
  1787. <tr>
  1788. <td class="memname">size_t ExFatFile::printFileSize </td>
  1789. <td>(</td>
  1790. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1791. <td class="paramname"><em>pr</em></td><td>)</td>
  1792. <td></td>
  1793. </tr>
  1794. </table>
  1795. </td>
  1796. <td class="mlabels-right">
  1797. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1798. </tr>
  1799. </table>
  1800. </div><div class="memdoc">
  1801. <p>Print a file's size in bytes. </p><dl class="params"><dt>Parameters</dt><dd>
  1802. <table class="params">
  1803. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Prtin stream for the output. </td></tr>
  1804. </table>
  1805. </dd>
  1806. </dl>
  1807. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>
  1808. </div>
  1809. </div>
  1810. <a id="a16488d3e0d946f108240b7d6c536c6f4"></a>
  1811. <h2 class="memtitle"><span class="permalink"><a href="#a16488d3e0d946f108240b7d6c536c6f4">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>
  1812. <div class="memitem">
  1813. <div class="memproto">
  1814. <table class="mlabels">
  1815. <tr>
  1816. <td class="mlabels-left">
  1817. <table class="memname">
  1818. <tr>
  1819. <td class="memname">size_t ExFatFile::printModifyDateTime </td>
  1820. <td>(</td>
  1821. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1822. <td class="paramname"><em>pr</em></td><td>)</td>
  1823. <td></td>
  1824. </tr>
  1825. </table>
  1826. </td>
  1827. <td class="mlabels-right">
  1828. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1829. </tr>
  1830. </table>
  1831. </div><div class="memdoc">
  1832. <p>Print a file's modify date and time</p>
  1833. <dl class="params"><dt>Parameters</dt><dd>
  1834. <table class="params">
  1835. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  1836. </table>
  1837. </dd>
  1838. </dl>
  1839. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1840. </div>
  1841. </div>
  1842. <a id="a095c0a865e5e5b6463c3dc0c90680635"></a>
  1843. <h2 class="memtitle"><span class="permalink"><a href="#a095c0a865e5e5b6463c3dc0c90680635">&#9670;&nbsp;</a></span>printName()</h2>
  1844. <div class="memitem">
  1845. <div class="memproto">
  1846. <table class="mlabels">
  1847. <tr>
  1848. <td class="mlabels-left">
  1849. <table class="memname">
  1850. <tr>
  1851. <td class="memname">size_t ExFatFile::printName </td>
  1852. <td>(</td>
  1853. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  1854. <td class="paramname"><em>pr</em></td><td>)</td>
  1855. <td></td>
  1856. </tr>
  1857. </table>
  1858. </td>
  1859. <td class="mlabels-right">
  1860. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1861. </tr>
  1862. </table>
  1863. </div><div class="memdoc">
  1864. <p>Print a file's name</p>
  1865. <dl class="params"><dt>Parameters</dt><dd>
  1866. <table class="params">
  1867. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  1868. </table>
  1869. </dd>
  1870. </dl>
  1871. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1872. </div>
  1873. </div>
  1874. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>
  1875. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>
  1876. <div class="memitem">
  1877. <div class="memproto">
  1878. <table class="mlabels">
  1879. <tr>
  1880. <td class="mlabels-left">
  1881. <table class="memname">
  1882. <tr>
  1883. <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>
  1884. <td>(</td>
  1885. <td class="paramname"></td><td>)</td>
  1886. <td></td>
  1887. </tr>
  1888. </table>
  1889. </td>
  1890. <td class="mlabels-right">
  1891. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1892. </tr>
  1893. </table>
  1894. </div><div class="memdoc">
  1895. <p>Read the next byte from a file.</p>
  1896. <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>
  1897. </div>
  1898. </div>
  1899. <a id="a5ae5477efe55179cf07e173c62654313"></a>
  1900. <h2 class="memtitle"><span class="permalink"><a href="#a5ae5477efe55179cf07e173c62654313">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>
  1901. <div class="memitem">
  1902. <div class="memproto">
  1903. <table class="mlabels">
  1904. <tr>
  1905. <td class="mlabels-left">
  1906. <table class="memname">
  1907. <tr>
  1908. <td class="memname">int ExFatFile::read </td>
  1909. <td>(</td>
  1910. <td class="paramtype">void *&#160;</td>
  1911. <td class="paramname"><em>buf</em>, </td>
  1912. </tr>
  1913. <tr>
  1914. <td class="paramkey"></td>
  1915. <td></td>
  1916. <td class="paramtype">size_t&#160;</td>
  1917. <td class="paramname"><em>count</em>&#160;</td>
  1918. </tr>
  1919. <tr>
  1920. <td></td>
  1921. <td>)</td>
  1922. <td></td><td></td>
  1923. </tr>
  1924. </table>
  1925. </td>
  1926. <td class="mlabels-right">
  1927. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1928. </tr>
  1929. </table>
  1930. </div><div class="memdoc">
  1931. <p>Read data from a file starting at the current position.</p>
  1932. <dl class="params"><dt>Parameters</dt><dd>
  1933. <table class="params">
  1934. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>
  1935. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>
  1936. </table>
  1937. </dd>
  1938. </dl>
  1939. <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>
  1940. </div>
  1941. </div>
  1942. <a id="a8e88c8e79551a72cc98310038514c47a"></a>
  1943. <h2 class="memtitle"><span class="permalink"><a href="#a8e88c8e79551a72cc98310038514c47a">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  1944. <div class="memitem">
  1945. <div class="memproto">
  1946. <table class="mlabels">
  1947. <tr>
  1948. <td class="mlabels-left">
  1949. <table class="memname">
  1950. <tr>
  1951. <td class="memname">bool ExFatFile::remove </td>
  1952. <td>(</td>
  1953. <td class="paramname"></td><td>)</td>
  1954. <td></td>
  1955. </tr>
  1956. </table>
  1957. </td>
  1958. <td class="mlabels-right">
  1959. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1960. </tr>
  1961. </table>
  1962. </div><div class="memdoc">
  1963. <p>Remove a file.</p>
  1964. <p>The directory entry and all data for the file are deleted.</p>
  1965. <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>
  1966. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1967. </div>
  1968. </div>
  1969. <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>
  1970. <h2 class="memtitle"><span class="permalink"><a href="#ad10417a851dba3d40a78eb2c0eb11fff">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  1971. <div class="memitem">
  1972. <div class="memproto">
  1973. <table class="mlabels">
  1974. <tr>
  1975. <td class="mlabels-left">
  1976. <table class="memname">
  1977. <tr>
  1978. <td class="memname">bool ExFatFile::remove </td>
  1979. <td>(</td>
  1980. <td class="paramtype">const ExChar_t *&#160;</td>
  1981. <td class="paramname"><em>path</em></td><td>)</td>
  1982. <td></td>
  1983. </tr>
  1984. </table>
  1985. </td>
  1986. <td class="mlabels-right">
  1987. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1988. </tr>
  1989. </table>
  1990. </div><div class="memdoc">
  1991. <p>Remove a file.</p>
  1992. <p>The directory entry and all data for the file are deleted.</p>
  1993. <dl class="params"><dt>Parameters</dt><dd>
  1994. <table class="params">
  1995. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>
  1996. </table>
  1997. </dd>
  1998. </dl>
  1999. <p>Example use: dirFile.remove(filenameToRemove);</p>
  2000. <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>
  2001. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2002. </div>
  2003. </div>
  2004. <a id="aab50b2646035f76834c75230d2b55c64"></a>
  2005. <h2 class="memtitle"><span class="permalink"><a href="#aab50b2646035f76834c75230d2b55c64">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  2006. <div class="memitem">
  2007. <div class="memproto">
  2008. <table class="mlabels">
  2009. <tr>
  2010. <td class="mlabels-left">
  2011. <table class="memname">
  2012. <tr>
  2013. <td class="memname">bool ExFatFile::rename </td>
  2014. <td>(</td>
  2015. <td class="paramtype">const ExChar_t *&#160;</td>
  2016. <td class="paramname"><em>newPath</em></td><td>)</td>
  2017. <td></td>
  2018. </tr>
  2019. </table>
  2020. </td>
  2021. <td class="mlabels-right">
  2022. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2023. </tr>
  2024. </table>
  2025. </div><div class="memdoc">
  2026. <p>Rename a file or subdirectory.</p>
  2027. <dl class="params"><dt>Parameters</dt><dd>
  2028. <table class="params">
  2029. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2030. </table>
  2031. </dd>
  2032. </dl>
  2033. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2034. </div>
  2035. </div>
  2036. <a id="aea570a3b6afbe633d874803b137a46b8"></a>
  2037. <h2 class="memtitle"><span class="permalink"><a href="#aea570a3b6afbe633d874803b137a46b8">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  2038. <div class="memitem">
  2039. <div class="memproto">
  2040. <table class="mlabels">
  2041. <tr>
  2042. <td class="mlabels-left">
  2043. <table class="memname">
  2044. <tr>
  2045. <td class="memname">bool ExFatFile::rename </td>
  2046. <td>(</td>
  2047. <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>
  2048. <td class="paramname"><em>dirFile</em>, </td>
  2049. </tr>
  2050. <tr>
  2051. <td class="paramkey"></td>
  2052. <td></td>
  2053. <td class="paramtype">const ExChar_t *&#160;</td>
  2054. <td class="paramname"><em>newPath</em>&#160;</td>
  2055. </tr>
  2056. <tr>
  2057. <td></td>
  2058. <td>)</td>
  2059. <td></td><td></td>
  2060. </tr>
  2061. </table>
  2062. </td>
  2063. <td class="mlabels-right">
  2064. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2065. </tr>
  2066. </table>
  2067. </div><div class="memdoc">
  2068. <p>Rename a file or subdirectory.</p>
  2069. <dl class="params"><dt>Parameters</dt><dd>
  2070. <table class="params">
  2071. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>
  2072. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2073. </table>
  2074. </dd>
  2075. </dl>
  2076. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2077. </div>
  2078. </div>
  2079. <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>
  2080. <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">&#9670;&nbsp;</a></span>rewind()</h2>
  2081. <div class="memitem">
  2082. <div class="memproto">
  2083. <table class="mlabels">
  2084. <tr>
  2085. <td class="mlabels-left">
  2086. <table class="memname">
  2087. <tr>
  2088. <td class="memname">void ExFatFile::rewind </td>
  2089. <td>(</td>
  2090. <td class="paramname"></td><td>)</td>
  2091. <td></td>
  2092. </tr>
  2093. </table>
  2094. </td>
  2095. <td class="mlabels-right">
  2096. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2097. </tr>
  2098. </table>
  2099. </div><div class="memdoc">
  2100. <p>Set the file's current position to zero. </p>
  2101. </div>
  2102. </div>
  2103. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>
  2104. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>
  2105. <div class="memitem">
  2106. <div class="memproto">
  2107. <table class="mlabels">
  2108. <tr>
  2109. <td class="mlabels-left">
  2110. <table class="memname">
  2111. <tr>
  2112. <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>
  2113. <td>(</td>
  2114. <td class="paramname"></td><td>)</td>
  2115. <td></td>
  2116. </tr>
  2117. </table>
  2118. </td>
  2119. <td class="mlabels-right">
  2120. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2121. </tr>
  2122. </table>
  2123. </div><div class="memdoc">
  2124. <p>Rewind a file if it is a directory </p>
  2125. </div>
  2126. </div>
  2127. <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>
  2128. <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">&#9670;&nbsp;</a></span>rmdir()</h2>
  2129. <div class="memitem">
  2130. <div class="memproto">
  2131. <table class="mlabels">
  2132. <tr>
  2133. <td class="mlabels-left">
  2134. <table class="memname">
  2135. <tr>
  2136. <td class="memname">bool ExFatFile::rmdir </td>
  2137. <td>(</td>
  2138. <td class="paramname"></td><td>)</td>
  2139. <td></td>
  2140. </tr>
  2141. </table>
  2142. </td>
  2143. <td class="mlabels-right">
  2144. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2145. </tr>
  2146. </table>
  2147. </div><div class="memdoc">
  2148. <p>Remove a directory file.</p>
  2149. <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>
  2150. <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>
  2151. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2152. </div>
  2153. </div>
  2154. <a id="a773ee6f661fc689a5187f51cb5498086"></a>
  2155. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>
  2156. <div class="memitem">
  2157. <div class="memproto">
  2158. <table class="mlabels">
  2159. <tr>
  2160. <td class="mlabels-left">
  2161. <table class="memname">
  2162. <tr>
  2163. <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>
  2164. <td>(</td>
  2165. <td class="paramtype">uint64_t&#160;</td>
  2166. <td class="paramname"><em>pos</em></td><td>)</td>
  2167. <td></td>
  2168. </tr>
  2169. </table>
  2170. </td>
  2171. <td class="mlabels-right">
  2172. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2173. </tr>
  2174. </table>
  2175. </div><div class="memdoc">
  2176. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>
  2177. <dl class="params"><dt>Parameters</dt><dd>
  2178. <table class="params">
  2179. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>
  2180. </table>
  2181. </dd>
  2182. </dl>
  2183. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2184. </div>
  2185. </div>
  2186. <a id="ab42494880cf229adfb0fc8edb0647686"></a>
  2187. <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">&#9670;&nbsp;</a></span>seekCur()</h2>
  2188. <div class="memitem">
  2189. <div class="memproto">
  2190. <table class="mlabels">
  2191. <tr>
  2192. <td class="mlabels-left">
  2193. <table class="memname">
  2194. <tr>
  2195. <td class="memname">bool ExFatFile::seekCur </td>
  2196. <td>(</td>
  2197. <td class="paramtype">int64_t&#160;</td>
  2198. <td class="paramname"><em>offset</em></td><td>)</td>
  2199. <td></td>
  2200. </tr>
  2201. </table>
  2202. </td>
  2203. <td class="mlabels-right">
  2204. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2205. </tr>
  2206. </table>
  2207. </div><div class="memdoc">
  2208. <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>
  2209. <table class="params">
  2210. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>
  2211. </table>
  2212. </dd>
  2213. </dl>
  2214. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2215. </div>
  2216. </div>
  2217. <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>
  2218. <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">&#9670;&nbsp;</a></span>seekEnd()</h2>
  2219. <div class="memitem">
  2220. <div class="memproto">
  2221. <table class="mlabels">
  2222. <tr>
  2223. <td class="mlabels-left">
  2224. <table class="memname">
  2225. <tr>
  2226. <td class="memname">bool ExFatFile::seekEnd </td>
  2227. <td>(</td>
  2228. <td class="paramtype">int64_t&#160;</td>
  2229. <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>
  2230. <td></td>
  2231. </tr>
  2232. </table>
  2233. </td>
  2234. <td class="mlabels-right">
  2235. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2236. </tr>
  2237. </table>
  2238. </div><div class="memdoc">
  2239. <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>
  2240. <table class="params">
  2241. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>
  2242. </table>
  2243. </dd>
  2244. </dl>
  2245. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2246. </div>
  2247. </div>
  2248. <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>
  2249. <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">&#9670;&nbsp;</a></span>seekSet()</h2>
  2250. <div class="memitem">
  2251. <div class="memproto">
  2252. <table class="mlabels">
  2253. <tr>
  2254. <td class="mlabels-left">
  2255. <table class="memname">
  2256. <tr>
  2257. <td class="memname">bool ExFatFile::seekSet </td>
  2258. <td>(</td>
  2259. <td class="paramtype">uint64_t&#160;</td>
  2260. <td class="paramname"><em>pos</em></td><td>)</td>
  2261. <td></td>
  2262. </tr>
  2263. </table>
  2264. </td>
  2265. <td class="mlabels-right">
  2266. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2267. </tr>
  2268. </table>
  2269. </div><div class="memdoc">
  2270. <p>Sets a file's position.</p>
  2271. <dl class="params"><dt>Parameters</dt><dd>
  2272. <table class="params">
  2273. <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>
  2274. </table>
  2275. </dd>
  2276. </dl>
  2277. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2278. </div>
  2279. </div>
  2280. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>
  2281. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>
  2282. <div class="memitem">
  2283. <div class="memproto">
  2284. <table class="mlabels">
  2285. <tr>
  2286. <td class="mlabels-left">
  2287. <table class="memname">
  2288. <tr>
  2289. <td class="memname">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>
  2290. <td>(</td>
  2291. <td class="paramname"></td><td>)</td>
  2292. <td></td>
  2293. </tr>
  2294. </table>
  2295. </td>
  2296. <td class="mlabels-right">
  2297. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2298. </tr>
  2299. </table>
  2300. </div><div class="memdoc">
  2301. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>
  2302. </div>
  2303. </div>
  2304. <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>
  2305. <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">&#9670;&nbsp;</a></span>sync()</h2>
  2306. <div class="memitem">
  2307. <div class="memproto">
  2308. <table class="mlabels">
  2309. <tr>
  2310. <td class="mlabels-left">
  2311. <table class="memname">
  2312. <tr>
  2313. <td class="memname">bool ExFatFile::sync </td>
  2314. <td>(</td>
  2315. <td class="paramname"></td><td>)</td>
  2316. <td></td>
  2317. </tr>
  2318. </table>
  2319. </td>
  2320. <td class="mlabels-right">
  2321. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2322. </tr>
  2323. </table>
  2324. </div><div class="memdoc">
  2325. <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>
  2326. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2327. </div>
  2328. </div>
  2329. <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>
  2330. <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">&#9670;&nbsp;</a></span>timestamp()</h2>
  2331. <div class="memitem">
  2332. <div class="memproto">
  2333. <table class="mlabels">
  2334. <tr>
  2335. <td class="mlabels-left">
  2336. <table class="memname">
  2337. <tr>
  2338. <td class="memname">bool ExFatFile::timestamp </td>
  2339. <td>(</td>
  2340. <td class="paramtype">uint8_t&#160;</td>
  2341. <td class="paramname"><em>flags</em>, </td>
  2342. </tr>
  2343. <tr>
  2344. <td class="paramkey"></td>
  2345. <td></td>
  2346. <td class="paramtype">uint16_t&#160;</td>
  2347. <td class="paramname"><em>year</em>, </td>
  2348. </tr>
  2349. <tr>
  2350. <td class="paramkey"></td>
  2351. <td></td>
  2352. <td class="paramtype">uint8_t&#160;</td>
  2353. <td class="paramname"><em>month</em>, </td>
  2354. </tr>
  2355. <tr>
  2356. <td class="paramkey"></td>
  2357. <td></td>
  2358. <td class="paramtype">uint8_t&#160;</td>
  2359. <td class="paramname"><em>day</em>, </td>
  2360. </tr>
  2361. <tr>
  2362. <td class="paramkey"></td>
  2363. <td></td>
  2364. <td class="paramtype">uint8_t&#160;</td>
  2365. <td class="paramname"><em>hour</em>, </td>
  2366. </tr>
  2367. <tr>
  2368. <td class="paramkey"></td>
  2369. <td></td>
  2370. <td class="paramtype">uint8_t&#160;</td>
  2371. <td class="paramname"><em>minute</em>, </td>
  2372. </tr>
  2373. <tr>
  2374. <td class="paramkey"></td>
  2375. <td></td>
  2376. <td class="paramtype">uint8_t&#160;</td>
  2377. <td class="paramname"><em>second</em>&#160;</td>
  2378. </tr>
  2379. <tr>
  2380. <td></td>
  2381. <td>)</td>
  2382. <td></td><td></td>
  2383. </tr>
  2384. </table>
  2385. </td>
  2386. <td class="mlabels-right">
  2387. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2388. </tr>
  2389. </table>
  2390. </div><div class="memdoc">
  2391. <p>Truncate a file at the current file position.</p>
  2392. <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>
  2393. <dl class="params"><dt>Parameters</dt><dd>
  2394. <table class="params">
  2395. <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>
  2396. </table>
  2397. </dd>
  2398. </dl>
  2399. <p>T_ACCESS - Set the file's last access date.</p>
  2400. <p>T_CREATE - Set the file's creation date and time.</p>
  2401. <p>T_WRITE - Set the file's last write/modification date and time.</p>
  2402. <dl class="params"><dt>Parameters</dt><dd>
  2403. <table class="params">
  2404. <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>
  2405. <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>
  2406. <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>
  2407. <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>
  2408. <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>
  2409. <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>
  2410. </table>
  2411. </dd>
  2412. </dl>
  2413. <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>
  2414. <dd>
  2415. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>
  2416. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2417. </div>
  2418. </div>
  2419. <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>
  2420. <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>
  2421. <div class="memitem">
  2422. <div class="memproto">
  2423. <table class="mlabels">
  2424. <tr>
  2425. <td class="mlabels-left">
  2426. <table class="memname">
  2427. <tr>
  2428. <td class="memname">bool ExFatFile::truncate </td>
  2429. <td>(</td>
  2430. <td class="paramname"></td><td>)</td>
  2431. <td></td>
  2432. </tr>
  2433. </table>
  2434. </td>
  2435. <td class="mlabels-right">
  2436. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2437. </tr>
  2438. </table>
  2439. </div><div class="memdoc">
  2440. <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>
  2441. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2442. </div>
  2443. </div>
  2444. <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>
  2445. <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>
  2446. <div class="memitem">
  2447. <div class="memproto">
  2448. <table class="mlabels">
  2449. <tr>
  2450. <td class="mlabels-left">
  2451. <table class="memname">
  2452. <tr>
  2453. <td class="memname">bool ExFatFile::truncate </td>
  2454. <td>(</td>
  2455. <td class="paramtype">uint64_t&#160;</td>
  2456. <td class="paramname"><em>length</em></td><td>)</td>
  2457. <td></td>
  2458. </tr>
  2459. </table>
  2460. </td>
  2461. <td class="mlabels-right">
  2462. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2463. </tr>
  2464. </table>
  2465. </div><div class="memdoc">
  2466. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>
  2467. <dl class="params"><dt>Parameters</dt><dd>
  2468. <table class="params">
  2469. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2470. </table>
  2471. </dd>
  2472. </dl>
  2473. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2474. </div>
  2475. </div>
  2476. <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>
  2477. <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">&#9670;&nbsp;</a></span>validLength()</h2>
  2478. <div class="memitem">
  2479. <div class="memproto">
  2480. <table class="mlabels">
  2481. <tr>
  2482. <td class="mlabels-left">
  2483. <table class="memname">
  2484. <tr>
  2485. <td class="memname">uint64_t ExFatFile::validLength </td>
  2486. <td>(</td>
  2487. <td class="paramname"></td><td>)</td>
  2488. <td></td>
  2489. </tr>
  2490. </table>
  2491. </td>
  2492. <td class="mlabels-right">
  2493. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2494. </tr>
  2495. </table>
  2496. </div><div class="memdoc">
  2497. <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>
  2498. </div>
  2499. </div>
  2500. <a id="a0695220134825199b39dee82f18ab1ec"></a>
  2501. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>
  2502. <div class="memitem">
  2503. <div class="memproto">
  2504. <table class="mlabels">
  2505. <tr>
  2506. <td class="mlabels-left">
  2507. <table class="memname">
  2508. <tr>
  2509. <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>
  2510. <td>(</td>
  2511. <td class="paramtype">uint8_t&#160;</td>
  2512. <td class="paramname"><em>b</em></td><td>)</td>
  2513. <td></td>
  2514. </tr>
  2515. </table>
  2516. </td>
  2517. <td class="mlabels-right">
  2518. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2519. </tr>
  2520. </table>
  2521. </div><div class="memdoc">
  2522. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
  2523. <table class="params">
  2524. <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>
  2525. </table>
  2526. </dd>
  2527. </dl>
  2528. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>
  2529. </div>
  2530. </div>
  2531. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>
  2532. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>
  2533. <div class="memitem">
  2534. <div class="memproto">
  2535. <table class="mlabels">
  2536. <tr>
  2537. <td class="mlabels-left">
  2538. <table class="memname">
  2539. <tr>
  2540. <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>
  2541. <td>(</td>
  2542. <td class="paramtype">const uint8_t *&#160;</td>
  2543. <td class="paramname"><em>buffer</em>, </td>
  2544. </tr>
  2545. <tr>
  2546. <td class="paramkey"></td>
  2547. <td></td>
  2548. <td class="paramtype">size_t&#160;</td>
  2549. <td class="paramname"><em>size</em>&#160;</td>
  2550. </tr>
  2551. <tr>
  2552. <td></td>
  2553. <td>)</td>
  2554. <td></td><td></td>
  2555. </tr>
  2556. </table>
  2557. </td>
  2558. <td class="mlabels-right">
  2559. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2560. </tr>
  2561. </table>
  2562. </div><div class="memdoc">
  2563. <p>Write data to an open file.</p>
  2564. <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>
  2565. <dl class="params"><dt>Parameters</dt><dd>
  2566. <table class="params">
  2567. <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>
  2568. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>
  2569. </table>
  2570. </dd>
  2571. </dl>
  2572. <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>
  2573. </div>
  2574. </div>
  2575. <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>
  2576. <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>
  2577. <div class="memitem">
  2578. <div class="memproto">
  2579. <table class="mlabels">
  2580. <tr>
  2581. <td class="mlabels-left">
  2582. <table class="memname">
  2583. <tr>
  2584. <td class="memname">size_t ExFatFile::write </td>
  2585. <td>(</td>
  2586. <td class="paramtype">const char *&#160;</td>
  2587. <td class="paramname"><em>str</em></td><td>)</td>
  2588. <td></td>
  2589. </tr>
  2590. </table>
  2591. </td>
  2592. <td class="mlabels-right">
  2593. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2594. </tr>
  2595. </table>
  2596. </div><div class="memdoc">
  2597. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
  2598. <table class="params">
  2599. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>
  2600. </table>
  2601. </dd>
  2602. </dl>
  2603. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>
  2604. </div>
  2605. </div>
  2606. <a id="abc1423c7b550614d1067e7173f8b46a8"></a>
  2607. <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>
  2608. <div class="memitem">
  2609. <div class="memproto">
  2610. <table class="mlabels">
  2611. <tr>
  2612. <td class="mlabels-left">
  2613. <table class="memname">
  2614. <tr>
  2615. <td class="memname">size_t ExFatFile::write </td>
  2616. <td>(</td>
  2617. <td class="paramtype">const void *&#160;</td>
  2618. <td class="paramname"><em>buf</em>, </td>
  2619. </tr>
  2620. <tr>
  2621. <td class="paramkey"></td>
  2622. <td></td>
  2623. <td class="paramtype">size_t&#160;</td>
  2624. <td class="paramname"><em>count</em>&#160;</td>
  2625. </tr>
  2626. <tr>
  2627. <td></td>
  2628. <td>)</td>
  2629. <td></td><td></td>
  2630. </tr>
  2631. </table>
  2632. </td>
  2633. <td class="mlabels-right">
  2634. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2635. </tr>
  2636. </table>
  2637. </div><div class="memdoc">
  2638. <p>Write data to an open file.</p>
  2639. <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>
  2640. <dl class="params"><dt>Parameters</dt><dd>
  2641. <table class="params">
  2642. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>
  2643. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>
  2644. </table>
  2645. </dd>
  2646. </dl>
  2647. <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>
  2648. </div>
  2649. </div>
  2650. <hr/>The documentation for this class was generated from the following file:<ul>
  2651. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>
  2652. </ul>
  2653. </div><!-- contents -->
  2654. <!-- start footer part -->
  2655. <hr class="footer"/><address class="footer"><small>
  2656. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  2657. <img class="footer" src="doxygen.png" alt="doxygen"/>
  2658. </a> 1.8.14
  2659. </small></address>
  2660. </body>
  2661. </html>