class_ex_fat_file.html 115 KB

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