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

2353 lines
107KB
Raw Permalink Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

  66. <a href="#friends">Friends</a> &#124;

  67. <a href="class_ex_fat_file-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">ExFatFile Class Reference</div>  </div>

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

  71. <div class="contents">

  72. 

  73. <p>Basic file class.  

  74.  <a href="class_ex_fat_file.html#details">More...</a></p>

  75. 

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

  77. <div class="dynheader">

  78. Inheritance diagram for ExFatFile:</div>

  79. <div class="dyncontent">

  80. <div class="center"><img src="class_ex_fat_file__inherit__graph.png" border="0" usemap="#_ex_fat_file_inherit__map" alt="Inheritance graph"/></div>

  81. <map name="_ex_fat_file_inherit__map" id="_ex_fat_file_inherit__map">

  82. <area shape="rect" title="Basic file class." alt="" coords="45,5,123,32"/>

  83. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="5,80,163,121"/>

  84. <area shape="rect" href="class_ex_file.html" title="exFAT file with Arduino Stream." alt="" coords="55,169,113,196"/>

  85. </map>

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

  87. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  122. <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 *name, size_t size)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  223. <tr class="memitem:afd011d17d66707623c28927a63f81015"><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#afd011d17d66707623c28927a63f81015">write</a> (uint8_t b)</td></tr>

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

  225. </table><table class="memberdecls">

  226. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  227. Friends</h2></td></tr>

  228. <tr class="memitem:a064869383f7639b113eb0aaf0b84335c"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a064869383f7639b113eb0aaf0b84335c">ExFatVolume</a></td></tr>

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

  230. </table>

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

  232. <div class="textblock"><p>Basic file class. </p>

  233. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  234. <a id="a3c1303c37cad370b33f0279524c93720"></a>

  235. <h2 class="memtitle"><span class="permalink"><a href="#a3c1303c37cad370b33f0279524c93720">&#9670;&nbsp;</a></span>ExFatFile()</h2>

  236. 

  237. <div class="memitem">

  238. <div class="memproto">

  239. <table class="mlabels">

  240.   <tr>

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

  242.       <table class="memname">

  243.         <tr>

  244.           <td class="memname">ExFatFile::ExFatFile </td>

  245.           <td>(</td>

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

  247.           <td></td>

  248.         </tr>

  249.       </table>

  250.   </td>

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

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

  253.   </tr>

  254. </table>

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

  256. <p>Create an instance. </p>

  257. 

  258. </div>

  259. </div>

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

  261. <a id="a1eae02704b69e903ea174c5d0744debb"></a>

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

  263. 

  264. <div class="memitem">

  265. <div class="memproto">

  266. <table class="mlabels">

  267.   <tr>

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

  269.       <table class="memname">

  270.         <tr>

  271.           <td class="memname">int ExFatFile::available </td>

  272.           <td>(</td>

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

  274.           <td></td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

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

  284. <p><a class="el" href="class_ex_fat_file.html#adcf47e15b819fe2d6faac2a027ab30f5">available64()</a> is recomended for very large files.</p>

  285. <p>Zero is returned for directory files. </p>

  286. 

  287. </div>

  288. </div>

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

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

  291. 

  292. <div class="memitem">

  293. <div class="memproto">

  294. <table class="mlabels">

  295.   <tr>

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

  297.       <table class="memname">

  298.         <tr>

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

  300.           <td>(</td>

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

  302.           <td></td>

  303.         </tr>

  304.       </table>

  305.   </td>

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

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

  308.   </tr>

  309. </table>

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

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

  312. 

  313. </div>

  314. </div>

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

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

  317. 

  318. <div class="memitem">

  319. <div class="memproto">

  320. <table class="mlabels">

  321.   <tr>

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

  323.       <table class="memname">

  324.         <tr>

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

  326.           <td>(</td>

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

  328.           <td></td>

  329.         </tr>

  330.       </table>

  331.   </td>

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

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

  334.   </tr>

  335. </table>

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

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

  338. 

  339. </div>

  340. </div>

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

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

  343. 

  344. <div class="memitem">

  345. <div class="memproto">

  346. <table class="mlabels">

  347.   <tr>

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

  349.       <table class="memname">

  350.         <tr>

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

  352.           <td>(</td>

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

  354.           <td></td>

  355.         </tr>

  356.       </table>

  357.   </td>

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

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

  360.   </tr>

  361. </table>

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

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

  364. 

  365. </div>

  366. </div>

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

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

  369. 

  370. <div class="memitem">

  371. <div class="memproto">

  372.       <table class="memname">

  373.         <tr>

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

  375.           <td>(</td>

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

  377.           <td></td>

  378.         </tr>

  379.       </table>

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

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

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

  383. 

  384. </div>

  385. </div>

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

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

  388. 

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

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

  394.       <table class="memname">

  395.         <tr>

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

  397.           <td>(</td>

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

  399.           <td> const</td>

  400.         </tr>

  401.       </table>

  402.   </td>

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

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

  405.   </tr>

  406. </table>

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

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

  409. 

  410. </div>

  411. </div>

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

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

  414. 

  415. <div class="memitem">

  416. <div class="memproto">

  417. <table class="mlabels">

  418.   <tr>

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

  420.       <table class="memname">

  421.         <tr>

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

  423.           <td>(</td>

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

  425.           <td></td>

  426.         </tr>

  427.       </table>

  428.   </td>

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

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

  431.   </tr>

  432. </table>

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

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

  435. 

  436. </div>

  437. </div>

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

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

  440. 

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

  451.           <td></td>

  452.         </tr>

  453.       </table>

  454.   </td>

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

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

  457.   </tr>

  458. </table>

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

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

  461. 

  462. </div>

  463. </div>

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

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

  466. 

  467. <div class="memitem">

  468. <div class="memproto">

  469. <table class="mlabels">

  470.   <tr>

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

  472.       <table class="memname">

  473.         <tr>

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

  475.           <td>(</td>

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

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

  478.           <td></td>

  479.         </tr>

  480.       </table>

  481.   </td>

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

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

  484.   </tr>

  485. </table>

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

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

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

  489.   <table class="params">

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

  491.   </table>

  492.   </dd>

  493. </dl>

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

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

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

  497. 

  498. </div>

  499. </div>

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

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

  502. 

  503. <div class="memitem">

  504. <div class="memproto">

  505.       <table class="memname">

  506.         <tr>

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

  508.           <td>(</td>

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

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

  511.           <td></td>

  512.         </tr>

  513.       </table>

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

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

  516.   <table class="params">

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

  518.   </table>

  519.   </dd>

  520. </dl>

  521. 

  522. </div>

  523. </div>

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

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

  526. 

  527. <div class="memitem">

  528. <div class="memproto">

  529.       <table class="memname">

  530.         <tr>

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

  532.           <td>(</td>

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

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

  535.         </tr>

  536.         <tr>

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

  538.           <td></td>

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

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

  541.         </tr>

  542.         <tr>

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

  544.           <td></td>

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

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

  547.         </tr>

  548.         <tr>

  549.           <td></td>

  550.           <td>)</td>

  551.           <td></td><td></td>

  552.         </tr>

  553.       </table>

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

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

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

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

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

  559.   <table class="params">

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

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

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

  563.   </table>

  564.   </dd>

  565. </dl>

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

  567. 

  568. </div>

  569. </div>

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

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

  572. 

  573. <div class="memitem">

  574. <div class="memproto">

  575. <table class="mlabels">

  576.   <tr>

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

  578.       <table class="memname">

  579.         <tr>

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

  581.           <td>(</td>

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

  583.           <td></td>

  584.         </tr>

  585.       </table>

  586.   </td>

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

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

  589.   </tr>

  590. </table>

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

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

  593. 

  594. </div>

  595. </div>

  596. <a id="ab16f38103a13394bffd8aa5be830c4fe"></a>

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

  598. 

  599. <div class="memitem">

  600. <div class="memproto">

  601. <table class="mlabels">

  602.   <tr>

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

  604.       <table class="memname">

  605.         <tr>

  606.           <td class="memname">void ExFatFile::flush </td>

  607.           <td>(</td>

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

  609.           <td></td>

  610.         </tr>

  611.       </table>

  612.   </td>

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

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

  615.   </tr>

  616. </table>

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

  618. <p>Arduino name for <a class="el" href="class_ex_fat_file.html#a2cb3638069afd2d01b79e5dff1a66f55">sync()</a> </p>

  619. 

  620. </div>

  621. </div>

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

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

  624. 

  625. <div class="memitem">

  626. <div class="memproto">

  627.       <table class="memname">

  628.         <tr>

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

  630.           <td>(</td>

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

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

  633.           <td></td>

  634.         </tr>

  635.       </table>

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

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

  638.   <table class="params">

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

  640.   </table>

  641.   </dd>

  642. </dl>

  643. 

  644. </div>

  645. </div>

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

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

  648. 

  649. <div class="memitem">

  650. <div class="memproto">

  651. <table class="mlabels">

  652.   <tr>

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

  654.       <table class="memname">

  655.         <tr>

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

  657.           <td>(</td>

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

  659.           <td></td>

  660.         </tr>

  661.       </table>

  662.   </td>

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

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

  665.   </tr>

  666. </table>

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

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

  669. 

  670. </div>

  671. </div>

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

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

  674. 

  675. <div class="memitem">

  676. <div class="memproto">

  677.       <table class="memname">

  678.         <tr>

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

  680.           <td>(</td>

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

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

  683.         </tr>

  684.         <tr>

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

  686.           <td></td>

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

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

  689.         </tr>

  690.         <tr>

  691.           <td></td>

  692.           <td>)</td>

  693.           <td></td><td></td>

  694.         </tr>

  695.       </table>

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

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

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

  699.   <table class="params">

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

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

  702.   </table>

  703.   </dd>

  704. </dl>

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

  706. 

  707. </div>

  708. </div>

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

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

  711. 

  712. <div class="memitem">

  713. <div class="memproto">

  714. <table class="mlabels">

  715.   <tr>

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

  717.       <table class="memname">

  718.         <tr>

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

  720.           <td>(</td>

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

  722.           <td></td>

  723.         </tr>

  724.       </table>

  725.   </td>

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

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

  728.   </tr>

  729. </table>

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

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

  732. 

  733. </div>

  734. </div>

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

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

  737. 

  738. <div class="memitem">

  739. <div class="memproto">

  740. <table class="mlabels">

  741.   <tr>

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

  743.       <table class="memname">

  744.         <tr>

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

  746.           <td>(</td>

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

  748.           <td> const</td>

  749.         </tr>

  750.       </table>

  751.   </td>

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

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

  754.   </tr>

  755. </table>

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

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

  758. 

  759. </div>

  760. </div>

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

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

  763. 

  764. <div class="memitem">

  765. <div class="memproto">

  766. <table class="mlabels">

  767.   <tr>

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

  769.       <table class="memname">

  770.         <tr>

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

  772.           <td>(</td>

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

  774.           <td> const</td>

  775.         </tr>

  776.       </table>

  777.   </td>

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

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

  780.   </tr>

  781. </table>

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

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

  784. 

  785. </div>

  786. </div>

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

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

  789. 

  790. <div class="memitem">

  791. <div class="memproto">

  792. <table class="mlabels">

  793.   <tr>

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

  795.       <table class="memname">

  796.         <tr>

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

  798.           <td>(</td>

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

  800.           <td> const</td>

  801.         </tr>

  802.       </table>

  803.   </td>

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

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

  806.   </tr>

  807. </table>

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

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

  810. 

  811. </div>

  812. </div>

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

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

  815. 

  816. <div class="memitem">

  817. <div class="memproto">

  818. <table class="mlabels">

  819.   <tr>

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

  821.       <table class="memname">

  822.         <tr>

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

  824.           <td>(</td>

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

  826.           <td> const</td>

  827.         </tr>

  828.       </table>

  829.   </td>

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

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

  832.   </tr>

  833. </table>

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

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

  836. 

  837. </div>

  838. </div>

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

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

  841. 

  842. <div class="memitem">

  843. <div class="memproto">

  844. <table class="mlabels">

  845.   <tr>

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

  847.       <table class="memname">

  848.         <tr>

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

  850.           <td>(</td>

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

  852.           <td> const</td>

  853.         </tr>

  854.       </table>

  855.   </td>

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

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

  858.   </tr>

  859. </table>

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

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

  862. 

  863. </div>

  864. </div>

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

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

  867. 

  868. <div class="memitem">

  869. <div class="memproto">

  870. <table class="mlabels">

  871.   <tr>

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

  873.       <table class="memname">

  874.         <tr>

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

  876.           <td>(</td>

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

  878.           <td> const</td>

  879.         </tr>

  880.       </table>

  881.   </td>

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

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

  884.   </tr>

  885. </table>

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

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

  888. 

  889. </div>

  890. </div>

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

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

  893. 

  894. <div class="memitem">

  895. <div class="memproto">

  896. <table class="mlabels">

  897.   <tr>

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

  899.       <table class="memname">

  900.         <tr>

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

  902.           <td>(</td>

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

  904.           <td> const</td>

  905.         </tr>

  906.       </table>

  907.   </td>

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

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

  910.   </tr>

  911. </table>

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

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

  914. 

  915. </div>

  916. </div>

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

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

  919. 

  920. <div class="memitem">

  921. <div class="memproto">

  922. <table class="mlabels">

  923.   <tr>

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

  925.       <table class="memname">

  926.         <tr>

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

  928.           <td>(</td>

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

  930.           <td> const</td>

  931.         </tr>

  932.       </table>

  933.   </td>

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

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

  936.   </tr>

  937. </table>

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

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

  940. 

  941. </div>

  942. </div>

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

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

  945. 

  946. <div class="memitem">

  947. <div class="memproto">

  948. <table class="mlabels">

  949.   <tr>

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

  951.       <table class="memname">

  952.         <tr>

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

  954.           <td>(</td>

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

  956.           <td> const</td>

  957.         </tr>

  958.       </table>

  959.   </td>

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

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

  962.   </tr>

  963. </table>

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

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

  966. 

  967. </div>

  968. </div>

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

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

  971. 

  972. <div class="memitem">

  973. <div class="memproto">

  974. <table class="mlabels">

  975.   <tr>

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

  977.       <table class="memname">

  978.         <tr>

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

  980.           <td>(</td>

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

  982.           <td> const</td>

  983.         </tr>

  984.       </table>

  985.   </td>

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

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

  988.   </tr>

  989. </table>

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

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

  992. 

  993. </div>

  994. </div>

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

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

  997. 

  998. <div class="memitem">

  999. <div class="memproto">

  1000.       <table class="memname">

  1001.         <tr>

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

  1003.           <td>(</td>

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

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

  1006.           <td></td>

  1007.         </tr>

  1008.       </table>

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

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

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

  1012.   <table class="params">

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

  1014.   </table>

  1015.   </dd>

  1016. </dl>

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

  1018. 

  1019. </div>

  1020. </div>

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

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

  1023. 

  1024. <div class="memitem">

  1025. <div class="memproto">

  1026.       <table class="memname">

  1027.         <tr>

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

  1029.           <td>(</td>

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

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

  1032.         </tr>

  1033.         <tr>

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

  1035.           <td></td>

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

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

  1038.         </tr>

  1039.         <tr>

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

  1041.           <td></td>

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

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

  1044.         </tr>

  1045.         <tr>

  1046.           <td></td>

  1047.           <td>)</td>

  1048.           <td></td><td></td>

  1049.         </tr>

  1050.       </table>

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

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

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

  1054.   <table class="params">

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

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

  1057.   </table>

  1058.   </dd>

  1059. </dl>

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

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

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

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

  1064.   <table class="params">

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

  1066.   </table>

  1067.   </dd>

  1068. </dl>

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

  1070. 

  1071. </div>

  1072. </div>

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

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

  1075. 

  1076. <div class="memitem">

  1077. <div class="memproto">

  1078.       <table class="memname">

  1079.         <tr>

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

  1081.           <td>(</td>

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

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

  1084.         </tr>

  1085.         <tr>

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

  1087.           <td></td>

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

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

  1090.         </tr>

  1091.         <tr>

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

  1093.           <td></td>

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

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

  1096.         </tr>

  1097.         <tr>

  1098.           <td></td>

  1099.           <td>)</td>

  1100.           <td></td><td></td>

  1101.         </tr>

  1102.       </table>

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

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

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

  1106.   <table class="params">

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

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

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

  1110.   </table>

  1111.   </dd>

  1112. </dl>

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

  1114. 

  1115. </div>

  1116. </div>

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

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

  1119. 

  1120. <div class="memitem">

  1121. <div class="memproto">

  1122.       <table class="memname">

  1123.         <tr>

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

  1125.           <td>(</td>

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

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

  1128.         </tr>

  1129.         <tr>

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

  1131.           <td></td>

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

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

  1134.         </tr>

  1135.         <tr>

  1136.           <td></td>

  1137.           <td>)</td>

  1138.           <td></td><td></td>

  1139.         </tr>

  1140.       </table>

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

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

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

  1144.   <table class="params">

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

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

  1147.   </table>

  1148.   </dd>

  1149. </dl>

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

  1151. 

  1152. </div>

  1153. </div>

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

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

  1156. 

  1157. <div class="memitem">

  1158. <div class="memproto">

  1159.       <table class="memname">

  1160.         <tr>

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

  1162.           <td>(</td>

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

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

  1165.         </tr>

  1166.         <tr>

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

  1168.           <td></td>

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

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

  1171.         </tr>

  1172.         <tr>

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

  1174.           <td></td>

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

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

  1177.         </tr>

  1178.         <tr>

  1179.           <td></td>

  1180.           <td>)</td>

  1181.           <td></td><td></td>

  1182.         </tr>

  1183.       </table>

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

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

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

  1187.   <table class="params">

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

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

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

  1191.   </table>

  1192.   </dd>

  1193. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1207. 

  1208. </div>

  1209. </div>

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

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

  1212. 

  1213. <div class="memitem">

  1214. <div class="memproto">

  1215.       <table class="memname">

  1216.         <tr>

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

  1218.           <td>(</td>

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

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

  1221.         </tr>

  1222.         <tr>

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

  1224.           <td></td>

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

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

  1227.         </tr>

  1228.         <tr>

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

  1230.           <td></td>

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

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

  1233.         </tr>

  1234.         <tr>

  1235.           <td></td>

  1236.           <td>)</td>

  1237.           <td></td><td></td>

  1238.         </tr>

  1239.       </table>

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

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

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

  1243.   <table class="params">

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

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

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

  1247.   </table>

  1248.   </dd>

  1249. </dl>

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

  1251. 

  1252. </div>

  1253. </div>

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

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

  1256. 

  1257. <div class="memitem">

  1258. <div class="memproto">

  1259.       <table class="memname">

  1260.         <tr>

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

  1262.           <td>(</td>

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

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

  1265.         </tr>

  1266.         <tr>

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

  1268.           <td></td>

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

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

  1271.         </tr>

  1272.         <tr>

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

  1274.           <td></td>

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

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

  1277.         </tr>

  1278.         <tr>

  1279.           <td></td>

  1280.           <td>)</td>

  1281.           <td></td><td></td>

  1282.         </tr>

  1283.       </table>

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

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

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

  1287.   <table class="params">

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

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

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

  1291.   </table>

  1292.   </dd>

  1293. </dl>

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

  1295. 

  1296. </div>

  1297. </div>

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

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

  1300. 

  1301. <div class="memitem">

  1302. <div class="memproto">

  1303.       <table class="memname">

  1304.         <tr>

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

  1306.           <td>(</td>

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

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

  1309.         </tr>

  1310.         <tr>

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

  1312.           <td></td>

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

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

  1315.         </tr>

  1316.         <tr>

  1317.           <td></td>

  1318.           <td>)</td>

  1319.           <td></td><td></td>

  1320.         </tr>

  1321.       </table>

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

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

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

  1325.   <table class="params">

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

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

  1328.   </table>

  1329.   </dd>

  1330. </dl>

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

  1332. 

  1333. </div>

  1334. </div>

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

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

  1337. 

  1338. <div class="memitem">

  1339. <div class="memproto">

  1340.       <table class="memname">

  1341.         <tr>

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

  1343.           <td>(</td>

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

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

  1346.           <td></td>

  1347.         </tr>

  1348.       </table>

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

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

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

  1352.   <table class="params">

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

  1354.   </table>

  1355.   </dd>

  1356. </dl>

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

  1358. 

  1359. </div>

  1360. </div>

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

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

  1363. 

  1364. <div class="memitem">

  1365. <div class="memproto">

  1366. <table class="mlabels">

  1367.   <tr>

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

  1369.       <table class="memname">

  1370.         <tr>

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

  1372.           <td>(</td>

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

  1374.           <td></td>

  1375.         </tr>

  1376.       </table>

  1377.   </td>

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

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

  1380.   </tr>

  1381. </table>

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

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

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

  1385. 

  1386. </div>

  1387. </div>

  1388. <a id="afc2e375faa696545f7ebbf583faae72a"></a>

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

  1390. 

  1391. <div class="memitem">

  1392. <div class="memproto">

  1393.       <table class="memname">

  1394.         <tr>

  1395.           <td class="memname">int ExFatFile::peek </td>

  1396.           <td>(</td>

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

  1398.           <td></td>

  1399.         </tr>

  1400.       </table>

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

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

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

  1404. 

  1405. </div>

  1406. </div>

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

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

  1409. 

  1410. <div class="memitem">

  1411. <div class="memproto">

  1412.       <table class="memname">

  1413.         <tr>

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

  1415.           <td>(</td>

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

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

  1418.           <td></td>

  1419.         </tr>

  1420.       </table>

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

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

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

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

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

  1426.   <table class="params">

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

  1428.   </table>

  1429.   </dd>

  1430. </dl>

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

  1432. 

  1433. </div>

  1434. </div>

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

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

  1437. 

  1438. <div class="memitem">

  1439. <div class="memproto">

  1440.       <table class="memname">

  1441.         <tr>

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

  1443.           <td>(</td>

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

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

  1446.           <td></td>

  1447.         </tr>

  1448.       </table>

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

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

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

  1452.   <table class="params">

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

  1454.   </table>

  1455.   </dd>

  1456. </dl>

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

  1458. 

  1459. </div>

  1460. </div>

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

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

  1463. 

  1464. <div class="memitem">

  1465. <div class="memproto">

  1466.       <table class="memname">

  1467.         <tr>

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

  1469.           <td>(</td>

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

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

  1472.           <td></td>

  1473.         </tr>

  1474.       </table>

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

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

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

  1478.   <table class="params">

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

  1480.   </table>

  1481.   </dd>

  1482. </dl>

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

  1484. 

  1485. </div>

  1486. </div>

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

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

  1489. 

  1490. <div class="memitem">

  1491. <div class="memproto">

  1492. <table class="mlabels">

  1493.   <tr>

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

  1495.       <table class="memname">

  1496.         <tr>

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

  1498.           <td>(</td>

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

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

  1501.         </tr>

  1502.         <tr>

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

  1504.           <td></td>

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

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

  1507.         </tr>

  1508.         <tr>

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

  1510.           <td></td>

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

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

  1513.         </tr>

  1514.         <tr>

  1515.           <td></td>

  1516.           <td>)</td>

  1517.           <td></td><td></td>

  1518.         </tr>

  1519.       </table>

  1520.   </td>

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

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

  1523.   </tr>

  1524. </table>

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

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

  1527.   <table class="params">

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

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

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

  1531.   </table>

  1532.   </dd>

  1533. </dl>

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

  1535. 

  1536. </div>

  1537. </div>

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

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

  1540. 

  1541. <div class="memitem">

  1542. <div class="memproto">

  1543. <table class="mlabels">

  1544.   <tr>

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

  1546.       <table class="memname">

  1547.         <tr>

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

  1549.           <td>(</td>

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

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

  1552.         </tr>

  1553.         <tr>

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

  1555.           <td></td>

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

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

  1558.         </tr>

  1559.         <tr>

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

  1561.           <td></td>

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

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

  1564.         </tr>

  1565.         <tr>

  1566.           <td></td>

  1567.           <td>)</td>

  1568.           <td></td><td></td>

  1569.         </tr>

  1570.       </table>

  1571.   </td>

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

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

  1574.   </tr>

  1575. </table>

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

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

  1578.   <table class="params">

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

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

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

  1582.   </table>

  1583.   </dd>

  1584. </dl>

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

  1586. 

  1587. </div>

  1588. </div>

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

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

  1591. 

  1592. <div class="memitem">

  1593. <div class="memproto">

  1594. <div class="memtemplate">

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

  1596. <table class="mlabels">

  1597.   <tr>

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

  1599.       <table class="memname">

  1600.         <tr>

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

  1602.           <td>(</td>

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

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

  1605.         </tr>

  1606.         <tr>

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

  1608.           <td></td>

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

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

  1611.         </tr>

  1612.         <tr>

  1613.           <td></td>

  1614.           <td>)</td>

  1615.           <td></td><td></td>

  1616.         </tr>

  1617.       </table>

  1618.   </td>

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

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

  1621.   </tr>

  1622. </table>

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

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

  1625.   <table class="params">

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

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

  1628.   </table>

  1629.   </dd>

  1630. </dl>

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

  1632. 

  1633. </div>

  1634. </div>

  1635. <a id="a16d527f98cff3ffd3ba8bc594a22d186"></a>

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

  1637. 

  1638. <div class="memitem">

  1639. <div class="memproto">

  1640.       <table class="memname">

  1641.         <tr>

  1642.           <td class="memname">size_t ExFatFile::printFileSize </td>

  1643.           <td>(</td>

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

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

  1646.           <td></td>

  1647.         </tr>

  1648.       </table>

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

  1650. <p>Print a file's size in bytes. </p><dl class="params"><dt>Parameters</dt><dd>

  1651.   <table class="params">

  1652.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Prtin stream for the output. </td></tr>

  1653.   </table>

  1654.   </dd>

  1655. </dl>

  1656. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  1657. 

  1658. </div>

  1659. </div>

  1660. <a id="a16488d3e0d946f108240b7d6c536c6f4"></a>

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

  1662. 

  1663. <div class="memitem">

  1664. <div class="memproto">

  1665.       <table class="memname">

  1666.         <tr>

  1667.           <td class="memname">size_t ExFatFile::printModifyDateTime </td>

  1668.           <td>(</td>

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

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

  1671.           <td></td>

  1672.         </tr>

  1673.       </table>

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

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

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

  1677.   <table class="params">

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

  1679.   </table>

  1680.   </dd>

  1681. </dl>

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

  1683. 

  1684. </div>

  1685. </div>

  1686. <a id="a095c0a865e5e5b6463c3dc0c90680635"></a>

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

  1688. 

  1689. <div class="memitem">

  1690. <div class="memproto">

  1691.       <table class="memname">

  1692.         <tr>

  1693.           <td class="memname">size_t ExFatFile::printName </td>

  1694.           <td>(</td>

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

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

  1697.           <td></td>

  1698.         </tr>

  1699.       </table>

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

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

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

  1703.   <table class="params">

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

  1705.   </table>

  1706.   </dd>

  1707. </dl>

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

  1709. 

  1710. </div>

  1711. </div>

  1712. <a id="a77f4fea0aae0c8bae926fdfbba260a55"></a>

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

  1714. 

  1715. <div class="memitem">

  1716. <div class="memproto">

  1717. <table class="mlabels">

  1718.   <tr>

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

  1720.       <table class="memname">

  1721.         <tr>

  1722.           <td class="memname">int ExFatFile::read </td>

  1723.           <td>(</td>

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

  1725.           <td></td>

  1726.         </tr>

  1727.       </table>

  1728.   </td>

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

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

  1731.   </tr>

  1732. </table>

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

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

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

  1736. 

  1737. </div>

  1738. </div>

  1739. <a id="a5ae5477efe55179cf07e173c62654313"></a>

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

  1741. 

  1742. <div class="memitem">

  1743. <div class="memproto">

  1744.       <table class="memname">

  1745.         <tr>

  1746.           <td class="memname">int ExFatFile::read </td>

  1747.           <td>(</td>

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

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

  1750.         </tr>

  1751.         <tr>

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

  1753.           <td></td>

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

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

  1756.         </tr>

  1757.         <tr>

  1758.           <td></td>

  1759.           <td>)</td>

  1760.           <td></td><td></td>

  1761.         </tr>

  1762.       </table>

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

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

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

  1766.   <table class="params">

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

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

  1769.   </table>

  1770.   </dd>

  1771. </dl>

  1772. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_ex_fat_file.html#a77f4fea0aae0c8bae926fdfbba260a55">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_ex_fat_file.html#a77f4fea0aae0c8bae926fdfbba260a55">read()</a> returns -1. </dd></dl>

  1773. 

  1774. </div>

  1775. </div>

  1776. <a id="a8e88c8e79551a72cc98310038514c47a"></a>

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

  1778. 

  1779. <div class="memitem">

  1780. <div class="memproto">

  1781.       <table class="memname">

  1782.         <tr>

  1783.           <td class="memname">bool ExFatFile::remove </td>

  1784.           <td>(</td>

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

  1786.           <td></td>

  1787.         </tr>

  1788.       </table>

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

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

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

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

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

  1794. 

  1795. </div>

  1796. </div>

  1797. <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>

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

  1799. 

  1800. <div class="memitem">

  1801. <div class="memproto">

  1802.       <table class="memname">

  1803.         <tr>

  1804.           <td class="memname">bool ExFatFile::remove </td>

  1805.           <td>(</td>

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

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

  1808.           <td></td>

  1809.         </tr>

  1810.       </table>

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

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

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

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

  1815.   <table class="params">

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

  1817.   </table>

  1818.   </dd>

  1819. </dl>

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

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

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

  1823. 

  1824. </div>

  1825. </div>

  1826. <a id="aab50b2646035f76834c75230d2b55c64"></a>

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

  1828. 

  1829. <div class="memitem">

  1830. <div class="memproto">

  1831.       <table class="memname">

  1832.         <tr>

  1833.           <td class="memname">bool ExFatFile::rename </td>

  1834.           <td>(</td>

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

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

  1837.           <td></td>

  1838.         </tr>

  1839.       </table>

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

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

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

  1843.   <table class="params">

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

  1845.   </table>

  1846.   </dd>

  1847. </dl>

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

  1849. 

  1850. </div>

  1851. </div>

  1852. <a id="aea570a3b6afbe633d874803b137a46b8"></a>

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

  1854. 

  1855. <div class="memitem">

  1856. <div class="memproto">

  1857.       <table class="memname">

  1858.         <tr>

  1859.           <td class="memname">bool ExFatFile::rename </td>

  1860.           <td>(</td>

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

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

  1863.         </tr>

  1864.         <tr>

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

  1866.           <td></td>

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

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

  1869.         </tr>

  1870.         <tr>

  1871.           <td></td>

  1872.           <td>)</td>

  1873.           <td></td><td></td>

  1874.         </tr>

  1875.       </table>

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

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

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

  1879.   <table class="params">

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

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

  1882.   </table>

  1883.   </dd>

  1884. </dl>

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

  1886. 

  1887. </div>

  1888. </div>

  1889. <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>

  1890. <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">&#9670;&nbsp;</a></span>rewind()</h2>

  1891. 

  1892. <div class="memitem">

  1893. <div class="memproto">

  1894. <table class="mlabels">

  1895.   <tr>

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

  1897.       <table class="memname">

  1898.         <tr>

  1899.           <td class="memname">void ExFatFile::rewind </td>

  1900.           <td>(</td>

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

  1902.           <td></td>

  1903.         </tr>

  1904.       </table>

  1905.   </td>

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

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

  1908.   </tr>

  1909. </table>

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

  1911. <p>Set the file's current position to zero. </p>

  1912. 

  1913. </div>

  1914. </div>

  1915. <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>

  1916. <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">&#9670;&nbsp;</a></span>rmdir()</h2>

  1917. 

  1918. <div class="memitem">

  1919. <div class="memproto">

  1920.       <table class="memname">

  1921.         <tr>

  1922.           <td class="memname">bool ExFatFile::rmdir </td>

  1923.           <td>(</td>

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

  1925.           <td></td>

  1926.         </tr>

  1927.       </table>

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

  1929. <p>Remove a directory file.</p>

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

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

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

  1933. 

  1934. </div>

  1935. </div>

  1936. <a id="ab42494880cf229adfb0fc8edb0647686"></a>

  1937. <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">&#9670;&nbsp;</a></span>seekCur()</h2>

  1938. 

  1939. <div class="memitem">

  1940. <div class="memproto">

  1941. <table class="mlabels">

  1942.   <tr>

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

  1944.       <table class="memname">

  1945.         <tr>

  1946.           <td class="memname">bool ExFatFile::seekCur </td>

  1947.           <td>(</td>

  1948.           <td class="paramtype">int64_t&#160;</td>

  1949.           <td class="paramname"><em>offset</em></td><td>)</td>

  1950.           <td></td>

  1951.         </tr>

  1952.       </table>

  1953.   </td>

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

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

  1956.   </tr>

  1957. </table>

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

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

  1960.   <table class="params">

  1961.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  1962.   </table>

  1963.   </dd>

  1964. </dl>

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

  1966. 

  1967. </div>

  1968. </div>

  1969. <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>

  1970. <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">&#9670;&nbsp;</a></span>seekEnd()</h2>

  1971. 

  1972. <div class="memitem">

  1973. <div class="memproto">

  1974. <table class="mlabels">

  1975.   <tr>

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

  1977.       <table class="memname">

  1978.         <tr>

  1979.           <td class="memname">bool ExFatFile::seekEnd </td>

  1980.           <td>(</td>

  1981.           <td class="paramtype">int64_t&#160;</td>

  1982.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  1983.           <td></td>

  1984.         </tr>

  1985.       </table>

  1986.   </td>

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

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

  1989.   </tr>

  1990. </table>

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

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

  1993.   <table class="params">

  1994.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  1995.   </table>

  1996.   </dd>

  1997. </dl>

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

  1999. 

  2000. </div>

  2001. </div>

  2002. <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>

  2003. <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">&#9670;&nbsp;</a></span>seekSet()</h2>

  2004. 

  2005. <div class="memitem">

  2006. <div class="memproto">

  2007.       <table class="memname">

  2008.         <tr>

  2009.           <td class="memname">bool ExFatFile::seekSet </td>

  2010.           <td>(</td>

  2011.           <td class="paramtype">uint64_t&#160;</td>

  2012.           <td class="paramname"><em>pos</em></td><td>)</td>

  2013.           <td></td>

  2014.         </tr>

  2015.       </table>

  2016. </div><div class="memdoc">

  2017. <p>Sets a file's position.</p>

  2018. <dl class="params"><dt>Parameters</dt><dd>

  2019.   <table class="params">

  2020.     <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>

  2021.   </table>

  2022.   </dd>

  2023. </dl>

  2024. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2025. 

  2026. </div>

  2027. </div>

  2028. <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>

  2029. <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">&#9670;&nbsp;</a></span>sync()</h2>

  2030. 

  2031. <div class="memitem">

  2032. <div class="memproto">

  2033.       <table class="memname">

  2034.         <tr>

  2035.           <td class="memname">bool ExFatFile::sync </td>

  2036.           <td>(</td>

  2037.           <td class="paramname"></td><td>)</td>

  2038.           <td></td>

  2039.         </tr>

  2040.       </table>

  2041. </div><div class="memdoc">

  2042. <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>

  2043. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2044. 

  2045. </div>

  2046. </div>

  2047. <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>

  2048. <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">&#9670;&nbsp;</a></span>timestamp()</h2>

  2049. 

  2050. <div class="memitem">

  2051. <div class="memproto">

  2052.       <table class="memname">

  2053.         <tr>

  2054.           <td class="memname">bool ExFatFile::timestamp </td>

  2055.           <td>(</td>

  2056.           <td class="paramtype">uint8_t&#160;</td>

  2057.           <td class="paramname"><em>flags</em>, </td>

  2058.         </tr>

  2059.         <tr>

  2060.           <td class="paramkey"></td>

  2061.           <td></td>

  2062.           <td class="paramtype">uint16_t&#160;</td>

  2063.           <td class="paramname"><em>year</em>, </td>

  2064.         </tr>

  2065.         <tr>

  2066.           <td class="paramkey"></td>

  2067.           <td></td>

  2068.           <td class="paramtype">uint8_t&#160;</td>

  2069.           <td class="paramname"><em>month</em>, </td>

  2070.         </tr>

  2071.         <tr>

  2072.           <td class="paramkey"></td>

  2073.           <td></td>

  2074.           <td class="paramtype">uint8_t&#160;</td>

  2075.           <td class="paramname"><em>day</em>, </td>

  2076.         </tr>

  2077.         <tr>

  2078.           <td class="paramkey"></td>

  2079.           <td></td>

  2080.           <td class="paramtype">uint8_t&#160;</td>

  2081.           <td class="paramname"><em>hour</em>, </td>

  2082.         </tr>

  2083.         <tr>

  2084.           <td class="paramkey"></td>

  2085.           <td></td>

  2086.           <td class="paramtype">uint8_t&#160;</td>

  2087.           <td class="paramname"><em>minute</em>, </td>

  2088.         </tr>

  2089.         <tr>

  2090.           <td class="paramkey"></td>

  2091.           <td></td>

  2092.           <td class="paramtype">uint8_t&#160;</td>

  2093.           <td class="paramname"><em>second</em>&#160;</td>

  2094.         </tr>

  2095.         <tr>

  2096.           <td></td>

  2097.           <td>)</td>

  2098.           <td></td><td></td>

  2099.         </tr>

  2100.       </table>

  2101. </div><div class="memdoc">

  2102. <p>Truncate a file at the current file position.</p>

  2103. <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>

  2104. <dl class="params"><dt>Parameters</dt><dd>

  2105.   <table class="params">

  2106.     <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>

  2107.   </table>

  2108.   </dd>

  2109. </dl>

  2110. <p>T_ACCESS - Set the file's last access date.</p>

  2111. <p>T_CREATE - Set the file's creation date and time.</p>

  2112. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2113. <dl class="params"><dt>Parameters</dt><dd>

  2114.   <table class="params">

  2115.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2116.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2117.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2118.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2119.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2120.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2121.   </table>

  2122.   </dd>

  2123. </dl>

  2124. <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>

  2125. <dd>

  2126. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2127. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2128. 

  2129. </div>

  2130. </div>

  2131. <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>

  2132. <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2133. 

  2134. <div class="memitem">

  2135. <div class="memproto">

  2136.       <table class="memname">

  2137.         <tr>

  2138.           <td class="memname">bool ExFatFile::truncate </td>

  2139.           <td>(</td>

  2140.           <td class="paramname"></td><td>)</td>

  2141.           <td></td>

  2142.         </tr>

  2143.       </table>

  2144. </div><div class="memdoc">

  2145. <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>

  2146. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2147. 

  2148. </div>

  2149. </div>

  2150. <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>

  2151. <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2152. 

  2153. <div class="memitem">

  2154. <div class="memproto">

  2155. <table class="mlabels">

  2156.   <tr>

  2157.   <td class="mlabels-left">

  2158.       <table class="memname">

  2159.         <tr>

  2160.           <td class="memname">bool ExFatFile::truncate </td>

  2161.           <td>(</td>

  2162.           <td class="paramtype">uint64_t&#160;</td>

  2163.           <td class="paramname"><em>length</em></td><td>)</td>

  2164.           <td></td>

  2165.         </tr>

  2166.       </table>

  2167.   </td>

  2168.   <td class="mlabels-right">

  2169. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2170.   </tr>

  2171. </table>

  2172. </div><div class="memdoc">

  2173. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2174. <dl class="params"><dt>Parameters</dt><dd>

  2175.   <table class="params">

  2176.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2177.   </table>

  2178.   </dd>

  2179. </dl>

  2180. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2181. 

  2182. </div>

  2183. </div>

  2184. <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>

  2185. <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">&#9670;&nbsp;</a></span>validLength()</h2>

  2186. 

  2187. <div class="memitem">

  2188. <div class="memproto">

  2189. <table class="mlabels">

  2190.   <tr>

  2191.   <td class="mlabels-left">

  2192.       <table class="memname">

  2193.         <tr>

  2194.           <td class="memname">uint64_t ExFatFile::validLength </td>

  2195.           <td>(</td>

  2196.           <td class="paramname"></td><td>)</td>

  2197.           <td></td>

  2198.         </tr>

  2199.       </table>

  2200.   </td>

  2201.   <td class="mlabels-right">

  2202. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2203.   </tr>

  2204. </table>

  2205. </div><div class="memdoc">

  2206. <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>

  2207. 

  2208. </div>

  2209. </div>

  2210. <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>

  2211. <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2212. 

  2213. <div class="memitem">

  2214. <div class="memproto">

  2215. <table class="mlabels">

  2216.   <tr>

  2217.   <td class="mlabels-left">

  2218.       <table class="memname">

  2219.         <tr>

  2220.           <td class="memname">size_t ExFatFile::write </td>

  2221.           <td>(</td>

  2222.           <td class="paramtype">const char *&#160;</td>

  2223.           <td class="paramname"><em>str</em></td><td>)</td>

  2224.           <td></td>

  2225.         </tr>

  2226.       </table>

  2227.   </td>

  2228.   <td class="mlabels-right">

  2229. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2230.   </tr>

  2231. </table>

  2232. </div><div class="memdoc">

  2233. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2234.   <table class="params">

  2235.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2236.   </table>

  2237.   </dd>

  2238. </dl>

  2239. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2240. 

  2241. </div>

  2242. </div>

  2243. <a id="abc1423c7b550614d1067e7173f8b46a8"></a>

  2244. <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2245. 

  2246. <div class="memitem">

  2247. <div class="memproto">

  2248.       <table class="memname">

  2249.         <tr>

  2250.           <td class="memname">size_t ExFatFile::write </td>

  2251.           <td>(</td>

  2252.           <td class="paramtype">const void *&#160;</td>

  2253.           <td class="paramname"><em>buf</em>, </td>

  2254.         </tr>

  2255.         <tr>

  2256.           <td class="paramkey"></td>

  2257.           <td></td>

  2258.           <td class="paramtype">size_t&#160;</td>

  2259.           <td class="paramname"><em>count</em>&#160;</td>

  2260.         </tr>

  2261.         <tr>

  2262.           <td></td>

  2263.           <td>)</td>

  2264.           <td></td><td></td>

  2265.         </tr>

  2266.       </table>

  2267. </div><div class="memdoc">

  2268. <p>Write data to an open file.</p>

  2269. <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>

  2270. <dl class="params"><dt>Parameters</dt><dd>

  2271.   <table class="params">

  2272.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2273.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2274.   </table>

  2275.   </dd>

  2276. </dl>

  2277. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_ex_fat_file.html#a6fb2905a5e363554a5118b5d1322cd87">write()</a> returns the number of bytes written, always <em>count</em>. </dd></dl>

  2278. 

  2279. </div>

  2280. </div>

  2281. <a id="afd011d17d66707623c28927a63f81015"></a>

  2282. <h2 class="memtitle"><span class="permalink"><a href="#afd011d17d66707623c28927a63f81015">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2283. 

  2284. <div class="memitem">

  2285. <div class="memproto">

  2286. <table class="mlabels">

  2287.   <tr>

  2288.   <td class="mlabels-left">

  2289.       <table class="memname">

  2290.         <tr>

  2291.           <td class="memname">size_t ExFatFile::write </td>

  2292.           <td>(</td>

  2293.           <td class="paramtype">uint8_t&#160;</td>

  2294.           <td class="paramname"><em>b</em></td><td>)</td>

  2295.           <td></td>

  2296.         </tr>

  2297.       </table>

  2298.   </td>

  2299.   <td class="mlabels-right">

  2300. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2301.   </tr>

  2302. </table>

  2303. </div><div class="memdoc">

  2304. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2305.   <table class="params">

  2306.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2307.   </table>

  2308.   </dd>

  2309. </dl>

  2310. <dl class="section return"><dt>Returns</dt><dd>+1 for success or zero for failure. </dd></dl>

  2311. 

  2312. </div>

  2313. </div>

  2314. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  2315. <a id="a064869383f7639b113eb0aaf0b84335c"></a>

  2316. <h2 class="memtitle"><span class="permalink"><a href="#a064869383f7639b113eb0aaf0b84335c">&#9670;&nbsp;</a></span>ExFatVolume</h2>

  2317. 

  2318. <div class="memitem">

  2319. <div class="memproto">

  2320. <table class="mlabels">

  2321.   <tr>

  2322.   <td class="mlabels-left">

  2323.       <table class="memname">

  2324.         <tr>

  2325.           <td class="memname">friend class <a class="el" href="class_ex_fat_volume.html">ExFatVolume</a></td>

  2326.         </tr>

  2327.       </table>

  2328.   </td>

  2329.   <td class="mlabels-right">

  2330. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  2331.   </tr>

  2332. </table>

  2333. </div><div class="memdoc">

  2334. <p><a class="el" href="class_ex_fat_volume.html" title="exFAT volume.">ExFatVolume</a> allowed access to private members. </p>

  2335. 

  2336. </div>

  2337. </div>

  2338. <hr/>The documentation for this class was generated from the following files:<ul>

  2339. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>

  2340. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFile.cpp</li>

  2341. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFilePrint.cpp</li>

  2342. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFileWrite.cpp</li>

  2343. </ul>

  2344. </div><!-- contents -->

  2345. <!-- start footer part -->

  2346. <hr class="footer"/><address class="footer"><small>

  2347. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2348. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2349. </a> 1.8.16

  2350. </small></address>

  2351. </body>

  2352. </html>