visus
/
teensy-sdfat
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Tickets 0 Demandes d'ajout 0 Versions 0 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
50 Révisions
1 Branche
Aborescence: 407591b05b
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '407591b05b'
${ noResults }
teensy-sdfat/extras/html/class_ex_fat_file.html

2352 lines
107KB
Brut Annotations Historique 

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

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

  3. <head>

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

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

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

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

  8. <title>SdFat: 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.14 -->

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

  66. <a href="#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" id="node2" href="class_stream_file.html" title="StreamFile\&lt; ExFatFile,\l uint64_t \&gt;" alt="" coords="5,80,163,121"/>

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

  84. </map>

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

  86. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  229. </table>

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

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

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

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

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

  235. 

  236. <div class="memitem">

  237. <div class="memproto">

  238. <table class="mlabels">

  239.   <tr>

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

  241.       <table class="memname">

  242.         <tr>

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

  244.           <td>(</td>

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

  246.           <td></td>

  247.         </tr>

  248.       </table>

  249.   </td>

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

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

  252.   </tr>

  253. </table>

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

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

  256. 

  257. </div>

  258. </div>

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

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

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

  262. 

  263. <div class="memitem">

  264. <div class="memproto">

  265. <table class="mlabels">

  266.   <tr>

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

  268.       <table class="memname">

  269.         <tr>

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

  271.           <td>(</td>

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

  273.           <td></td>

  274.         </tr>

  275.       </table>

  276.   </td>

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

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

  279.   </tr>

  280. </table>

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

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

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

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

  285. 

  286. </div>

  287. </div>

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

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

  290. 

  291. <div class="memitem">

  292. <div class="memproto">

  293. <table class="mlabels">

  294.   <tr>

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

  296.       <table class="memname">

  297.         <tr>

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

  299.           <td>(</td>

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

  301.           <td></td>

  302.         </tr>

  303.       </table>

  304.   </td>

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

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

  307.   </tr>

  308. </table>

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

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

  311. 

  312. </div>

  313. </div>

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

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

  316. 

  317. <div class="memitem">

  318. <div class="memproto">

  319. <table class="mlabels">

  320.   <tr>

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

  322.       <table class="memname">

  323.         <tr>

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

  325.           <td>(</td>

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

  327.           <td></td>

  328.         </tr>

  329.       </table>

  330.   </td>

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

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

  333.   </tr>

  334. </table>

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

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

  337. 

  338. </div>

  339. </div>

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

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

  342. 

  343. <div class="memitem">

  344. <div class="memproto">

  345. <table class="mlabels">

  346.   <tr>

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

  348.       <table class="memname">

  349.         <tr>

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

  351.           <td>(</td>

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

  353.           <td></td>

  354.         </tr>

  355.       </table>

  356.   </td>

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

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

  359.   </tr>

  360. </table>

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

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

  363. 

  364. </div>

  365. </div>

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

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

  368. 

  369. <div class="memitem">

  370. <div class="memproto">

  371.       <table class="memname">

  372.         <tr>

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

  374.           <td>(</td>

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

  376.           <td></td>

  377.         </tr>

  378.       </table>

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

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

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

  382. 

  383. </div>

  384. </div>

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

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

  387. 

  388. <div class="memitem">

  389. <div class="memproto">

  390. <table class="mlabels">

  391.   <tr>

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

  393.       <table class="memname">

  394.         <tr>

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

  396.           <td>(</td>

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

  398.           <td> const</td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

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

  408. 

  409. </div>

  410. </div>

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

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

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

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

  422.           <td>(</td>

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

  424.           <td></td>

  425.         </tr>

  426.       </table>

  427.   </td>

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

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

  430.   </tr>

  431. </table>

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

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

  434. 

  435. </div>

  436. </div>

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

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

  439. 

  440. <div class="memitem">

  441. <div class="memproto">

  442. <table class="mlabels">

  443.   <tr>

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

  445.       <table class="memname">

  446.         <tr>

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

  448.           <td>(</td>

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

  450.           <td></td>

  451.         </tr>

  452.       </table>

  453.   </td>

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

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

  456.   </tr>

  457. </table>

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

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

  460. 

  461. </div>

  462. </div>

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

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

  465. 

  466. <div class="memitem">

  467. <div class="memproto">

  468. <table class="mlabels">

  469.   <tr>

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

  471.       <table class="memname">

  472.         <tr>

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

  474.           <td>(</td>

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

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

  477.           <td></td>

  478.         </tr>

  479.       </table>

  480.   </td>

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

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

  483.   </tr>

  484. </table>

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

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

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

  488.   <table class="params">

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

  490.   </table>

  491.   </dd>

  492. </dl>

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

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

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

  496. 

  497. </div>

  498. </div>

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

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

  501. 

  502. <div class="memitem">

  503. <div class="memproto">

  504.       <table class="memname">

  505.         <tr>

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

  507.           <td>(</td>

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

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

  510.           <td></td>

  511.         </tr>

  512.       </table>

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

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

  515.   <table class="params">

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

  517.   </table>

  518.   </dd>

  519. </dl>

  520. 

  521. </div>

  522. </div>

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

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

  525. 

  526. <div class="memitem">

  527. <div class="memproto">

  528.       <table class="memname">

  529.         <tr>

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

  531.           <td>(</td>

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

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

  534.         </tr>

  535.         <tr>

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

  537.           <td></td>

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

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

  540.         </tr>

  541.         <tr>

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

  543.           <td></td>

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

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

  546.         </tr>

  547.         <tr>

  548.           <td></td>

  549.           <td>)</td>

  550.           <td></td><td></td>

  551.         </tr>

  552.       </table>

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

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

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

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

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

  558.   <table class="params">

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

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

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

  562.   </table>

  563.   </dd>

  564. </dl>

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

  566. 

  567. </div>

  568. </div>

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

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

  571. 

  572. <div class="memitem">

  573. <div class="memproto">

  574. <table class="mlabels">

  575.   <tr>

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

  577.       <table class="memname">

  578.         <tr>

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

  580.           <td>(</td>

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

  582.           <td></td>

  583.         </tr>

  584.       </table>

  585.   </td>

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

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

  588.   </tr>

  589. </table>

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

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

  592. 

  593. </div>

  594. </div>

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

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

  597. 

  598. <div class="memitem">

  599. <div class="memproto">

  600. <table class="mlabels">

  601.   <tr>

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

  603.       <table class="memname">

  604.         <tr>

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

  606.           <td>(</td>

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

  608.           <td></td>

  609.         </tr>

  610.       </table>

  611.   </td>

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

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

  614.   </tr>

  615. </table>

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

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

  618. 

  619. </div>

  620. </div>

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

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

  623. 

  624. <div class="memitem">

  625. <div class="memproto">

  626.       <table class="memname">

  627.         <tr>

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

  629.           <td>(</td>

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

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

  632.           <td></td>

  633.         </tr>

  634.       </table>

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

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

  637.   <table class="params">

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

  639.   </table>

  640.   </dd>

  641. </dl>

  642. 

  643. </div>

  644. </div>

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

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

  647. 

  648. <div class="memitem">

  649. <div class="memproto">

  650. <table class="mlabels">

  651.   <tr>

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

  653.       <table class="memname">

  654.         <tr>

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

  656.           <td>(</td>

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

  658.           <td></td>

  659.         </tr>

  660.       </table>

  661.   </td>

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

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

  664.   </tr>

  665. </table>

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

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

  668. 

  669. </div>

  670. </div>

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

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

  673. 

  674. <div class="memitem">

  675. <div class="memproto">

  676.       <table class="memname">

  677.         <tr>

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

  679.           <td>(</td>

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

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

  682.         </tr>

  683.         <tr>

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

  685.           <td></td>

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

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

  688.         </tr>

  689.         <tr>

  690.           <td></td>

  691.           <td>)</td>

  692.           <td></td><td></td>

  693.         </tr>

  694.       </table>

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

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

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

  698.   <table class="params">

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

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

  701.   </table>

  702.   </dd>

  703. </dl>

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

  705. 

  706. </div>

  707. </div>

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

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

  710. 

  711. <div class="memitem">

  712. <div class="memproto">

  713. <table class="mlabels">

  714.   <tr>

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

  716.       <table class="memname">

  717.         <tr>

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

  719.           <td>(</td>

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

  721.           <td></td>

  722.         </tr>

  723.       </table>

  724.   </td>

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

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

  727.   </tr>

  728. </table>

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

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

  731. 

  732. </div>

  733. </div>

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

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

  736. 

  737. <div class="memitem">

  738. <div class="memproto">

  739. <table class="mlabels">

  740.   <tr>

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

  742.       <table class="memname">

  743.         <tr>

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

  745.           <td>(</td>

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

  747.           <td> const</td>

  748.         </tr>

  749.       </table>

  750.   </td>

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

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

  753.   </tr>

  754. </table>

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

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

  757. 

  758. </div>

  759. </div>

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

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

  762. 

  763. <div class="memitem">

  764. <div class="memproto">

  765. <table class="mlabels">

  766.   <tr>

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

  768.       <table class="memname">

  769.         <tr>

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

  771.           <td>(</td>

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

  773.           <td> const</td>

  774.         </tr>

  775.       </table>

  776.   </td>

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

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

  779.   </tr>

  780. </table>

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

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

  783. 

  784. </div>

  785. </div>

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

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

  788. 

  789. <div class="memitem">

  790. <div class="memproto">

  791. <table class="mlabels">

  792.   <tr>

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

  794.       <table class="memname">

  795.         <tr>

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

  797.           <td>(</td>

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

  799.           <td> const</td>

  800.         </tr>

  801.       </table>

  802.   </td>

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

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

  805.   </tr>

  806. </table>

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

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

  809. 

  810. </div>

  811. </div>

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

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

  814. 

  815. <div class="memitem">

  816. <div class="memproto">

  817. <table class="mlabels">

  818.   <tr>

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

  820.       <table class="memname">

  821.         <tr>

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

  823.           <td>(</td>

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

  825.           <td> const</td>

  826.         </tr>

  827.       </table>

  828.   </td>

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

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

  831.   </tr>

  832. </table>

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

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

  835. 

  836. </div>

  837. </div>

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

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

  840. 

  841. <div class="memitem">

  842. <div class="memproto">

  843. <table class="mlabels">

  844.   <tr>

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

  846.       <table class="memname">

  847.         <tr>

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

  849.           <td>(</td>

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

  851.           <td> const</td>

  852.         </tr>

  853.       </table>

  854.   </td>

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

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

  857.   </tr>

  858. </table>

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

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

  861. 

  862. </div>

  863. </div>

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

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

  866. 

  867. <div class="memitem">

  868. <div class="memproto">

  869. <table class="mlabels">

  870.   <tr>

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

  872.       <table class="memname">

  873.         <tr>

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

  875.           <td>(</td>

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

  877.           <td> const</td>

  878.         </tr>

  879.       </table>

  880.   </td>

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

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

  883.   </tr>

  884. </table>

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

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

  887. 

  888. </div>

  889. </div>

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

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

  892. 

  893. <div class="memitem">

  894. <div class="memproto">

  895. <table class="mlabels">

  896.   <tr>

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

  898.       <table class="memname">

  899.         <tr>

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

  901.           <td>(</td>

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

  903.           <td> const</td>

  904.         </tr>

  905.       </table>

  906.   </td>

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

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

  909.   </tr>

  910. </table>

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

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

  913. 

  914. </div>

  915. </div>

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

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

  918. 

  919. <div class="memitem">

  920. <div class="memproto">

  921. <table class="mlabels">

  922.   <tr>

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

  924.       <table class="memname">

  925.         <tr>

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

  927.           <td>(</td>

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

  929.           <td> const</td>

  930.         </tr>

  931.       </table>

  932.   </td>

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

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

  935.   </tr>

  936. </table>

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

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

  939. 

  940. </div>

  941. </div>

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

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

  944. 

  945. <div class="memitem">

  946. <div class="memproto">

  947. <table class="mlabels">

  948.   <tr>

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

  950.       <table class="memname">

  951.         <tr>

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

  953.           <td>(</td>

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

  955.           <td> const</td>

  956.         </tr>

  957.       </table>

  958.   </td>

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

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

  961.   </tr>

  962. </table>

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

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

  965. 

  966. </div>

  967. </div>

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

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

  970. 

  971. <div class="memitem">

  972. <div class="memproto">

  973. <table class="mlabels">

  974.   <tr>

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

  976.       <table class="memname">

  977.         <tr>

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

  979.           <td>(</td>

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

  981.           <td> const</td>

  982.         </tr>

  983.       </table>

  984.   </td>

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

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

  987.   </tr>

  988. </table>

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

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

  991. 

  992. </div>

  993. </div>

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

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

  996. 

  997. <div class="memitem">

  998. <div class="memproto">

  999.       <table class="memname">

  1000.         <tr>

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

  1002.           <td>(</td>

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

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

  1005.           <td></td>

  1006.         </tr>

  1007.       </table>

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

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

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

  1011.   <table class="params">

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

  1013.   </table>

  1014.   </dd>

  1015. </dl>

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

  1017. 

  1018. </div>

  1019. </div>

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

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

  1022. 

  1023. <div class="memitem">

  1024. <div class="memproto">

  1025.       <table class="memname">

  1026.         <tr>

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

  1028.           <td>(</td>

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

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

  1031.         </tr>

  1032.         <tr>

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

  1034.           <td></td>

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

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

  1037.         </tr>

  1038.         <tr>

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

  1040.           <td></td>

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

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

  1043.         </tr>

  1044.         <tr>

  1045.           <td></td>

  1046.           <td>)</td>

  1047.           <td></td><td></td>

  1048.         </tr>

  1049.       </table>

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

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

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

  1053.   <table class="params">

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

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

  1056.   </table>

  1057.   </dd>

  1058. </dl>

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

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

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

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

  1063.   <table class="params">

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

  1065.   </table>

  1066.   </dd>

  1067. </dl>

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

  1069. 

  1070. </div>

  1071. </div>

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

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

  1074. 

  1075. <div class="memitem">

  1076. <div class="memproto">

  1077.       <table class="memname">

  1078.         <tr>

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

  1080.           <td>(</td>

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

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

  1083.         </tr>

  1084.         <tr>

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

  1086.           <td></td>

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

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

  1089.         </tr>

  1090.         <tr>

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

  1092.           <td></td>

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

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

  1095.         </tr>

  1096.         <tr>

  1097.           <td></td>

  1098.           <td>)</td>

  1099.           <td></td><td></td>

  1100.         </tr>

  1101.       </table>

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

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

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

  1105.   <table class="params">

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

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

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

  1109.   </table>

  1110.   </dd>

  1111. </dl>

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

  1113. 

  1114. </div>

  1115. </div>

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

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

  1118. 

  1119. <div class="memitem">

  1120. <div class="memproto">

  1121.       <table class="memname">

  1122.         <tr>

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

  1124.           <td>(</td>

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

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

  1127.         </tr>

  1128.         <tr>

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

  1130.           <td></td>

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

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

  1133.         </tr>

  1134.         <tr>

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

  1136.           <td></td>

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

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

  1139.         </tr>

  1140.         <tr>

  1141.           <td></td>

  1142.           <td>)</td>

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

  1144.         </tr>

  1145.       </table>

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

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

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

  1149.   <table class="params">

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

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

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

  1153.   </table>

  1154.   </dd>

  1155. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1169. 

  1170. </div>

  1171. </div>

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

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

  1174. 

  1175. <div class="memitem">

  1176. <div class="memproto">

  1177.       <table class="memname">

  1178.         <tr>

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

  1180.           <td>(</td>

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

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

  1183.         </tr>

  1184.         <tr>

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

  1186.           <td></td>

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

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

  1189.         </tr>

  1190.         <tr>

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

  1192.           <td></td>

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

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

  1195.         </tr>

  1196.         <tr>

  1197.           <td></td>

  1198.           <td>)</td>

  1199.           <td></td><td></td>

  1200.         </tr>

  1201.       </table>

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

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

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

  1205.   <table class="params">

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

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

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

  1209.   </table>

  1210.   </dd>

  1211. </dl>

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

  1213. 

  1214. </div>

  1215. </div>

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

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

  1218. 

  1219. <div class="memitem">

  1220. <div class="memproto">

  1221.       <table class="memname">

  1222.         <tr>

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

  1224.           <td>(</td>

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

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

  1227.         </tr>

  1228.         <tr>

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

  1230.           <td></td>

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

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

  1233.         </tr>

  1234.         <tr>

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

  1236.           <td></td>

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

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

  1239.         </tr>

  1240.         <tr>

  1241.           <td></td>

  1242.           <td>)</td>

  1243.           <td></td><td></td>

  1244.         </tr>

  1245.       </table>

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

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

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

  1249.   <table class="params">

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

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

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

  1253.   </table>

  1254.   </dd>

  1255. </dl>

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

  1257. 

  1258. </div>

  1259. </div>

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

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

  1262. 

  1263. <div class="memitem">

  1264. <div class="memproto">

  1265.       <table class="memname">

  1266.         <tr>

  1267.           <td class="memname">bool ExFatFile::open </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> = <code>0X00</code>&#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 current 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">path</td><td>A path with a valid name for a file to be opened.</td></tr>

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

  1290.   </table>

  1291.   </dd>

  1292. </dl>

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

  1294. 

  1295. </div>

  1296. </div>

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

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

  1299. 

  1300. <div class="memitem">

  1301. <div class="memproto">

  1302.       <table class="memname">

  1303.         <tr>

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

  1305.           <td>(</td>

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

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

  1308.         </tr>

  1309.         <tr>

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

  1311.           <td></td>

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

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

  1314.         </tr>

  1315.         <tr>

  1316.           <td></td>

  1317.           <td>)</td>

  1318.           <td></td><td></td>

  1319.         </tr>

  1320.       </table>

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

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

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

  1324.   <table class="params">

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

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

  1327.   </table>

  1328.   </dd>

  1329. </dl>

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

  1331. 

  1332. </div>

  1333. </div>

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

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

  1336. 

  1337. <div class="memitem">

  1338. <div class="memproto">

  1339.       <table class="memname">

  1340.         <tr>

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

  1342.           <td>(</td>

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

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

  1345.           <td></td>

  1346.         </tr>

  1347.       </table>

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

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

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

  1351.   <table class="params">

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

  1353.   </table>

  1354.   </dd>

  1355. </dl>

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

  1357. 

  1358. </div>

  1359. </div>

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

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

  1362. 

  1363. <div class="memitem">

  1364. <div class="memproto">

  1365. <table class="mlabels">

  1366.   <tr>

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

  1368.       <table class="memname">

  1369.         <tr>

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

  1371.           <td>(</td>

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

  1373.           <td></td>

  1374.         </tr>

  1375.       </table>

  1376.   </td>

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

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

  1379.   </tr>

  1380. </table>

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

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

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

  1384. 

  1385. </div>

  1386. </div>

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

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

  1389. 

  1390. <div class="memitem">

  1391. <div class="memproto">

  1392.       <table class="memname">

  1393.         <tr>

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

  1395.           <td>(</td>

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

  1397.           <td></td>

  1398.         </tr>

  1399.       </table>

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

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

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

  1403. 

  1404. </div>

  1405. </div>

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

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

  1408. 

  1409. <div class="memitem">

  1410. <div class="memproto">

  1411.       <table class="memname">

  1412.         <tr>

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

  1414.           <td>(</td>

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

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

  1417.           <td></td>

  1418.         </tr>

  1419.       </table>

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

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

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

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

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

  1425.   <table class="params">

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

  1427.   </table>

  1428.   </dd>

  1429. </dl>

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

  1431. 

  1432. </div>

  1433. </div>

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

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

  1436. 

  1437. <div class="memitem">

  1438. <div class="memproto">

  1439.       <table class="memname">

  1440.         <tr>

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

  1442.           <td>(</td>

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

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

  1445.           <td></td>

  1446.         </tr>

  1447.       </table>

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

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

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

  1451.   <table class="params">

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

  1453.   </table>

  1454.   </dd>

  1455. </dl>

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

  1457. 

  1458. </div>

  1459. </div>

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

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

  1462. 

  1463. <div class="memitem">

  1464. <div class="memproto">

  1465.       <table class="memname">

  1466.         <tr>

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

  1468.           <td>(</td>

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

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

  1471.           <td></td>

  1472.         </tr>

  1473.       </table>

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

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

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

  1477.   <table class="params">

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

  1479.   </table>

  1480.   </dd>

  1481. </dl>

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

  1483. 

  1484. </div>

  1485. </div>

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

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

  1488. 

  1489. <div class="memitem">

  1490. <div class="memproto">

  1491. <table class="mlabels">

  1492.   <tr>

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

  1494.       <table class="memname">

  1495.         <tr>

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

  1497.           <td>(</td>

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

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

  1500.         </tr>

  1501.         <tr>

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

  1503.           <td></td>

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

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

  1506.         </tr>

  1507.         <tr>

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

  1509.           <td></td>

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

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

  1512.         </tr>

  1513.         <tr>

  1514.           <td></td>

  1515.           <td>)</td>

  1516.           <td></td><td></td>

  1517.         </tr>

  1518.       </table>

  1519.   </td>

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

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

  1522.   </tr>

  1523. </table>

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

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

  1526.   <table class="params">

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

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

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

  1530.   </table>

  1531.   </dd>

  1532. </dl>

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

  1534. 

  1535. </div>

  1536. </div>

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

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

  1539. 

  1540. <div class="memitem">

  1541. <div class="memproto">

  1542. <table class="mlabels">

  1543.   <tr>

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

  1545.       <table class="memname">

  1546.         <tr>

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

  1548.           <td>(</td>

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

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

  1551.         </tr>

  1552.         <tr>

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

  1554.           <td></td>

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

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

  1557.         </tr>

  1558.         <tr>

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

  1560.           <td></td>

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

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

  1563.         </tr>

  1564.         <tr>

  1565.           <td></td>

  1566.           <td>)</td>

  1567.           <td></td><td></td>

  1568.         </tr>

  1569.       </table>

  1570.   </td>

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

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

  1573.   </tr>

  1574. </table>

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

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

  1577.   <table class="params">

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

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

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

  1581.   </table>

  1582.   </dd>

  1583. </dl>

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

  1585. 

  1586. </div>

  1587. </div>

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

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

  1590. 

  1591. <div class="memitem">

  1592. <div class="memproto">

  1593. <div class="memtemplate">

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

  1595. <table class="mlabels">

  1596.   <tr>

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

  1598.       <table class="memname">

  1599.         <tr>

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

  1601.           <td>(</td>

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

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

  1604.         </tr>

  1605.         <tr>

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

  1607.           <td></td>

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

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

  1610.         </tr>

  1611.         <tr>

  1612.           <td></td>

  1613.           <td>)</td>

  1614.           <td></td><td></td>

  1615.         </tr>

  1616.       </table>

  1617.   </td>

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

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

  1620.   </tr>

  1621. </table>

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

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

  1624.   <table class="params">

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

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

  1627.   </table>

  1628.   </dd>

  1629. </dl>

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

  1631. 

  1632. </div>

  1633. </div>

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

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

  1636. 

  1637. <div class="memitem">

  1638. <div class="memproto">

  1639.       <table class="memname">

  1640.         <tr>

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

  1642.           <td>(</td>

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

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

  1645.           <td></td>

  1646.         </tr>

  1647.       </table>

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

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

  1650.   <table class="params">

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

  1652.   </table>

  1653.   </dd>

  1654. </dl>

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

  1656. 

  1657. </div>

  1658. </div>

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

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

  1661. 

  1662. <div class="memitem">

  1663. <div class="memproto">

  1664.       <table class="memname">

  1665.         <tr>

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

  1667.           <td>(</td>

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

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

  1670.           <td></td>

  1671.         </tr>

  1672.       </table>

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

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

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

  1676.   <table class="params">

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

  1678.   </table>

  1679.   </dd>

  1680. </dl>

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

  1682. 

  1683. </div>

  1684. </div>

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

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

  1687. 

  1688. <div class="memitem">

  1689. <div class="memproto">

  1690.       <table class="memname">

  1691.         <tr>

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

  1693.           <td>(</td>

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

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

  1696.           <td></td>

  1697.         </tr>

  1698.       </table>

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

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

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

  1702.   <table class="params">

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

  1704.   </table>

  1705.   </dd>

  1706. </dl>

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

  1708. 

  1709. </div>

  1710. </div>

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

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

  1713. 

  1714. <div class="memitem">

  1715. <div class="memproto">

  1716. <table class="mlabels">

  1717.   <tr>

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

  1719.       <table class="memname">

  1720.         <tr>

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

  1722.           <td>(</td>

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

  1724.           <td></td>

  1725.         </tr>

  1726.       </table>

  1727.   </td>

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

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

  1730.   </tr>

  1731. </table>

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

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

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

  1735. 

  1736. </div>

  1737. </div>

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

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

  1740. 

  1741. <div class="memitem">

  1742. <div class="memproto">

  1743.       <table class="memname">

  1744.         <tr>

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

  1746.           <td>(</td>

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

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

  1749.         </tr>

  1750.         <tr>

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

  1752.           <td></td>

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

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

  1755.         </tr>

  1756.         <tr>

  1757.           <td></td>

  1758.           <td>)</td>

  1759.           <td></td><td></td>

  1760.         </tr>

  1761.       </table>

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

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

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

  1765.   <table class="params">

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

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

  1768.   </table>

  1769.   </dd>

  1770. </dl>

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

  1772. 

  1773. </div>

  1774. </div>

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

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

  1777. 

  1778. <div class="memitem">

  1779. <div class="memproto">

  1780.       <table class="memname">

  1781.         <tr>

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

  1783.           <td>(</td>

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

  1785.           <td></td>

  1786.         </tr>

  1787.       </table>

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

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

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

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

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

  1793. 

  1794. </div>

  1795. </div>

  1796. <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>

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

  1798. 

  1799. <div class="memitem">

  1800. <div class="memproto">

  1801.       <table class="memname">

  1802.         <tr>

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

  1804.           <td>(</td>

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

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

  1807.           <td></td>

  1808.         </tr>

  1809.       </table>

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

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

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

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

  1814.   <table class="params">

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

  1816.   </table>

  1817.   </dd>

  1818. </dl>

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

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

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

  1822. 

  1823. </div>

  1824. </div>

  1825. <a id="aab50b2646035f76834c75230d2b55c64"></a>

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

  1827. 

  1828. <div class="memitem">

  1829. <div class="memproto">

  1830.       <table class="memname">

  1831.         <tr>

  1832.           <td class="memname">bool ExFatFile::rename </td>

  1833.           <td>(</td>

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

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

  1836.           <td></td>

  1837.         </tr>

  1838.       </table>

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

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

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

  1842.   <table class="params">

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

  1844.   </table>

  1845.   </dd>

  1846. </dl>

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

  1848. 

  1849. </div>

  1850. </div>

  1851. <a id="aea570a3b6afbe633d874803b137a46b8"></a>

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

  1853. 

  1854. <div class="memitem">

  1855. <div class="memproto">

  1856.       <table class="memname">

  1857.         <tr>

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

  1859.           <td>(</td>

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

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

  1862.         </tr>

  1863.         <tr>

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

  1865.           <td></td>

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

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

  1868.         </tr>

  1869.         <tr>

  1870.           <td></td>

  1871.           <td>)</td>

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

  1873.         </tr>

  1874.       </table>

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

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

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

  1878.   <table class="params">

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

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

  1881.   </table>

  1882.   </dd>

  1883. </dl>

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

  1885. 

  1886. </div>

  1887. </div>

  1888. <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>

  1889. <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">&#9670;&nbsp;</a></span>rewind()</h2>

  1890. 

  1891. <div class="memitem">

  1892. <div class="memproto">

  1893. <table class="mlabels">

  1894.   <tr>

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

  1896.       <table class="memname">

  1897.         <tr>

  1898.           <td class="memname">void ExFatFile::rewind </td>

  1899.           <td>(</td>

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

  1901.           <td></td>

  1902.         </tr>

  1903.       </table>

  1904.   </td>

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

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

  1907.   </tr>

  1908. </table>

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

  1910. <p>Set the file's current position to zero. </p>

  1911. 

  1912. </div>

  1913. </div>

  1914. <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>

  1915. <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">&#9670;&nbsp;</a></span>rmdir()</h2>

  1916. 

  1917. <div class="memitem">

  1918. <div class="memproto">

  1919.       <table class="memname">

  1920.         <tr>

  1921.           <td class="memname">bool ExFatFile::rmdir </td>

  1922.           <td>(</td>

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

  1924.           <td></td>

  1925.         </tr>

  1926.       </table>

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

  1928. <p>Remove a directory file.</p>

  1929. <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>

  1930. <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>

  1931. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1932. 

  1933. </div>

  1934. </div>

  1935. <a id="ab42494880cf229adfb0fc8edb0647686"></a>

  1936. <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">&#9670;&nbsp;</a></span>seekCur()</h2>

  1937. 

  1938. <div class="memitem">

  1939. <div class="memproto">

  1940. <table class="mlabels">

  1941.   <tr>

  1942.   <td class="mlabels-left">

  1943.       <table class="memname">

  1944.         <tr>

  1945.           <td class="memname">bool ExFatFile::seekCur </td>

  1946.           <td>(</td>

  1947.           <td class="paramtype">int64_t&#160;</td>

  1948.           <td class="paramname"><em>offset</em></td><td>)</td>

  1949.           <td></td>

  1950.         </tr>

  1951.       </table>

  1952.   </td>

  1953.   <td class="mlabels-right">

  1954. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1955.   </tr>

  1956. </table>

  1957. </div><div class="memdoc">

  1958. <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>

  1959.   <table class="params">

  1960.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  1961.   </table>

  1962.   </dd>

  1963. </dl>

  1964. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1965. 

  1966. </div>

  1967. </div>

  1968. <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>

  1969. <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">&#9670;&nbsp;</a></span>seekEnd()</h2>

  1970. 

  1971. <div class="memitem">

  1972. <div class="memproto">

  1973. <table class="mlabels">

  1974.   <tr>

  1975.   <td class="mlabels-left">

  1976.       <table class="memname">

  1977.         <tr>

  1978.           <td class="memname">bool ExFatFile::seekEnd </td>

  1979.           <td>(</td>

  1980.           <td class="paramtype">int64_t&#160;</td>

  1981.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  1982.           <td></td>

  1983.         </tr>

  1984.       </table>

  1985.   </td>

  1986.   <td class="mlabels-right">

  1987. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1988.   </tr>

  1989. </table>

  1990. </div><div class="memdoc">

  1991. <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>

  1992.   <table class="params">

  1993.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  1994.   </table>

  1995.   </dd>

  1996. </dl>

  1997. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1998. 

  1999. </div>

  2000. </div>

  2001. <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>

  2002. <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">&#9670;&nbsp;</a></span>seekSet()</h2>

  2003. 

  2004. <div class="memitem">

  2005. <div class="memproto">

  2006.       <table class="memname">

  2007.         <tr>

  2008.           <td class="memname">bool ExFatFile::seekSet </td>

  2009.           <td>(</td>

  2010.           <td class="paramtype">uint64_t&#160;</td>

  2011.           <td class="paramname"><em>pos</em></td><td>)</td>

  2012.           <td></td>

  2013.         </tr>

  2014.       </table>

  2015. </div><div class="memdoc">

  2016. <p>Sets a file's position.</p>

  2017. <dl class="params"><dt>Parameters</dt><dd>

  2018.   <table class="params">

  2019.     <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>

  2020.   </table>

  2021.   </dd>

  2022. </dl>

  2023. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2024. 

  2025. </div>

  2026. </div>

  2027. <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>

  2028. <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">&#9670;&nbsp;</a></span>sync()</h2>

  2029. 

  2030. <div class="memitem">

  2031. <div class="memproto">

  2032.       <table class="memname">

  2033.         <tr>

  2034.           <td class="memname">bool ExFatFile::sync </td>

  2035.           <td>(</td>

  2036.           <td class="paramname"></td><td>)</td>

  2037.           <td></td>

  2038.         </tr>

  2039.       </table>

  2040. </div><div class="memdoc">

  2041. <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>

  2042. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2043. 

  2044. </div>

  2045. </div>

  2046. <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>

  2047. <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">&#9670;&nbsp;</a></span>timestamp()</h2>

  2048. 

  2049. <div class="memitem">

  2050. <div class="memproto">

  2051.       <table class="memname">

  2052.         <tr>

  2053.           <td class="memname">bool ExFatFile::timestamp </td>

  2054.           <td>(</td>

  2055.           <td class="paramtype">uint8_t&#160;</td>

  2056.           <td class="paramname"><em>flags</em>, </td>

  2057.         </tr>

  2058.         <tr>

  2059.           <td class="paramkey"></td>

  2060.           <td></td>

  2061.           <td class="paramtype">uint16_t&#160;</td>

  2062.           <td class="paramname"><em>year</em>, </td>

  2063.         </tr>

  2064.         <tr>

  2065.           <td class="paramkey"></td>

  2066.           <td></td>

  2067.           <td class="paramtype">uint8_t&#160;</td>

  2068.           <td class="paramname"><em>month</em>, </td>

  2069.         </tr>

  2070.         <tr>

  2071.           <td class="paramkey"></td>

  2072.           <td></td>

  2073.           <td class="paramtype">uint8_t&#160;</td>

  2074.           <td class="paramname"><em>day</em>, </td>

  2075.         </tr>

  2076.         <tr>

  2077.           <td class="paramkey"></td>

  2078.           <td></td>

  2079.           <td class="paramtype">uint8_t&#160;</td>

  2080.           <td class="paramname"><em>hour</em>, </td>

  2081.         </tr>

  2082.         <tr>

  2083.           <td class="paramkey"></td>

  2084.           <td></td>

  2085.           <td class="paramtype">uint8_t&#160;</td>

  2086.           <td class="paramname"><em>minute</em>, </td>

  2087.         </tr>

  2088.         <tr>

  2089.           <td class="paramkey"></td>

  2090.           <td></td>

  2091.           <td class="paramtype">uint8_t&#160;</td>

  2092.           <td class="paramname"><em>second</em>&#160;</td>

  2093.         </tr>

  2094.         <tr>

  2095.           <td></td>

  2096.           <td>)</td>

  2097.           <td></td><td></td>

  2098.         </tr>

  2099.       </table>

  2100. </div><div class="memdoc">

  2101. <p>Truncate a file at the current file position.</p>

  2102. <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>

  2103. <dl class="params"><dt>Parameters</dt><dd>

  2104.   <table class="params">

  2105.     <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>

  2106.   </table>

  2107.   </dd>

  2108. </dl>

  2109. <p>T_ACCESS - Set the file's last access date.</p>

  2110. <p>T_CREATE - Set the file's creation date and time.</p>

  2111. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2112. <dl class="params"><dt>Parameters</dt><dd>

  2113.   <table class="params">

  2114.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2115.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2116.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2117.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2118.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2119.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2120.   </table>

  2121.   </dd>

  2122. </dl>

  2123. <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>

  2124. <dd>

  2125. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2126. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2127. 

  2128. </div>

  2129. </div>

  2130. <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>

  2131. <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2132. 

  2133. <div class="memitem">

  2134. <div class="memproto">

  2135.       <table class="memname">

  2136.         <tr>

  2137.           <td class="memname">bool ExFatFile::truncate </td>

  2138.           <td>(</td>

  2139.           <td class="paramname"></td><td>)</td>

  2140.           <td></td>

  2141.         </tr>

  2142.       </table>

  2143. </div><div class="memdoc">

  2144. <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>

  2145. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2146. 

  2147. </div>

  2148. </div>

  2149. <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>

  2150. <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2151. 

  2152. <div class="memitem">

  2153. <div class="memproto">

  2154. <table class="mlabels">

  2155.   <tr>

  2156.   <td class="mlabels-left">

  2157.       <table class="memname">

  2158.         <tr>

  2159.           <td class="memname">bool ExFatFile::truncate </td>

  2160.           <td>(</td>

  2161.           <td class="paramtype">uint64_t&#160;</td>

  2162.           <td class="paramname"><em>length</em></td><td>)</td>

  2163.           <td></td>

  2164.         </tr>

  2165.       </table>

  2166.   </td>

  2167.   <td class="mlabels-right">

  2168. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2169.   </tr>

  2170. </table>

  2171. </div><div class="memdoc">

  2172. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2173. <dl class="params"><dt>Parameters</dt><dd>

  2174.   <table class="params">

  2175.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2176.   </table>

  2177.   </dd>

  2178. </dl>

  2179. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2180. 

  2181. </div>

  2182. </div>

  2183. <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>

  2184. <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">&#9670;&nbsp;</a></span>validLength()</h2>

  2185. 

  2186. <div class="memitem">

  2187. <div class="memproto">

  2188. <table class="mlabels">

  2189.   <tr>

  2190.   <td class="mlabels-left">

  2191.       <table class="memname">

  2192.         <tr>

  2193.           <td class="memname">uint64_t ExFatFile::validLength </td>

  2194.           <td>(</td>

  2195.           <td class="paramname"></td><td>)</td>

  2196.           <td></td>

  2197.         </tr>

  2198.       </table>

  2199.   </td>

  2200.   <td class="mlabels-right">

  2201. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2202.   </tr>

  2203. </table>

  2204. </div><div class="memdoc">

  2205. <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>

  2206. 

  2207. </div>

  2208. </div>

  2209. <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>

  2210. <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2211. 

  2212. <div class="memitem">

  2213. <div class="memproto">

  2214. <table class="mlabels">

  2215.   <tr>

  2216.   <td class="mlabels-left">

  2217.       <table class="memname">

  2218.         <tr>

  2219.           <td class="memname">size_t ExFatFile::write </td>

  2220.           <td>(</td>

  2221.           <td class="paramtype">const char *&#160;</td>

  2222.           <td class="paramname"><em>str</em></td><td>)</td>

  2223.           <td></td>

  2224.         </tr>

  2225.       </table>

  2226.   </td>

  2227.   <td class="mlabels-right">

  2228. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2229.   </tr>

  2230. </table>

  2231. </div><div class="memdoc">

  2232. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2233.   <table class="params">

  2234.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2235.   </table>

  2236.   </dd>

  2237. </dl>

  2238. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2239. 

  2240. </div>

  2241. </div>

  2242. <a id="afd011d17d66707623c28927a63f81015"></a>

  2243. <h2 class="memtitle"><span class="permalink"><a href="#afd011d17d66707623c28927a63f81015">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2244. 

  2245. <div class="memitem">

  2246. <div class="memproto">

  2247. <table class="mlabels">

  2248.   <tr>

  2249.   <td class="mlabels-left">

  2250.       <table class="memname">

  2251.         <tr>

  2252.           <td class="memname">size_t ExFatFile::write </td>

  2253.           <td>(</td>

  2254.           <td class="paramtype">uint8_t&#160;</td>

  2255.           <td class="paramname"><em>b</em></td><td>)</td>

  2256.           <td></td>

  2257.         </tr>

  2258.       </table>

  2259.   </td>

  2260.   <td class="mlabels-right">

  2261. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2262.   </tr>

  2263. </table>

  2264. </div><div class="memdoc">

  2265. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2266.   <table class="params">

  2267.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2268.   </table>

  2269.   </dd>

  2270. </dl>

  2271. <dl class="section return"><dt>Returns</dt><dd>+1 for success or zero for failure. </dd></dl>

  2272. 

  2273. </div>

  2274. </div>

  2275. <a id="abc1423c7b550614d1067e7173f8b46a8"></a>

  2276. <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2277. 

  2278. <div class="memitem">

  2279. <div class="memproto">

  2280.       <table class="memname">

  2281.         <tr>

  2282.           <td class="memname">size_t ExFatFile::write </td>

  2283.           <td>(</td>

  2284.           <td class="paramtype">const void *&#160;</td>

  2285.           <td class="paramname"><em>buf</em>, </td>

  2286.         </tr>

  2287.         <tr>

  2288.           <td class="paramkey"></td>

  2289.           <td></td>

  2290.           <td class="paramtype">size_t&#160;</td>

  2291.           <td class="paramname"><em>count</em>&#160;</td>

  2292.         </tr>

  2293.         <tr>

  2294.           <td></td>

  2295.           <td>)</td>

  2296.           <td></td><td></td>

  2297.         </tr>

  2298.       </table>

  2299. </div><div class="memdoc">

  2300. <p>Write data to an open file.</p>

  2301. <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>

  2302. <dl class="params"><dt>Parameters</dt><dd>

  2303.   <table class="params">

  2304.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2305.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2306.   </table>

  2307.   </dd>

  2308. </dl>

  2309. <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>

  2310. 

  2311. </div>

  2312. </div>

  2313. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  2314. <a id="a064869383f7639b113eb0aaf0b84335c"></a>

  2315. <h2 class="memtitle"><span class="permalink"><a href="#a064869383f7639b113eb0aaf0b84335c">&#9670;&nbsp;</a></span>ExFatVolume</h2>

  2316. 

  2317. <div class="memitem">

  2318. <div class="memproto">

  2319. <table class="mlabels">

  2320.   <tr>

  2321.   <td class="mlabels-left">

  2322.       <table class="memname">

  2323.         <tr>

  2324.           <td class="memname">friend class <a class="el" href="class_ex_fat_volume.html">ExFatVolume</a></td>

  2325.         </tr>

  2326.       </table>

  2327.   </td>

  2328.   <td class="mlabels-right">

  2329. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  2330.   </tr>

  2331. </table>

  2332. </div><div class="memdoc">

  2333. <p><a class="el" href="class_ex_fat_volume.html" title="exFAT volume. ">ExFatVolume</a> allowed access to private members. </p>

  2334. 

  2335. </div>

  2336. </div>

  2337. <hr/>The documentation for this class was generated from the following files:<ul>

  2338. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>

  2339. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFile.cpp</li>

  2340. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFilePrint.cpp</li>

  2341. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatFileWrite.cpp</li>

  2342. </ul>

  2343. </div><!-- contents -->

  2344. <!-- start footer part -->

  2345. <hr class="footer"/><address class="footer"><small>

  2346. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2347. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2348. </a> 1.8.14

  2349. </small></address>

  2350. </body>

  2351. </html>