You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

class_ex_file.html 125KB

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