visus
/
teensy-sdfat
Seguir 1
Destacar 0
Fork 0
Código Incidencias 0 Pull Requests 0 Lanzamientos 0 Wiki Actividad
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
49 Commits
1 Rama
Árbol: 5cb74d4e33
Ramas Etiquetas
${ item.name }
Crear rama ${ searchTerm }
desde '5cb74d4e33'
${ noResults }
teensy-sdfat/extras/html/class_ex_file.html

2814 líneas
125KB
Original Blame Histórico 

  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. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

  72. <p>exFAT file with Arduino Stream.  

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

  74. 

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

  76. <div class="dynheader">

  77. Inheritance diagram for ExFile:</div>

  78. <div class="dyncontent">

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

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

  81. <area shape="rect" id="node2" href="class_stream_file.html" title="StreamFile\&lt; ExFatFile,\l uint64_t \&gt;" alt="" coords="13,80,170,121"/>

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

  83. </map>

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

  85. <div class="dynheader">

  86. Collaboration diagram for ExFile:</div>

  87. <div class="dyncontent">

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

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

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

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

  92. </map>

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

  94. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  246. </table>

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

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

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

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

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

  252. 

  253. <div class="memitem">

  254. <div class="memproto">

  255. <table class="mlabels">

  256.   <tr>

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

  258.       <table class="memname">

  259.         <tr>

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

  261.           <td>(</td>

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

  263.           <td></td>

  264.         </tr>

  265.       </table>

  266.   </td>

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

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

  269.   </tr>

  270. </table>

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

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

  273. 

  274. </div>

  275. </div>

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

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

  278. 

  279. <div class="memitem">

  280. <div class="memproto">

  281. <table class="mlabels">

  282.   <tr>

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

  284.       <table class="memname">

  285.         <tr>

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

  287.           <td>(</td>

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

  289.           <td></td>

  290.         </tr>

  291.       </table>

  292.   </td>

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

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

  295.   </tr>

  296. </table>

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

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

  299. 

  300. </div>

  301. </div>

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

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

  304. 

  305. <div class="memitem">

  306. <div class="memproto">

  307. <table class="mlabels">

  308.   <tr>

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

  310.       <table class="memname">

  311.         <tr>

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

  313.           <td>(</td>

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

  315.           <td></td>

  316.         </tr>

  317.       </table>

  318.   </td>

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

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

  321.   </tr>

  322. </table>

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

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

  325. 

  326. </div>

  327. </div>

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

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

  330. 

  331. <div class="memitem">

  332. <div class="memproto">

  333. <table class="mlabels">

  334.   <tr>

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

  336.       <table class="memname">

  337.         <tr>

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

  339.           <td>(</td>

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

  341.           <td></td>

  342.         </tr>

  343.       </table>

  344.   </td>

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

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

  347.   </tr>

  348. </table>

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

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

  351. 

  352. </div>

  353. </div>

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

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

  356. 

  357. <div class="memitem">

  358. <div class="memproto">

  359. <table class="mlabels">

  360.   <tr>

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

  362.       <table class="memname">

  363.         <tr>

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

  365.           <td>(</td>

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

  367.           <td></td>

  368.         </tr>

  369.       </table>

  370.   </td>

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

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

  373.   </tr>

  374. </table>

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

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

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

  378. 

  379. </div>

  380. </div>

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

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

  383. 

  384. <div class="memitem">

  385. <div class="memproto">

  386. <table class="mlabels">

  387.   <tr>

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

  389.       <table class="memname">

  390.         <tr>

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

  392.           <td>(</td>

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

  394.           <td> const</td>

  395.         </tr>

  396.       </table>

  397.   </td>

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

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

  400.   </tr>

  401. </table>

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

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

  404. 

  405. </div>

  406. </div>

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

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

  409. 

  410. <div class="memitem">

  411. <div class="memproto">

  412. <table class="mlabels">

  413.   <tr>

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

  415.       <table class="memname">

  416.         <tr>

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

  418.           <td>(</td>

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

  420.           <td></td>

  421.         </tr>

  422.       </table>

  423.   </td>

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

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

  426.   </tr>

  427. </table>

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

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

  430. 

  431. </div>

  432. </div>

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

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

  435. 

  436. <div class="memitem">

  437. <div class="memproto">

  438. <table class="mlabels">

  439.   <tr>

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

  441.       <table class="memname">

  442.         <tr>

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

  444.           <td>(</td>

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

  446.           <td></td>

  447.         </tr>

  448.       </table>

  449.   </td>

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

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

  452.   </tr>

  453. </table>

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

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

  456. 

  457. </div>

  458. </div>

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

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

  461. 

  462. <div class="memitem">

  463. <div class="memproto">

  464. <table class="mlabels">

  465.   <tr>

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

  467.       <table class="memname">

  468.         <tr>

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

  470.           <td>(</td>

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

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

  473.           <td></td>

  474.         </tr>

  475.       </table>

  476.   </td>

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

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

  479.   </tr>

  480. </table>

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

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

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

  484.   <table class="params">

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

  486.   </table>

  487.   </dd>

  488. </dl>

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

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

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

  492. 

  493. </div>

  494. </div>

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

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

  497. 

  498. <div class="memitem">

  499. <div class="memproto">

  500. <table class="mlabels">

  501.   <tr>

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

  503.       <table class="memname">

  504.         <tr>

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

  506.           <td>(</td>

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

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

  509.           <td></td>

  510.         </tr>

  511.       </table>

  512.   </td>

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

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

  515.   </tr>

  516. </table>

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

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

  519.   <table class="params">

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

  521.   </table>

  522.   </dd>

  523. </dl>

  524. 

  525. </div>

  526. </div>

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

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

  529. 

  530. <div class="memitem">

  531. <div class="memproto">

  532. <table class="mlabels">

  533.   <tr>

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

  535.       <table class="memname">

  536.         <tr>

  537.           <td class="memname">int ExFatFile::fgets </td>

  538.           <td>(</td>

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

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

  541.         </tr>

  542.         <tr>

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

  544.           <td></td>

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

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

  547.         </tr>

  548.         <tr>

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

  550.           <td></td>

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

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

  553.         </tr>

  554.         <tr>

  555.           <td></td>

  556.           <td>)</td>

  557.           <td></td><td></td>

  558.         </tr>

  559.       </table>

  560.   </td>

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

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

  563.   </tr>

  564. </table>

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

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

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

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

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

  570.   <table class="params">

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

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

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

  574.   </table>

  575.   </dd>

  576. </dl>

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

  578. 

  579. </div>

  580. </div>

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

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

  583. 

  584. <div class="memitem">

  585. <div class="memproto">

  586. <table class="mlabels">

  587.   <tr>

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

  589.       <table class="memname">

  590.         <tr>

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

  592.           <td>(</td>

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

  594.           <td></td>

  595.         </tr>

  596.       </table>

  597.   </td>

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

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

  600.   </tr>

  601. </table>

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

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

  604. 

  605. </div>

  606. </div>

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

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

  609. 

  610. <div class="memitem">

  611. <div class="memproto">

  612. <table class="mlabels">

  613.   <tr>

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

  615.       <table class="memname">

  616.         <tr>

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

  618.           <td>(</td>

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

  620.           <td></td>

  621.         </tr>

  622.       </table>

  623.   </td>

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

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

  626.   </tr>

  627. </table>

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

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

  630. 

  631. </div>

  632. </div>

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

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

  635. 

  636. <div class="memitem">

  637. <div class="memproto">

  638. <table class="mlabels">

  639.   <tr>

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

  641.       <table class="memname">

  642.         <tr>

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

  644.           <td>(</td>

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

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

  647.           <td></td>

  648.         </tr>

  649.       </table>

  650.   </td>

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

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

  653.   </tr>

  654. </table>

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

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

  657.   <table class="params">

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

  659.   </table>

  660.   </dd>

  661. </dl>

  662. 

  663. </div>

  664. </div>

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

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

  667. 

  668. <div class="memitem">

  669. <div class="memproto">

  670. <table class="mlabels">

  671.   <tr>

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

  673.       <table class="memname">

  674.         <tr>

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

  676.           <td>(</td>

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

  678.           <td></td>

  679.         </tr>

  680.       </table>

  681.   </td>

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

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

  684.   </tr>

  685. </table>

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

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

  688. 

  689. </div>

  690. </div>

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

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

  693. 

  694. <div class="memitem">

  695. <div class="memproto">

  696. <table class="mlabels">

  697.   <tr>

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

  699.       <table class="memname">

  700.         <tr>

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

  702.           <td>(</td>

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

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

  705.         </tr>

  706.         <tr>

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

  708.           <td></td>

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

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

  711.         </tr>

  712.         <tr>

  713.           <td></td>

  714.           <td>)</td>

  715.           <td></td><td></td>

  716.         </tr>

  717.       </table>

  718.   </td>

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

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

  721.   </tr>

  722. </table>

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

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

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

  726.   <table class="params">

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

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

  729.   </table>

  730.   </dd>

  731. </dl>

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

  733. 

  734. </div>

  735. </div>

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

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

  738. 

  739. <div class="memitem">

  740. <div class="memproto">

  741. <table class="mlabels">

  742.   <tr>

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

  744.       <table class="memname">

  745.         <tr>

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

  747.           <td>(</td>

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

  749.           <td></td>

  750.         </tr>

  751.       </table>

  752.   </td>

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

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

  755.   </tr>

  756. </table>

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

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

  759. 

  760. </div>

  761. </div>

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

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

  764. 

  765. <div class="memitem">

  766. <div class="memproto">

  767. <table class="mlabels">

  768.   <tr>

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

  770.       <table class="memname">

  771.         <tr>

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

  773.           <td>(</td>

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

  775.           <td> const</td>

  776.         </tr>

  777.       </table>

  778.   </td>

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

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

  781.   </tr>

  782. </table>

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

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

  785. 

  786. </div>

  787. </div>

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

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

  790. 

  791. <div class="memitem">

  792. <div class="memproto">

  793. <table class="mlabels">

  794.   <tr>

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

  796.       <table class="memname">

  797.         <tr>

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

  799.           <td>(</td>

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

  801.           <td> const</td>

  802.         </tr>

  803.       </table>

  804.   </td>

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

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

  807.   </tr>

  808. </table>

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

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

  811. 

  812. </div>

  813. </div>

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

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

  816. 

  817. <div class="memitem">

  818. <div class="memproto">

  819. <table class="mlabels">

  820.   <tr>

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

  822.       <table class="memname">

  823.         <tr>

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

  825.           <td>(</td>

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

  827.           <td></td>

  828.         </tr>

  829.       </table>

  830.   </td>

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

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

  833.   </tr>

  834. </table>

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

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

  837. 

  838. </div>

  839. </div>

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

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

  842. 

  843. <div class="memitem">

  844. <div class="memproto">

  845. <table class="mlabels">

  846.   <tr>

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

  848.       <table class="memname">

  849.         <tr>

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

  851.           <td>(</td>

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

  853.           <td> const</td>

  854.         </tr>

  855.       </table>

  856.   </td>

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

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

  859.   </tr>

  860. </table>

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

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

  863. 

  864. </div>

  865. </div>

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

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

  868. 

  869. <div class="memitem">

  870. <div class="memproto">

  871. <table class="mlabels">

  872.   <tr>

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

  874.       <table class="memname">

  875.         <tr>

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

  877.           <td>(</td>

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

  879.           <td> const</td>

  880.         </tr>

  881.       </table>

  882.   </td>

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

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

  885.   </tr>

  886. </table>

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

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

  889. 

  890. </div>

  891. </div>

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

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

  894. 

  895. <div class="memitem">

  896. <div class="memproto">

  897. <table class="mlabels">

  898.   <tr>

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

  900.       <table class="memname">

  901.         <tr>

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

  903.           <td>(</td>

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

  905.           <td> const</td>

  906.         </tr>

  907.       </table>

  908.   </td>

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

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

  911.   </tr>

  912. </table>

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

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

  915. 

  916. </div>

  917. </div>

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

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

  920. 

  921. <div class="memitem">

  922. <div class="memproto">

  923. <table class="mlabels">

  924.   <tr>

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

  926.       <table class="memname">

  927.         <tr>

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

  929.           <td>(</td>

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

  931.           <td> const</td>

  932.         </tr>

  933.       </table>

  934.   </td>

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

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

  937.   </tr>

  938. </table>

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

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

  941. 

  942. </div>

  943. </div>

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

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

  946. 

  947. <div class="memitem">

  948. <div class="memproto">

  949. <table class="mlabels">

  950.   <tr>

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

  952.       <table class="memname">

  953.         <tr>

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

  955.           <td>(</td>

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

  957.           <td> const</td>

  958.         </tr>

  959.       </table>

  960.   </td>

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

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

  963.   </tr>

  964. </table>

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

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

  967. 

  968. </div>

  969. </div>

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

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

  972. 

  973. <div class="memitem">

  974. <div class="memproto">

  975. <table class="mlabels">

  976.   <tr>

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

  978.       <table class="memname">

  979.         <tr>

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

  981.           <td>(</td>

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

  983.           <td> const</td>

  984.         </tr>

  985.       </table>

  986.   </td>

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

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

  989.   </tr>

  990. </table>

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

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

  993. 

  994. </div>

  995. </div>

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

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

  998. 

  999. <div class="memitem">

  1000. <div class="memproto">

  1001. <table class="mlabels">

  1002.   <tr>

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

  1004.       <table class="memname">

  1005.         <tr>

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

  1007.           <td>(</td>

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

  1009.           <td> const</td>

  1010.         </tr>

  1011.       </table>

  1012.   </td>

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

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

  1015.   </tr>

  1016. </table>

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

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

  1019. 

  1020. </div>

  1021. </div>

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

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

  1024. 

  1025. <div class="memitem">

  1026. <div class="memproto">

  1027. <table class="mlabels">

  1028.   <tr>

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

  1030.       <table class="memname">

  1031.         <tr>

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

  1033.           <td>(</td>

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

  1035.           <td> const</td>

  1036.         </tr>

  1037.       </table>

  1038.   </td>

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

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

  1041.   </tr>

  1042. </table>

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

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

  1045. 

  1046. </div>

  1047. </div>

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

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

  1050. 

  1051. <div class="memitem">

  1052. <div class="memproto">

  1053. <table class="mlabels">

  1054.   <tr>

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

  1056.       <table class="memname">

  1057.         <tr>

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

  1059.           <td>(</td>

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

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

  1062.           <td></td>

  1063.         </tr>

  1064.       </table>

  1065.   </td>

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

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

  1068.   </tr>

  1069. </table>

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

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

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

  1073.   <table class="params">

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

  1075.   </table>

  1076.   </dd>

  1077. </dl>

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

  1079. 

  1080. </div>

  1081. </div>

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

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

  1084. 

  1085. <div class="memitem">

  1086. <div class="memproto">

  1087. <table class="mlabels">

  1088.   <tr>

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

  1090.       <table class="memname">

  1091.         <tr>

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

  1093.           <td>(</td>

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

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

  1096.         </tr>

  1097.         <tr>

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

  1099.           <td></td>

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

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

  1102.         </tr>

  1103.         <tr>

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

  1105.           <td></td>

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

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

  1108.         </tr>

  1109.         <tr>

  1110.           <td></td>

  1111.           <td>)</td>

  1112.           <td></td><td></td>

  1113.         </tr>

  1114.       </table>

  1115.   </td>

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

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

  1118.   </tr>

  1119. </table>

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

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

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

  1123.   <table class="params">

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

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

  1126.   </table>

  1127.   </dd>

  1128. </dl>

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

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

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

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

  1133.   <table class="params">

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

  1135.   </table>

  1136.   </dd>

  1137. </dl>

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

  1139. 

  1140. </div>

  1141. </div>

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

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

  1144. 

  1145. <div class="memitem">

  1146. <div class="memproto">

  1147. <table class="mlabels">

  1148.   <tr>

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

  1150.       <table class="memname">

  1151.         <tr>

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

  1153.           <td>(</td>

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

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

  1156.         </tr>

  1157.         <tr>

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

  1159.           <td></td>

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

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

  1162.         </tr>

  1163.         <tr>

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

  1165.           <td></td>

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

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

  1168.         </tr>

  1169.         <tr>

  1170.           <td></td>

  1171.           <td>)</td>

  1172.           <td></td><td></td>

  1173.         </tr>

  1174.       </table>

  1175.   </td>

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

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

  1178.   </tr>

  1179. </table>

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

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

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

  1183.   <table class="params">

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

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

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

  1187.   </table>

  1188.   </dd>

  1189. </dl>

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

  1191. 

  1192. </div>

  1193. </div>

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

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

  1196. 

  1197. <div class="memitem">

  1198. <div class="memproto">

  1199. <table class="mlabels">

  1200.   <tr>

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

  1202.       <table class="memname">

  1203.         <tr>

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

  1205.           <td>(</td>

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

  1207.           <td> const</td>

  1208.         </tr>

  1209.       </table>

  1210.   </td>

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

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

  1213.   </tr>

  1214. </table>

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

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

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

  1218. 

  1219. </div>

  1220. </div>

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

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

  1223. 

  1224. <div class="memitem">

  1225. <div class="memproto">

  1226. <table class="mlabels">

  1227.   <tr>

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

  1229.       <table class="memname">

  1230.         <tr>

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

  1232.           <td>(</td>

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

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

  1235.         </tr>

  1236.         <tr>

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

  1238.           <td></td>

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

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

  1241.         </tr>

  1242.         <tr>

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

  1244.           <td></td>

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

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

  1247.         </tr>

  1248.         <tr>

  1249.           <td></td>

  1250.           <td>)</td>

  1251.           <td></td><td></td>

  1252.         </tr>

  1253.       </table>

  1254.   </td>

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

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

  1257.   </tr>

  1258. </table>

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

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

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

  1262.   <table class="params">

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

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

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

  1266.   </table>

  1267.   </dd>

  1268. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1282. 

  1283. </div>

  1284. </div>

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

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

  1287. 

  1288. <div class="memitem">

  1289. <div class="memproto">

  1290. <table class="mlabels">

  1291.   <tr>

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

  1293.       <table class="memname">

  1294.         <tr>

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

  1296.           <td>(</td>

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

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

  1299.         </tr>

  1300.         <tr>

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

  1302.           <td></td>

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

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

  1305.         </tr>

  1306.         <tr>

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

  1308.           <td></td>

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

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

  1311.         </tr>

  1312.         <tr>

  1313.           <td></td>

  1314.           <td>)</td>

  1315.           <td></td><td></td>

  1316.         </tr>

  1317.       </table>

  1318.   </td>

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

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

  1321.   </tr>

  1322. </table>

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

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

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

  1326.   <table class="params">

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

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

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

  1330.   </table>

  1331.   </dd>

  1332. </dl>

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

  1334. 

  1335. </div>

  1336. </div>

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

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

  1339. 

  1340. <div class="memitem">

  1341. <div class="memproto">

  1342. <table class="mlabels">

  1343.   <tr>

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

  1345.       <table class="memname">

  1346.         <tr>

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

  1348.           <td>(</td>

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

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

  1351.         </tr>

  1352.         <tr>

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

  1354.           <td></td>

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

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

  1357.         </tr>

  1358.         <tr>

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

  1360.           <td></td>

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

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

  1363.         </tr>

  1364.         <tr>

  1365.           <td></td>

  1366.           <td>)</td>

  1367.           <td></td><td></td>

  1368.         </tr>

  1369.       </table>

  1370.   </td>

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

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

  1373.   </tr>

  1374. </table>

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

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

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

  1378.   <table class="params">

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

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

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

  1382.   </table>

  1383.   </dd>

  1384. </dl>

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

  1386. 

  1387. </div>

  1388. </div>

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

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

  1391. 

  1392. <div class="memitem">

  1393. <div class="memproto">

  1394. <table class="mlabels">

  1395.   <tr>

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

  1397.       <table class="memname">

  1398.         <tr>

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

  1400.           <td>(</td>

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

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

  1403.         </tr>

  1404.         <tr>

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

  1406.           <td></td>

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

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

  1409.         </tr>

  1410.         <tr>

  1411.           <td></td>

  1412.           <td>)</td>

  1413.           <td></td><td></td>

  1414.         </tr>

  1415.       </table>

  1416.   </td>

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

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

  1419.   </tr>

  1420. </table>

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

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

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

  1424.   <table class="params">

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

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

  1427.   </table>

  1428.   </dd>

  1429. </dl>

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

  1431. 

  1432. </div>

  1433. </div>

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

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

  1436. 

  1437. <div class="memitem">

  1438. <div class="memproto">

  1439. <table class="mlabels">

  1440.   <tr>

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

  1442.       <table class="memname">

  1443.         <tr>

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

  1445.           <td>(</td>

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

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

  1448.         </tr>

  1449.         <tr>

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

  1451.           <td></td>

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

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

  1454.         </tr>

  1455.         <tr>

  1456.           <td></td>

  1457.           <td>)</td>

  1458.           <td></td><td></td>

  1459.         </tr>

  1460.       </table>

  1461.   </td>

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

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

  1464.   </tr>

  1465. </table>

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

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

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

  1469.   <table class="params">

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

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

  1472.   </table>

  1473.   </dd>

  1474. </dl>

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

  1476. 

  1477. </div>

  1478. </div>

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

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

  1481. 

  1482. <div class="memitem">

  1483. <div class="memproto">

  1484. <table class="mlabels">

  1485.   <tr>

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

  1487.       <table class="memname">

  1488.         <tr>

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

  1490.           <td>(</td>

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

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

  1493.           <td></td>

  1494.         </tr>

  1495.       </table>

  1496.   </td>

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

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

  1499.   </tr>

  1500. </table>

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

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

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

  1504.   <table class="params">

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

  1506.   </table>

  1507.   </dd>

  1508. </dl>

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

  1510. 

  1511. </div>

  1512. </div>

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

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

  1515. 

  1516. <div class="memitem">

  1517. <div class="memproto">

  1518. <table class="mlabels">

  1519.   <tr>

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

  1521.       <table class="memname">

  1522.         <tr>

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

  1524.           <td>(</td>

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

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

  1527.           <td></td>

  1528.         </tr>

  1529.       </table>

  1530.   </td>

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

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

  1533.   </tr>

  1534. </table>

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

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

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

  1538.   <table class="params">

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

  1540.   </table>

  1541.   </dd>

  1542. </dl>

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

  1544. 

  1545. </div>

  1546. </div>

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

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

  1549. 

  1550. <div class="memitem">

  1551. <div class="memproto">

  1552. <table class="mlabels">

  1553.   <tr>

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

  1555.       <table class="memname">

  1556.         <tr>

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

  1558.           <td>(</td>

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

  1560.           <td></td>

  1561.         </tr>

  1562.       </table>

  1563.   </td>

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

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

  1566.   </tr>

  1567. </table>

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

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

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

  1571. 

  1572. </div>

  1573. </div>

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

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

  1576. 

  1577. <div class="memitem">

  1578. <div class="memproto">

  1579. <table class="mlabels">

  1580.   <tr>

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

  1582.       <table class="memname">

  1583.         <tr>

  1584.           <td class="memname">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>

  1585.           <td>(</td>

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

  1587.           <td></td>

  1588.         </tr>

  1589.       </table>

  1590.   </td>

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

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

  1593.   </tr>

  1594. </table>

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

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

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

  1598. 

  1599. </div>

  1600. </div>

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

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

  1603. 

  1604. <div class="memitem">

  1605. <div class="memproto">

  1606. <table class="mlabels">

  1607.   <tr>

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

  1609.       <table class="memname">

  1610.         <tr>

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

  1612.           <td>(</td>

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

  1614.           <td></td>

  1615.         </tr>

  1616.       </table>

  1617.   </td>

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

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

  1620.   </tr>

  1621. </table>

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

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

  1624. 

  1625. </div>

  1626. </div>

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

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

  1629. 

  1630. <div class="memitem">

  1631. <div class="memproto">

  1632. <table class="mlabels">

  1633.   <tr>

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

  1635.       <table class="memname">

  1636.         <tr>

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

  1638.           <td>(</td>

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

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

  1641.           <td></td>

  1642.         </tr>

  1643.       </table>

  1644.   </td>

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

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

  1647.   </tr>

  1648. </table>

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

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

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

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

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

  1654.   <table class="params">

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

  1656.   </table>

  1657.   </dd>

  1658. </dl>

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

  1660. 

  1661. </div>

  1662. </div>

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

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

  1665. 

  1666. <div class="memitem">

  1667. <div class="memproto">

  1668. <table class="mlabels">

  1669.   <tr>

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

  1671.       <table class="memname">

  1672.         <tr>

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

  1674.           <td>(</td>

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

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

  1677.           <td></td>

  1678.         </tr>

  1679.       </table>

  1680.   </td>

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

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

  1683.   </tr>

  1684. </table>

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

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

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

  1688.   <table class="params">

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

  1690.   </table>

  1691.   </dd>

  1692. </dl>

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

  1694. 

  1695. </div>

  1696. </div>

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

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

  1699. 

  1700. <div class="memitem">

  1701. <div class="memproto">

  1702. <table class="mlabels">

  1703.   <tr>

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

  1705.       <table class="memname">

  1706.         <tr>

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

  1708.           <td>(</td>

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

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

  1711.           <td></td>

  1712.         </tr>

  1713.       </table>

  1714.   </td>

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

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

  1717.   </tr>

  1718. </table>

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

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

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

  1722.   <table class="params">

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

  1724.   </table>

  1725.   </dd>

  1726. </dl>

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

  1728. 

  1729. </div>

  1730. </div>

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

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

  1733. 

  1734. <div class="memitem">

  1735. <div class="memproto">

  1736. <table class="mlabels">

  1737.   <tr>

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

  1739.       <table class="memname">

  1740.         <tr>

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

  1742.           <td>(</td>

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

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

  1745.         </tr>

  1746.         <tr>

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

  1748.           <td></td>

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

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

  1751.         </tr>

  1752.         <tr>

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

  1754.           <td></td>

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

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

  1757.         </tr>

  1758.         <tr>

  1759.           <td></td>

  1760.           <td>)</td>

  1761.           <td></td><td></td>

  1762.         </tr>

  1763.       </table>

  1764.   </td>

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

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

  1767.   </tr>

  1768. </table>

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

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

  1771.   <table class="params">

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

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

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

  1775.   </table>

  1776.   </dd>

  1777. </dl>

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

  1779. 

  1780. </div>

  1781. </div>

  1782. <a id="a70eda4191df90f608694c1faede7fb33"></a>

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

  1784. 

  1785. <div class="memitem">

  1786. <div class="memproto">

  1787. <table class="mlabels">

  1788.   <tr>

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

  1790.       <table class="memname">

  1791.         <tr>

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

  1793.           <td>(</td>

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

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

  1796.         </tr>

  1797.         <tr>

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

  1799.           <td></td>

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

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

  1802.         </tr>

  1803.         <tr>

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

  1805.           <td></td>

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

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

  1808.         </tr>

  1809.         <tr>

  1810.           <td></td>

  1811.           <td>)</td>

  1812.           <td></td><td></td>

  1813.         </tr>

  1814.       </table>

  1815.   </td>

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

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

  1818.   </tr>

  1819. </table>

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

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

  1822.   <table class="params">

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

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

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

  1826.   </table>

  1827.   </dd>

  1828. </dl>

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

  1830. 

  1831. </div>

  1832. </div>

  1833. <a id="a9759c13e804c01ff9e7e2ac8fbabc5b8"></a>

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

  1835. 

  1836. <div class="memitem">

  1837. <div class="memproto">

  1838. <div class="memtemplate">

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

  1840. <table class="mlabels">

  1841.   <tr>

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

  1843.       <table class="memname">

  1844.         <tr>

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

  1846.           <td>(</td>

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

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

  1849.         </tr>

  1850.         <tr>

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

  1852.           <td></td>

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

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

  1855.         </tr>

  1856.         <tr>

  1857.           <td></td>

  1858.           <td>)</td>

  1859.           <td></td><td></td>

  1860.         </tr>

  1861.       </table>

  1862.   </td>

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

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

  1865.   </tr>

  1866. </table>

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

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

  1869.   <table class="params">

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

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

  1872.   </table>

  1873.   </dd>

  1874. </dl>

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

  1876. 

  1877. </div>

  1878. </div>

  1879. <a id="a16d527f98cff3ffd3ba8bc594a22d186"></a>

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

  1881. 

  1882. <div class="memitem">

  1883. <div class="memproto">

  1884. <table class="mlabels">

  1885.   <tr>

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

  1887.       <table class="memname">

  1888.         <tr>

  1889.           <td class="memname">size_t ExFatFile::printFileSize </td>

  1890.           <td>(</td>

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

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

  1893.           <td></td>

  1894.         </tr>

  1895.       </table>

  1896.   </td>

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

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

  1899.   </tr>

  1900. </table>

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

  1902. <p>Print a file's size in bytes. </p><dl class="params"><dt>Parameters</dt><dd>

  1903.   <table class="params">

  1904.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Prtin stream for the output. </td></tr>

  1905.   </table>

  1906.   </dd>

  1907. </dl>

  1908. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  1909. 

  1910. </div>

  1911. </div>

  1912. <a id="a16488d3e0d946f108240b7d6c536c6f4"></a>

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

  1914. 

  1915. <div class="memitem">

  1916. <div class="memproto">

  1917. <table class="mlabels">

  1918.   <tr>

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

  1920.       <table class="memname">

  1921.         <tr>

  1922.           <td class="memname">size_t ExFatFile::printModifyDateTime </td>

  1923.           <td>(</td>

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

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

  1926.           <td></td>

  1927.         </tr>

  1928.       </table>

  1929.   </td>

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

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

  1932.   </tr>

  1933. </table>

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

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

  1936. <dl class="params"><dt>Parameters</dt><dd>

  1937.   <table class="params">

  1938.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1939.   </table>

  1940.   </dd>

  1941. </dl>

  1942. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1943. 

  1944. </div>

  1945. </div>

  1946. <a id="a095c0a865e5e5b6463c3dc0c90680635"></a>

  1947. <h2 class="memtitle"><span class="permalink"><a href="#a095c0a865e5e5b6463c3dc0c90680635">&#9670;&nbsp;</a></span>printName()</h2>

  1948. 

  1949. <div class="memitem">

  1950. <div class="memproto">

  1951. <table class="mlabels">

  1952.   <tr>

  1953.   <td class="mlabels-left">

  1954.       <table class="memname">

  1955.         <tr>

  1956.           <td class="memname">size_t ExFatFile::printName </td>

  1957.           <td>(</td>

  1958.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  1959.           <td class="paramname"><em>pr</em></td><td>)</td>

  1960.           <td></td>

  1961.         </tr>

  1962.       </table>

  1963.   </td>

  1964.   <td class="mlabels-right">

  1965. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1966.   </tr>

  1967. </table>

  1968. </div><div class="memdoc">

  1969. <p>Print a file's name</p>

  1970. <dl class="params"><dt>Parameters</dt><dd>

  1971.   <table class="params">

  1972.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1973.   </table>

  1974.   </dd>

  1975. </dl>

  1976. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1977. 

  1978. </div>

  1979. </div>

  1980. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  1981. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  1982. 

  1983. <div class="memitem">

  1984. <div class="memproto">

  1985. <table class="mlabels">

  1986.   <tr>

  1987.   <td class="mlabels-left">

  1988.       <table class="memname">

  1989.         <tr>

  1990.           <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>

  1991.           <td>(</td>

  1992.           <td class="paramname"></td><td>)</td>

  1993.           <td></td>

  1994.         </tr>

  1995.       </table>

  1996.   </td>

  1997.   <td class="mlabels-right">

  1998. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1999.   </tr>

  2000. </table>

  2001. </div><div class="memdoc">

  2002. <p>Read the next byte from a file.</p>

  2003. <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>

  2004. 

  2005. </div>

  2006. </div>

  2007. <a id="a5ae5477efe55179cf07e173c62654313"></a>

  2008. <h2 class="memtitle"><span class="permalink"><a href="#a5ae5477efe55179cf07e173c62654313">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2009. 

  2010. <div class="memitem">

  2011. <div class="memproto">

  2012. <table class="mlabels">

  2013.   <tr>

  2014.   <td class="mlabels-left">

  2015.       <table class="memname">

  2016.         <tr>

  2017.           <td class="memname">int ExFatFile::read </td>

  2018.           <td>(</td>

  2019.           <td class="paramtype">void *&#160;</td>

  2020.           <td class="paramname"><em>buf</em>, </td>

  2021.         </tr>

  2022.         <tr>

  2023.           <td class="paramkey"></td>

  2024.           <td></td>

  2025.           <td class="paramtype">size_t&#160;</td>

  2026.           <td class="paramname"><em>count</em>&#160;</td>

  2027.         </tr>

  2028.         <tr>

  2029.           <td></td>

  2030.           <td>)</td>

  2031.           <td></td><td></td>

  2032.         </tr>

  2033.       </table>

  2034.   </td>

  2035.   <td class="mlabels-right">

  2036. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2037.   </tr>

  2038. </table>

  2039. </div><div class="memdoc">

  2040. <p>Read data from a file starting at the current position.</p>

  2041. <dl class="params"><dt>Parameters</dt><dd>

  2042.   <table class="params">

  2043.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2044.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2045.   </table>

  2046.   </dd>

  2047. </dl>

  2048. <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>

  2049. 

  2050. </div>

  2051. </div>

  2052. <a id="a8e88c8e79551a72cc98310038514c47a"></a>

  2053. <h2 class="memtitle"><span class="permalink"><a href="#a8e88c8e79551a72cc98310038514c47a">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2054. 

  2055. <div class="memitem">

  2056. <div class="memproto">

  2057. <table class="mlabels">

  2058.   <tr>

  2059.   <td class="mlabels-left">

  2060.       <table class="memname">

  2061.         <tr>

  2062.           <td class="memname">bool ExFatFile::remove </td>

  2063.           <td>(</td>

  2064.           <td class="paramname"></td><td>)</td>

  2065.           <td></td>

  2066.         </tr>

  2067.       </table>

  2068.   </td>

  2069.   <td class="mlabels-right">

  2070. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2071.   </tr>

  2072. </table>

  2073. </div><div class="memdoc">

  2074. <p>Remove a file.</p>

  2075. <p>The directory entry and all data for the file are deleted.</p>

  2076. <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>

  2077. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2078. 

  2079. </div>

  2080. </div>

  2081. <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>

  2082. <h2 class="memtitle"><span class="permalink"><a href="#ad10417a851dba3d40a78eb2c0eb11fff">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2083. 

  2084. <div class="memitem">

  2085. <div class="memproto">

  2086. <table class="mlabels">

  2087.   <tr>

  2088.   <td class="mlabels-left">

  2089.       <table class="memname">

  2090.         <tr>

  2091.           <td class="memname">bool ExFatFile::remove </td>

  2092.           <td>(</td>

  2093.           <td class="paramtype">const ExChar_t *&#160;</td>

  2094.           <td class="paramname"><em>path</em></td><td>)</td>

  2095.           <td></td>

  2096.         </tr>

  2097.       </table>

  2098.   </td>

  2099.   <td class="mlabels-right">

  2100. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2101.   </tr>

  2102. </table>

  2103. </div><div class="memdoc">

  2104. <p>Remove a file.</p>

  2105. <p>The directory entry and all data for the file are deleted.</p>

  2106. <dl class="params"><dt>Parameters</dt><dd>

  2107.   <table class="params">

  2108.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2109.   </table>

  2110.   </dd>

  2111. </dl>

  2112. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2113. <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>

  2114. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2115. 

  2116. </div>

  2117. </div>

  2118. <a id="aab50b2646035f76834c75230d2b55c64"></a>

  2119. <h2 class="memtitle"><span class="permalink"><a href="#aab50b2646035f76834c75230d2b55c64">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2120. 

  2121. <div class="memitem">

  2122. <div class="memproto">

  2123. <table class="mlabels">

  2124.   <tr>

  2125.   <td class="mlabels-left">

  2126.       <table class="memname">

  2127.         <tr>

  2128.           <td class="memname">bool ExFatFile::rename </td>

  2129.           <td>(</td>

  2130.           <td class="paramtype">const ExChar_t *&#160;</td>

  2131.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2132.           <td></td>

  2133.         </tr>

  2134.       </table>

  2135.   </td>

  2136.   <td class="mlabels-right">

  2137. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2138.   </tr>

  2139. </table>

  2140. </div><div class="memdoc">

  2141. <p>Rename a file or subdirectory.</p>

  2142. <dl class="params"><dt>Parameters</dt><dd>

  2143.   <table class="params">

  2144.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2145.   </table>

  2146.   </dd>

  2147. </dl>

  2148. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2149. 

  2150. </div>

  2151. </div>

  2152. <a id="aea570a3b6afbe633d874803b137a46b8"></a>

  2153. <h2 class="memtitle"><span class="permalink"><a href="#aea570a3b6afbe633d874803b137a46b8">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2154. 

  2155. <div class="memitem">

  2156. <div class="memproto">

  2157. <table class="mlabels">

  2158.   <tr>

  2159.   <td class="mlabels-left">

  2160.       <table class="memname">

  2161.         <tr>

  2162.           <td class="memname">bool ExFatFile::rename </td>

  2163.           <td>(</td>

  2164.           <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> *&#160;</td>

  2165.           <td class="paramname"><em>dirFile</em>, </td>

  2166.         </tr>

  2167.         <tr>

  2168.           <td class="paramkey"></td>

  2169.           <td></td>

  2170.           <td class="paramtype">const ExChar_t *&#160;</td>

  2171.           <td class="paramname"><em>newPath</em>&#160;</td>

  2172.         </tr>

  2173.         <tr>

  2174.           <td></td>

  2175.           <td>)</td>

  2176.           <td></td><td></td>

  2177.         </tr>

  2178.       </table>

  2179.   </td>

  2180.   <td class="mlabels-right">

  2181. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2182.   </tr>

  2183. </table>

  2184. </div><div class="memdoc">

  2185. <p>Rename a file or subdirectory.</p>

  2186. <dl class="params"><dt>Parameters</dt><dd>

  2187.   <table class="params">

  2188.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2189.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2190.   </table>

  2191.   </dd>

  2192. </dl>

  2193. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2194. 

  2195. </div>

  2196. </div>

  2197. <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>

  2198. <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">&#9670;&nbsp;</a></span>rewind()</h2>

  2199. 

  2200. <div class="memitem">

  2201. <div class="memproto">

  2202. <table class="mlabels">

  2203.   <tr>

  2204.   <td class="mlabels-left">

  2205.       <table class="memname">

  2206.         <tr>

  2207.           <td class="memname">void ExFatFile::rewind </td>

  2208.           <td>(</td>

  2209.           <td class="paramname"></td><td>)</td>

  2210.           <td></td>

  2211.         </tr>

  2212.       </table>

  2213.   </td>

  2214.   <td class="mlabels-right">

  2215. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2216.   </tr>

  2217. </table>

  2218. </div><div class="memdoc">

  2219. <p>Set the file's current position to zero. </p>

  2220. 

  2221. </div>

  2222. </div>

  2223. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  2224. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  2225. 

  2226. <div class="memitem">

  2227. <div class="memproto">

  2228. <table class="mlabels">

  2229.   <tr>

  2230.   <td class="mlabels-left">

  2231.       <table class="memname">

  2232.         <tr>

  2233.           <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>

  2234.           <td>(</td>

  2235.           <td class="paramname"></td><td>)</td>

  2236.           <td></td>

  2237.         </tr>

  2238.       </table>

  2239.   </td>

  2240.   <td class="mlabels-right">

  2241. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2242.   </tr>

  2243. </table>

  2244. </div><div class="memdoc">

  2245. <p>Rewind a file if it is a directory </p>

  2246. 

  2247. </div>

  2248. </div>

  2249. <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>

  2250. <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">&#9670;&nbsp;</a></span>rmdir()</h2>

  2251. 

  2252. <div class="memitem">

  2253. <div class="memproto">

  2254. <table class="mlabels">

  2255.   <tr>

  2256.   <td class="mlabels-left">

  2257.       <table class="memname">

  2258.         <tr>

  2259.           <td class="memname">bool ExFatFile::rmdir </td>

  2260.           <td>(</td>

  2261.           <td class="paramname"></td><td>)</td>

  2262.           <td></td>

  2263.         </tr>

  2264.       </table>

  2265.   </td>

  2266.   <td class="mlabels-right">

  2267. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2268.   </tr>

  2269. </table>

  2270. </div><div class="memdoc">

  2271. <p>Remove a directory file.</p>

  2272. <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>

  2273. <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>

  2274. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2275. 

  2276. </div>

  2277. </div>

  2278. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  2279. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  2280. 

  2281. <div class="memitem">

  2282. <div class="memproto">

  2283. <table class="mlabels">

  2284.   <tr>

  2285.   <td class="mlabels-left">

  2286.       <table class="memname">

  2287.         <tr>

  2288.           <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>

  2289.           <td>(</td>

  2290.           <td class="paramtype">uint64_t&#160;</td>

  2291.           <td class="paramname"><em>pos</em></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. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  2302. <dl class="params"><dt>Parameters</dt><dd>

  2303.   <table class="params">

  2304.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2305.   </table>

  2306.   </dd>

  2307. </dl>

  2308. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2309. 

  2310. </div>

  2311. </div>

  2312. <a id="ab42494880cf229adfb0fc8edb0647686"></a>

  2313. <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">&#9670;&nbsp;</a></span>seekCur()</h2>

  2314. 

  2315. <div class="memitem">

  2316. <div class="memproto">

  2317. <table class="mlabels">

  2318.   <tr>

  2319.   <td class="mlabels-left">

  2320.       <table class="memname">

  2321.         <tr>

  2322.           <td class="memname">bool ExFatFile::seekCur </td>

  2323.           <td>(</td>

  2324.           <td class="paramtype">int64_t&#160;</td>

  2325.           <td class="paramname"><em>offset</em></td><td>)</td>

  2326.           <td></td>

  2327.         </tr>

  2328.       </table>

  2329.   </td>

  2330.   <td class="mlabels-right">

  2331. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2332.   </tr>

  2333. </table>

  2334. </div><div class="memdoc">

  2335. <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>

  2336.   <table class="params">

  2337.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2338.   </table>

  2339.   </dd>

  2340. </dl>

  2341. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2342. 

  2343. </div>

  2344. </div>

  2345. <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>

  2346. <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2347. 

  2348. <div class="memitem">

  2349. <div class="memproto">

  2350. <table class="mlabels">

  2351.   <tr>

  2352.   <td class="mlabels-left">

  2353.       <table class="memname">

  2354.         <tr>

  2355.           <td class="memname">bool ExFatFile::seekEnd </td>

  2356.           <td>(</td>

  2357.           <td class="paramtype">int64_t&#160;</td>

  2358.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2359.           <td></td>

  2360.         </tr>

  2361.       </table>

  2362.   </td>

  2363.   <td class="mlabels-right">

  2364. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2365.   </tr>

  2366. </table>

  2367. </div><div class="memdoc">

  2368. <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>

  2369.   <table class="params">

  2370.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2371.   </table>

  2372.   </dd>

  2373. </dl>

  2374. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2375. 

  2376. </div>

  2377. </div>

  2378. <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>

  2379. <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">&#9670;&nbsp;</a></span>seekSet()</h2>

  2380. 

  2381. <div class="memitem">

  2382. <div class="memproto">

  2383. <table class="mlabels">

  2384.   <tr>

  2385.   <td class="mlabels-left">

  2386.       <table class="memname">

  2387.         <tr>

  2388.           <td class="memname">bool ExFatFile::seekSet </td>

  2389.           <td>(</td>

  2390.           <td class="paramtype">uint64_t&#160;</td>

  2391.           <td class="paramname"><em>pos</em></td><td>)</td>

  2392.           <td></td>

  2393.         </tr>

  2394.       </table>

  2395.   </td>

  2396.   <td class="mlabels-right">

  2397. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2398.   </tr>

  2399. </table>

  2400. </div><div class="memdoc">

  2401. <p>Sets a file's position.</p>

  2402. <dl class="params"><dt>Parameters</dt><dd>

  2403.   <table class="params">

  2404.     <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>

  2405.   </table>

  2406.   </dd>

  2407. </dl>

  2408. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2409. 

  2410. </div>

  2411. </div>

  2412. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  2413. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  2414. 

  2415. <div class="memitem">

  2416. <div class="memproto">

  2417. <table class="mlabels">

  2418.   <tr>

  2419.   <td class="mlabels-left">

  2420.       <table class="memname">

  2421.         <tr>

  2422.           <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>

  2423.           <td>(</td>

  2424.           <td class="paramname"></td><td>)</td>

  2425.           <td></td>

  2426.         </tr>

  2427.       </table>

  2428.   </td>

  2429.   <td class="mlabels-right">

  2430. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2431.   </tr>

  2432. </table>

  2433. </div><div class="memdoc">

  2434. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  2435. 

  2436. </div>

  2437. </div>

  2438. <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>

  2439. <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">&#9670;&nbsp;</a></span>sync()</h2>

  2440. 

  2441. <div class="memitem">

  2442. <div class="memproto">

  2443. <table class="mlabels">

  2444.   <tr>

  2445.   <td class="mlabels-left">

  2446.       <table class="memname">

  2447.         <tr>

  2448.           <td class="memname">bool ExFatFile::sync </td>

  2449.           <td>(</td>

  2450.           <td class="paramname"></td><td>)</td>

  2451.           <td></td>

  2452.         </tr>

  2453.       </table>

  2454.   </td>

  2455.   <td class="mlabels-right">

  2456. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2457.   </tr>

  2458. </table>

  2459. </div><div class="memdoc">

  2460. <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>

  2461. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2462. 

  2463. </div>

  2464. </div>

  2465. <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>

  2466. <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">&#9670;&nbsp;</a></span>timestamp()</h2>

  2467. 

  2468. <div class="memitem">

  2469. <div class="memproto">

  2470. <table class="mlabels">

  2471.   <tr>

  2472.   <td class="mlabels-left">

  2473.       <table class="memname">

  2474.         <tr>

  2475.           <td class="memname">bool ExFatFile::timestamp </td>

  2476.           <td>(</td>

  2477.           <td class="paramtype">uint8_t&#160;</td>

  2478.           <td class="paramname"><em>flags</em>, </td>

  2479.         </tr>

  2480.         <tr>

  2481.           <td class="paramkey"></td>

  2482.           <td></td>

  2483.           <td class="paramtype">uint16_t&#160;</td>

  2484.           <td class="paramname"><em>year</em>, </td>

  2485.         </tr>

  2486.         <tr>

  2487.           <td class="paramkey"></td>

  2488.           <td></td>

  2489.           <td class="paramtype">uint8_t&#160;</td>

  2490.           <td class="paramname"><em>month</em>, </td>

  2491.         </tr>

  2492.         <tr>

  2493.           <td class="paramkey"></td>

  2494.           <td></td>

  2495.           <td class="paramtype">uint8_t&#160;</td>

  2496.           <td class="paramname"><em>day</em>, </td>

  2497.         </tr>

  2498.         <tr>

  2499.           <td class="paramkey"></td>

  2500.           <td></td>

  2501.           <td class="paramtype">uint8_t&#160;</td>

  2502.           <td class="paramname"><em>hour</em>, </td>

  2503.         </tr>

  2504.         <tr>

  2505.           <td class="paramkey"></td>

  2506.           <td></td>

  2507.           <td class="paramtype">uint8_t&#160;</td>

  2508.           <td class="paramname"><em>minute</em>, </td>

  2509.         </tr>

  2510.         <tr>

  2511.           <td class="paramkey"></td>

  2512.           <td></td>

  2513.           <td class="paramtype">uint8_t&#160;</td>

  2514.           <td class="paramname"><em>second</em>&#160;</td>

  2515.         </tr>

  2516.         <tr>

  2517.           <td></td>

  2518.           <td>)</td>

  2519.           <td></td><td></td>

  2520.         </tr>

  2521.       </table>

  2522.   </td>

  2523.   <td class="mlabels-right">

  2524. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2525.   </tr>

  2526. </table>

  2527. </div><div class="memdoc">

  2528. <p>Truncate a file at the current file position.</p>

  2529. <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>

  2530. <dl class="params"><dt>Parameters</dt><dd>

  2531.   <table class="params">

  2532.     <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>

  2533.   </table>

  2534.   </dd>

  2535. </dl>

  2536. <p>T_ACCESS - Set the file's last access date.</p>

  2537. <p>T_CREATE - Set the file's creation date and time.</p>

  2538. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2539. <dl class="params"><dt>Parameters</dt><dd>

  2540.   <table class="params">

  2541.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2542.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2543.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2544.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2545.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2546.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2547.   </table>

  2548.   </dd>

  2549. </dl>

  2550. <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>

  2551. <dd>

  2552. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2553. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2554. 

  2555. </div>

  2556. </div>

  2557. <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>

  2558. <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2559. 

  2560. <div class="memitem">

  2561. <div class="memproto">

  2562. <table class="mlabels">

  2563.   <tr>

  2564.   <td class="mlabels-left">

  2565.       <table class="memname">

  2566.         <tr>

  2567.           <td class="memname">bool ExFatFile::truncate </td>

  2568.           <td>(</td>

  2569.           <td class="paramname"></td><td>)</td>

  2570.           <td></td>

  2571.         </tr>

  2572.       </table>

  2573.   </td>

  2574.   <td class="mlabels-right">

  2575. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2576.   </tr>

  2577. </table>

  2578. </div><div class="memdoc">

  2579. <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>

  2580. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2581. 

  2582. </div>

  2583. </div>

  2584. <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>

  2585. <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2586. 

  2587. <div class="memitem">

  2588. <div class="memproto">

  2589. <table class="mlabels">

  2590.   <tr>

  2591.   <td class="mlabels-left">

  2592.       <table class="memname">

  2593.         <tr>

  2594.           <td class="memname">bool ExFatFile::truncate </td>

  2595.           <td>(</td>

  2596.           <td class="paramtype">uint64_t&#160;</td>

  2597.           <td class="paramname"><em>length</em></td><td>)</td>

  2598.           <td></td>

  2599.         </tr>

  2600.       </table>

  2601.   </td>

  2602.   <td class="mlabels-right">

  2603. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2604.   </tr>

  2605. </table>

  2606. </div><div class="memdoc">

  2607. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2608. <dl class="params"><dt>Parameters</dt><dd>

  2609.   <table class="params">

  2610.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2611.   </table>

  2612.   </dd>

  2613. </dl>

  2614. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2615. 

  2616. </div>

  2617. </div>

  2618. <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>

  2619. <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">&#9670;&nbsp;</a></span>validLength()</h2>

  2620. 

  2621. <div class="memitem">

  2622. <div class="memproto">

  2623. <table class="mlabels">

  2624.   <tr>

  2625.   <td class="mlabels-left">

  2626.       <table class="memname">

  2627.         <tr>

  2628.           <td class="memname">uint64_t ExFatFile::validLength </td>

  2629.           <td>(</td>

  2630.           <td class="paramname"></td><td>)</td>

  2631.           <td></td>

  2632.         </tr>

  2633.       </table>

  2634.   </td>

  2635.   <td class="mlabels-right">

  2636. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2637.   </tr>

  2638. </table>

  2639. </div><div class="memdoc">

  2640. <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>

  2641. 

  2642. </div>

  2643. </div>

  2644. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  2645. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>

  2646. 

  2647. <div class="memitem">

  2648. <div class="memproto">

  2649. <table class="mlabels">

  2650.   <tr>

  2651.   <td class="mlabels-left">

  2652.       <table class="memname">

  2653.         <tr>

  2654.           <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>

  2655.           <td>(</td>

  2656.           <td class="paramtype">uint8_t&#160;</td>

  2657.           <td class="paramname"><em>b</em></td><td>)</td>

  2658.           <td></td>

  2659.         </tr>

  2660.       </table>

  2661.   </td>

  2662.   <td class="mlabels-right">

  2663. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2664.   </tr>

  2665. </table>

  2666. </div><div class="memdoc">

  2667. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2668.   <table class="params">

  2669.     <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>

  2670.   </table>

  2671.   </dd>

  2672. </dl>

  2673. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  2674. 

  2675. </div>

  2676. </div>

  2677. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  2678. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>

  2679. 

  2680. <div class="memitem">

  2681. <div class="memproto">

  2682. <table class="mlabels">

  2683.   <tr>

  2684.   <td class="mlabels-left">

  2685.       <table class="memname">

  2686.         <tr>

  2687.           <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>

  2688.           <td>(</td>

  2689.           <td class="paramtype">const uint8_t *&#160;</td>

  2690.           <td class="paramname"><em>buffer</em>, </td>

  2691.         </tr>

  2692.         <tr>

  2693.           <td class="paramkey"></td>

  2694.           <td></td>

  2695.           <td class="paramtype">size_t&#160;</td>

  2696.           <td class="paramname"><em>size</em>&#160;</td>

  2697.         </tr>

  2698.         <tr>

  2699.           <td></td>

  2700.           <td>)</td>

  2701.           <td></td><td></td>

  2702.         </tr>

  2703.       </table>

  2704.   </td>

  2705.   <td class="mlabels-right">

  2706. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2707.   </tr>

  2708. </table>

  2709. </div><div class="memdoc">

  2710. <p>Write data to an open file.</p>

  2711. <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>

  2712. <dl class="params"><dt>Parameters</dt><dd>

  2713.   <table class="params">

  2714.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  2715.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  2716.   </table>

  2717.   </dd>

  2718. </dl>

  2719. <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>

  2720. 

  2721. </div>

  2722. </div>

  2723. <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>

  2724. <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>

  2725. 

  2726. <div class="memitem">

  2727. <div class="memproto">

  2728. <table class="mlabels">

  2729.   <tr>

  2730.   <td class="mlabels-left">

  2731.       <table class="memname">

  2732.         <tr>

  2733.           <td class="memname">size_t ExFatFile::write </td>

  2734.           <td>(</td>

  2735.           <td class="paramtype">const char *&#160;</td>

  2736.           <td class="paramname"><em>str</em></td><td>)</td>

  2737.           <td></td>

  2738.         </tr>

  2739.       </table>

  2740.   </td>

  2741.   <td class="mlabels-right">

  2742. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2743.   </tr>

  2744. </table>

  2745. </div><div class="memdoc">

  2746. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2747.   <table class="params">

  2748.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2749.   </table>

  2750.   </dd>

  2751. </dl>

  2752. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2753. 

  2754. </div>

  2755. </div>

  2756. <a id="abc1423c7b550614d1067e7173f8b46a8"></a>

  2757. <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>

  2758. 

  2759. <div class="memitem">

  2760. <div class="memproto">

  2761. <table class="mlabels">

  2762.   <tr>

  2763.   <td class="mlabels-left">

  2764.       <table class="memname">

  2765.         <tr>

  2766.           <td class="memname">size_t ExFatFile::write </td>

  2767.           <td>(</td>

  2768.           <td class="paramtype">const void *&#160;</td>

  2769.           <td class="paramname"><em>buf</em>, </td>

  2770.         </tr>

  2771.         <tr>

  2772.           <td class="paramkey"></td>

  2773.           <td></td>

  2774.           <td class="paramtype">size_t&#160;</td>

  2775.           <td class="paramname"><em>count</em>&#160;</td>

  2776.         </tr>

  2777.         <tr>

  2778.           <td></td>

  2779.           <td>)</td>

  2780.           <td></td><td></td>

  2781.         </tr>

  2782.       </table>

  2783.   </td>

  2784.   <td class="mlabels-right">

  2785. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2786.   </tr>

  2787. </table>

  2788. </div><div class="memdoc">

  2789. <p>Write data to an open file.</p>

  2790. <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>

  2791. <dl class="params"><dt>Parameters</dt><dd>

  2792.   <table class="params">

  2793.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2794.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2795.   </table>

  2796.   </dd>

  2797. </dl>

  2798. <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>

  2799. 

  2800. </div>

  2801. </div>

  2802. <hr/>The documentation for this class was generated from the following file:<ul>

  2803. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>

  2804. </ul>

  2805. </div><!-- contents -->

  2806. <!-- start footer part -->

  2807. <hr class="footer"/><address class="footer"><small>

  2808. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2809. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2810. </a> 1.8.14

  2811. </small></address>

  2812. </body>

  2813. </html>