class_ex_file.html 134 KB

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