|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.16"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>SdFat: ExFile Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">SdFat
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.16 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_ex_file-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">ExFile Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p>exFAT file with Arduino Stream.
- <a href="class_ex_file.html#details">More...</a></p>
-
- <p><code>#include <ExFatFile.h></code></p>
- <div class="dynheader">
- Inheritance diagram for ExFile:</div>
- <div class="dyncontent">
- <div class="center"><img src="class_ex_file__inherit__graph.png" border="0" usemap="#_ex_file_inherit__map" alt="Inheritance graph"/></div>
- <map name="_ex_file_inherit__map" id="_ex_file_inherit__map">
- <area shape="rect" title="exFAT file with Arduino Stream." alt="" coords="62,169,121,196"/>
- <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="13,80,170,121"/>
- <area shape="rect" title=" " alt="" coords="5,5,79,32"/>
- <area shape="rect" href="class_ex_fat_file.html" title="Basic file class." alt="" coords="103,5,181,32"/>
- </map>
- <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
- <div class="dynheader">
- Collaboration diagram for ExFile:</div>
- <div class="dyncontent">
- <div class="center"><img src="class_ex_file__coll__graph.png" border="0" usemap="#_ex_file_coll__map" alt="Collaboration graph"/></div>
- <map name="_ex_file_coll__map" id="_ex_file_coll__map">
- <area shape="rect" title="exFAT file with Arduino Stream." alt="" coords="62,169,121,196"/>
- <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="13,80,170,121"/>
- <area shape="rect" title=" " alt="" coords="5,5,79,32"/>
- <area shape="rect" href="class_ex_fat_file.html" title="Basic file class." alt="" coords="103,5,181,32"/>
- </map>
- <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a0112cc39b64aac6f1ec47741397a7582"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0112cc39b64aac6f1ec47741397a7582">available</a> ()</td></tr>
- <tr class="separator:a0112cc39b64aac6f1ec47741397a7582"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adcf47e15b819fe2d6faac2a027ab30f5"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#adcf47e15b819fe2d6faac2a027ab30f5">available64</a> ()</td></tr>
- <tr class="separator:adcf47e15b819fe2d6faac2a027ab30f5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac2004e7bf328b3edda7d4c3acba2726f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ac2004e7bf328b3edda7d4c3acba2726f">clearError</a> ()</td></tr>
- <tr class="separator:ac2004e7bf328b3edda7d4c3acba2726f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc0d3863895c17df53930bdfa84cb06f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#abc0d3863895c17df53930bdfa84cb06f">clearWriteError</a> ()</td></tr>
- <tr class="separator:abc0d3863895c17df53930bdfa84cb06f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7ba9e04099bdf8fd34220ebfdde72867"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a7ba9e04099bdf8fd34220ebfdde72867">close</a> ()</td></tr>
- <tr class="separator:a7ba9e04099bdf8fd34220ebfdde72867"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab49396aad3f6500aa19f75490dc26719"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ab49396aad3f6500aa19f75490dc26719">curPosition</a> () const</td></tr>
- <tr class="separator:ab49396aad3f6500aa19f75490dc26719"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ada4dde9f2eed36bf556fcf1bd3d28ccf"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ada4dde9f2eed36bf556fcf1bd3d28ccf">dataLength</a> ()</td></tr>
- <tr class="separator:ada4dde9f2eed36bf556fcf1bd3d28ccf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5e3baa5d5269c2948cfaf604c42f6a16"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a5e3baa5d5269c2948cfaf604c42f6a16">dirIndex</a> ()</td></tr>
- <tr class="separator:a5e3baa5d5269c2948cfaf604c42f6a16"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22a717ddc6d2004c540c67a14264d9dd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a22a717ddc6d2004c540c67a14264d9dd">exists</a> (const ExChar_t *path)</td></tr>
- <tr class="separator:a22a717ddc6d2004c540c67a14264d9dd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8614bcbf04b7bbfc70fe36d2fa7f70c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a8614bcbf04b7bbfc70fe36d2fa7f70c1">fgetpos</a> (fspos_t *pos)</td></tr>
- <tr class="separator:a8614bcbf04b7bbfc70fe36d2fa7f70c1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc69c9dfc8fdb4ebf9db3bc37c879dc6"><td class="memItemLeft" align="right" valign="top">int </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>
- <tr class="separator:abc69c9dfc8fdb4ebf9db3bc37c879dc6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2c08909b62b01f3edc4ee0c51ea7435"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#af2c08909b62b01f3edc4ee0c51ea7435">fileSize</a> ()</td></tr>
- <tr class="separator:af2c08909b62b01f3edc4ee0c51ea7435"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32f813e659414892a58aa5157fe14f82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a32f813e659414892a58aa5157fe14f82">flush</a> ()</td></tr>
- <tr class="separator:a32f813e659414892a58aa5157fe14f82"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea1e4d0c0981081774dc3c7cd3c55264"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aea1e4d0c0981081774dc3c7cd3c55264">fsetpos</a> (const fspos_t *pos)</td></tr>
- <tr class="separator:aea1e4d0c0981081774dc3c7cd3c55264"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac697224450ca216c60585d25f5f6e310"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ac697224450ca216c60585d25f5f6e310">getError</a> ()</td></tr>
- <tr class="separator:ac697224450ca216c60585d25f5f6e310"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aba93e2c18be9fa4df7e067b7d6ac5906"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:aba93e2c18be9fa4df7e067b7d6ac5906"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a01da9896a59671a61f90dd20c3ac5d07"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a01da9896a59671a61f90dd20c3ac5d07">getWriteError</a> ()</td></tr>
- <tr class="separator:a01da9896a59671a61f90dd20c3ac5d07"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a167102bd47b7cf91167b69f8cc57d1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a7a167102bd47b7cf91167b69f8cc57d1">isContiguous</a> () const</td></tr>
- <tr class="separator:a7a167102bd47b7cf91167b69f8cc57d1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad0a3687bd95bed5b216651335e66b500"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ad0a3687bd95bed5b216651335e66b500">isDir</a> () const</td></tr>
- <tr class="separator:ad0a3687bd95bed5b216651335e66b500"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a586ad44055eca4c1b2b457299b829d44"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a586ad44055eca4c1b2b457299b829d44">isDirectory</a> ()</td></tr>
- <tr class="separator:a586ad44055eca4c1b2b457299b829d44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af601285f95db8398c140b3927cf9111c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#af601285f95db8398c140b3927cf9111c">isFile</a> () const</td></tr>
- <tr class="separator:af601285f95db8398c140b3927cf9111c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac926285fa4321ebee28fa91beb511eae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ac926285fa4321ebee28fa91beb511eae">isHidden</a> () const</td></tr>
- <tr class="separator:ac926285fa4321ebee28fa91beb511eae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a804c34bbe3ebefe2b6c1d77ff8d49a35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a804c34bbe3ebefe2b6c1d77ff8d49a35">isOpen</a> () const</td></tr>
- <tr class="separator:a804c34bbe3ebefe2b6c1d77ff8d49a35"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ca137dfba2c7772910f4d2b3fdd9411"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a9ca137dfba2c7772910f4d2b3fdd9411">isReadable</a> () const</td></tr>
- <tr class="separator:a9ca137dfba2c7772910f4d2b3fdd9411"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a14d160bfbfb39717746b93fa2eda5739"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a14d160bfbfb39717746b93fa2eda5739">isReadOnly</a> () const</td></tr>
- <tr class="separator:a14d160bfbfb39717746b93fa2eda5739"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad9f8e7afcf749ebcaaf055bd569dc7da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ad9f8e7afcf749ebcaaf055bd569dc7da">isRoot</a> () const</td></tr>
- <tr class="separator:ad9f8e7afcf749ebcaaf055bd569dc7da"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad7e02a1db8fb5a90288bb4679e9ddcb9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ad7e02a1db8fb5a90288bb4679e9ddcb9">isSubDir</a> () const</td></tr>
- <tr class="separator:ad7e02a1db8fb5a90288bb4679e9ddcb9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a04d1c43e80743f8c1a51b64062ce16dd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a04d1c43e80743f8c1a51b64062ce16dd">isWritable</a> () const</td></tr>
- <tr class="separator:a04d1c43e80743f8c1a51b64062ce16dd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa0e074c891f3db5ea2ebd491667b03a6"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:aa0e074c891f3db5ea2ebd491667b03a6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09f8beb55f939874e93c1df6c8a046d4"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a09f8beb55f939874e93c1df6c8a046d4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3a393624d52854e74bf385c9e513a86d"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a3a393624d52854e74bf385c9e513a86d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8792c863080576eb65ce6cacbe1dd931"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a8792c863080576eb65ce6cacbe1dd931">name</a> () const</td></tr>
- <tr class="separator:a8792c863080576eb65ce6cacbe1dd931"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab1e224aba9eb796c7ad48062cc1434c2"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:ab1e224aba9eb796c7ad48062cc1434c2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad0be05c5c7092317089872778052cbd7"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:ad0be05c5c7092317089872778052cbd7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a414b64dc30551e05dcc46f04e0f6413a"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a414b64dc30551e05dcc46f04e0f6413a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a825447643e6c9e8284a3ed78e3363788"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a825447643e6c9e8284a3ed78e3363788"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a89b6021cf70b7adb9feb162260d5a101"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a89b6021cf70b7adb9feb162260d5a101"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ada8cd27e9a2f604f5c05088024a46a63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ex_file.html">ExFile</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_file.html#ada8cd27e9a2f604f5c05088024a46a63">openNextFile</a> (oflag_t oflag=0X00)</td></tr>
- <tr class="separator:ada8cd27e9a2f604f5c05088024a46a63"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af664c1da1bfa0bb5f6eb933bc25f757e"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:af664c1da1bfa0bb5f6eb933bc25f757e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa1abbd813f27d488f0ff439ccbc9ca98"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aa1abbd813f27d488f0ff439ccbc9ca98">operator bool</a> ()</td></tr>
- <tr class="separator:aa1abbd813f27d488f0ff439ccbc9ca98"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0da96e502485133ca0cff27fa130082"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#af0da96e502485133ca0cff27fa130082">peek</a> ()</td></tr>
- <tr class="separator:af0da96e502485133ca0cff27fa130082"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a18a04d1e68a0c1e3e38e5712cd9bbc03">position</a> ()</td></tr>
- <tr class="separator:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35a5093014e80965e49c84b61780556f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a35a5093014e80965e49c84b61780556f">preAllocate</a> (uint64_t length)</td></tr>
- <tr class="separator:a35a5093014e80965e49c84b61780556f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad9ba8aa00b9db683d40fc2989dbe1922"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:ad9ba8aa00b9db683d40fc2989dbe1922"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7318b2d7594d6ba52421c413f5fc35cd"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a7318b2d7594d6ba52421c413f5fc35cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a496ac61e367a24665425d54956a46346"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a496ac61e367a24665425d54956a46346"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a70eda4191df90f608694c1faede7fb33"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a70eda4191df90f608694c1faede7fb33"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9759c13e804c01ff9e7e2ac8fbabc5b8"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
- <tr class="memitem:a9759c13e804c01ff9e7e2ac8fbabc5b8"><td class="memTemplItemLeft" align="right" valign="top">size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a9759c13e804c01ff9e7e2ac8fbabc5b8">printField</a> (Type value, char term)</td></tr>
- <tr class="separator:a9759c13e804c01ff9e7e2ac8fbabc5b8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a16d527f98cff3ffd3ba8bc594a22d186"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a16d527f98cff3ffd3ba8bc594a22d186"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a16488d3e0d946f108240b7d6c536c6f4"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a16488d3e0d946f108240b7d6c536c6f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a095c0a865e5e5b6463c3dc0c90680635"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a095c0a865e5e5b6463c3dc0c90680635"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a249a5d428f303e2a8e7c3ae476e74829"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read</a> ()</td></tr>
- <tr class="separator:a249a5d428f303e2a8e7c3ae476e74829"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ae5477efe55179cf07e173c62654313"><td class="memItemLeft" align="right" valign="top">int </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>
- <tr class="separator:a5ae5477efe55179cf07e173c62654313"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e88c8e79551a72cc98310038514c47a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a8e88c8e79551a72cc98310038514c47a">remove</a> ()</td></tr>
- <tr class="separator:a8e88c8e79551a72cc98310038514c47a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad10417a851dba3d40a78eb2c0eb11fff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ad10417a851dba3d40a78eb2c0eb11fff">remove</a> (const ExChar_t *path)</td></tr>
- <tr class="separator:ad10417a851dba3d40a78eb2c0eb11fff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aab50b2646035f76834c75230d2b55c64"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aab50b2646035f76834c75230d2b55c64">rename</a> (const ExChar_t *newPath)</td></tr>
- <tr class="separator:aab50b2646035f76834c75230d2b55c64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea570a3b6afbe633d874803b137a46b8"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:aea570a3b6afbe633d874803b137a46b8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c1d3ef65284ffb13ed3ceee472adf9a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a3c1d3ef65284ffb13ed3ceee472adf9a">rewind</a> ()</td></tr>
- <tr class="separator:a3c1d3ef65284ffb13ed3ceee472adf9a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a91e8cfbde27d6879b4f51d2ceb2a9f06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a91e8cfbde27d6879b4f51d2ceb2a9f06">rewindDirectory</a> ()</td></tr>
- <tr class="separator:a91e8cfbde27d6879b4f51d2ceb2a9f06"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0165e0fde12a53e419bd92cd37f9cfed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a0165e0fde12a53e419bd92cd37f9cfed">rmdir</a> ()</td></tr>
- <tr class="separator:a0165e0fde12a53e419bd92cd37f9cfed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a773ee6f661fc689a5187f51cb5498086"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a773ee6f661fc689a5187f51cb5498086">seek</a> (uint64_t pos)</td></tr>
- <tr class="separator:a773ee6f661fc689a5187f51cb5498086"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab42494880cf229adfb0fc8edb0647686"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#ab42494880cf229adfb0fc8edb0647686">seekCur</a> (int64_t offset)</td></tr>
- <tr class="separator:ab42494880cf229adfb0fc8edb0647686"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2994a71751ed4f137f48b2e9a7d94091"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a2994a71751ed4f137f48b2e9a7d94091">seekEnd</a> (int64_t offset=0)</td></tr>
- <tr class="separator:a2994a71751ed4f137f48b2e9a7d94091"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9834c4da2f14c66f4bda26938ebb36f6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a9834c4da2f14c66f4bda26938ebb36f6">seekSet</a> (uint64_t pos)</td></tr>
- <tr class="separator:a9834c4da2f14c66f4bda26938ebb36f6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a> ()</td></tr>
- <tr class="separator:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2cb3638069afd2d01b79e5dff1a66f55"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a2cb3638069afd2d01b79e5dff1a66f55">sync</a> ()</td></tr>
- <tr class="separator:a2cb3638069afd2d01b79e5dff1a66f55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d3ab10983e206401ebd5c24a1c46174"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="separator:a6d3ab10983e206401ebd5c24a1c46174"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aca37955d3c7cce40f7f9e1ea078e5636"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#aca37955d3c7cce40f7f9e1ea078e5636">truncate</a> ()</td></tr>
- <tr class="separator:aca37955d3c7cce40f7f9e1ea078e5636"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6262b0d6d43d2a426953a0a7d90f624f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a6262b0d6d43d2a426953a0a7d90f624f">truncate</a> (uint64_t length)</td></tr>
- <tr class="separator:a6262b0d6d43d2a426953a0a7d90f624f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afc8af11ba8e3a830dff1dd5e59446243"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#afc8af11ba8e3a830dff1dd5e59446243">validLength</a> ()</td></tr>
- <tr class="separator:afc8af11ba8e3a830dff1dd5e59446243"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6fb2905a5e363554a5118b5d1322cd87"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_file.html#a6fb2905a5e363554a5118b5d1322cd87">write</a> (const char *str)</td></tr>
- <tr class="separator:a6fb2905a5e363554a5118b5d1322cd87"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc1423c7b550614d1067e7173f8b46a8"><td class="memItemLeft" align="right" valign="top">size_t </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>
- <tr class="separator:abc1423c7b550614d1067e7173f8b46a8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0695220134825199b39dee82f18ab1ec"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write</a> (uint8_t b)</td></tr>
- <tr class="separator:a0695220134825199b39dee82f18ab1ec"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>exFAT file with Arduino Stream. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="a0112cc39b64aac6f1ec47741397a7582"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0112cc39b64aac6f1ec47741397a7582">◆ </a></span>available()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::available </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="adcf47e15b819fe2d6faac2a027ab30f5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adcf47e15b819fe2d6faac2a027ab30f5">◆ </a></span>available64()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t ExFatFile::available64 </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="ac2004e7bf328b3edda7d4c3acba2726f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac2004e7bf328b3edda7d4c3acba2726f">◆ </a></span>clearError()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ExFatFile::clearError </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear all error bits. </p>
-
- </div>
- </div>
- <a id="abc0d3863895c17df53930bdfa84cb06f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abc0d3863895c17df53930bdfa84cb06f">◆ </a></span>clearWriteError()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ExFatFile::clearWriteError </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set writeError to zero </p>
-
- </div>
- </div>
- <a id="a7ba9e04099bdf8fd34220ebfdde72867"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7ba9e04099bdf8fd34220ebfdde72867">◆ </a></span>close()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::close </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Close a file and force cached data and directory information to be written to the storage device.</p>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ab49396aad3f6500aa19f75490dc26719"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab49396aad3f6500aa19f75490dc26719">◆ </a></span>curPosition()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t ExFatFile::curPosition </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>
-
- </div>
- </div>
- <a id="ada4dde9f2eed36bf556fcf1bd3d28ccf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ada4dde9f2eed36bf556fcf1bd3d28ccf">◆ </a></span>dataLength()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t ExFatFile::dataLength </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>Total data length for file. </dd></dl>
-
- </div>
- </div>
- <a id="a5e3baa5d5269c2948cfaf604c42f6a16"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5e3baa5d5269c2948cfaf604c42f6a16">◆ </a></span>dirIndex()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint32_t ExFatFile::dirIndex </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>
-
- </div>
- </div>
- <a id="a22a717ddc6d2004c540c67a14264d9dd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a22a717ddc6d2004c540c67a14264d9dd">◆ </a></span>exists()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::exists </td>
- <td>(</td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Test for the existence of a file in a directory</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
- </table>
- </dd>
- </dl>
- <p>The calling instance must be an open directory file.</p>
- <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>
- <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
-
- </div>
- </div>
- <a id="a8614bcbf04b7bbfc70fe36d2fa7f70c1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8614bcbf04b7bbfc70fe36d2fa7f70c1">◆ </a></span>fgetpos()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ExFatFile::fgetpos </td>
- <td>(</td>
- <td class="paramtype">fspos_t * </td>
- <td class="paramname"><em>pos</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a id="abc69c9dfc8fdb4ebf9db3bc37c879dc6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abc69c9dfc8fdb4ebf9db3bc37c879dc6">◆ </a></span>fgets()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int ExFatFile::fgets </td>
- <td>(</td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>str</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>num</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a string from a file.</p>
- <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>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>
- <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>
- <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>
- </table>
- </dd>
- </dl>
- <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>
-
- </div>
- </div>
- <a id="af2c08909b62b01f3edc4ee0c51ea7435"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af2c08909b62b01f3edc4ee0c51ea7435">◆ </a></span>fileSize()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t ExFatFile::fileSize </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>
-
- </div>
- </div>
- <a id="a32f813e659414892a58aa5157fe14f82"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a32f813e659414892a58aa5157fe14f82">◆ </a></span>flush()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::flush </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Ensure that any bytes written to the file are saved to the SD card. </p>
-
- </div>
- </div>
- <a id="aea1e4d0c0981081774dc3c7cd3c55264"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea1e4d0c0981081774dc3c7cd3c55264">◆ </a></span>fsetpos()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ExFatFile::fsetpos </td>
- <td>(</td>
- <td class="paramtype">const fspos_t * </td>
- <td class="paramname"><em>pos</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a id="ac697224450ca216c60585d25f5f6e310"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac697224450ca216c60585d25f5f6e310">◆ </a></span>getError()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint8_t ExFatFile::getError </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>
-
- </div>
- </div>
- <a id="aba93e2c18be9fa4df7e067b7d6ac5906"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aba93e2c18be9fa4df7e067b7d6ac5906">◆ </a></span>getName()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::getName </td>
- <td>(</td>
- <td class="paramtype">ExChar_t * </td>
- <td class="paramname"><em>name</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a file's name followed by a zero byte.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in characters. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>the name length. </dd></dl>
-
- </div>
- </div>
- <a id="a01da9896a59671a61f90dd20c3ac5d07"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a01da9896a59671a61f90dd20c3ac5d07">◆ </a></span>getWriteError()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::getWriteError </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>
-
- </div>
- </div>
- <a id="a7a167102bd47b7cf91167b69f8cc57d1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7a167102bd47b7cf91167b69f8cc57d1">◆ </a></span>isContiguous()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isContiguous </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>
-
- </div>
- </div>
- <a id="ad0a3687bd95bed5b216651335e66b500"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad0a3687bd95bed5b216651335e66b500">◆ </a></span>isDir()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isDir </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if this is a directory. </dd></dl>
-
- </div>
- </div>
- <a id="a586ad44055eca4c1b2b457299b829d44"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">◆ </a></span>isDirectory()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::isDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="af601285f95db8398c140b3927cf9111c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af601285f95db8398c140b3927cf9111c">◆ </a></span>isFile()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isFile </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file. </dd></dl>
-
- </div>
- </div>
- <a id="ac926285fa4321ebee28fa91beb511eae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac926285fa4321ebee28fa91beb511eae">◆ </a></span>isHidden()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isHidden </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden. </dd></dl>
-
- </div>
- </div>
- <a id="a804c34bbe3ebefe2b6c1d77ff8d49a35"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a804c34bbe3ebefe2b6c1d77ff8d49a35">◆ </a></span>isOpen()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isOpen </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true if the file is open. </dd></dl>
-
- </div>
- </div>
- <a id="a9ca137dfba2c7772910f4d2b3fdd9411"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9ca137dfba2c7772910f4d2b3fdd9411">◆ </a></span>isReadable()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isReadable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
-
- </div>
- </div>
- <a id="a14d160bfbfb39717746b93fa2eda5739"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a14d160bfbfb39717746b93fa2eda5739">◆ </a></span>isReadOnly()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isReadOnly </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>
-
- </div>
- </div>
- <a id="ad9f8e7afcf749ebcaaf055bd569dc7da"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad9f8e7afcf749ebcaaf055bd569dc7da">◆ </a></span>isRoot()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isRoot </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>
-
- </div>
- </div>
- <a id="ad7e02a1db8fb5a90288bb4679e9ddcb9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad7e02a1db8fb5a90288bb4679e9ddcb9">◆ </a></span>isSubDir()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isSubDir </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory. </dd></dl>
-
- </div>
- </div>
- <a id="a04d1c43e80743f8c1a51b64062ce16dd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a04d1c43e80743f8c1a51b64062ce16dd">◆ </a></span>isWritable()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::isWritable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
-
- </div>
- </div>
- <a id="aa0e074c891f3db5ea2ebd491667b03a6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa0e074c891f3db5ea2ebd491667b03a6">◆ </a></span>ls() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::ls </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>List directory contents.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a09f8beb55f939874e93c1df6c8a046d4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a09f8beb55f939874e93c1df6c8a046d4">◆ </a></span>ls() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::ls </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>flags</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>indent</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>List directory contents.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
- </table>
- </dd>
- </dl>
- <p>LS_DATE - Print file modification date</p>
- <p>LS_SIZE - Print file size.</p>
- <p>LS_R - Recursive list of subdirectories.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a3a393624d52854e74bf385c9e513a86d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3a393624d52854e74bf385c9e513a86d">◆ </a></span>mkdir()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::mkdir </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> * </td>
- <td class="paramname"><em>parent</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>pFlag</em> = <code>true</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Make a new directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">parent</td><td>An open directory file that will contain the new directory.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the new directory.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a8792c863080576eb65ce6cacbe1dd931"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">◆ </a></span>name()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const char* <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::name </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>No longer implemented due to Long File Names.</p>
- <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>
-
- </div>
- </div>
- <a id="ab1e224aba9eb796c7ad48062cc1434c2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab1e224aba9eb796c7ad48062cc1434c2">◆ </a></span>open() <span class="overload">[1/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::open </td>
- <td>(</td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>oflag</em> = <code>0X00</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file in the current working directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ad0be05c5c7092317089872778052cbd7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad0be05c5c7092317089872778052cbd7">◆ </a></span>open() <span class="overload">[2/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> * </td>
- <td class="paramname"><em>dirFile</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">oflag_t </td>
- <td class="paramname"><em>oflag</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file or directory by name.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open directory containing the file to be opened.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path for a file to be opened.</td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <p>O_RDONLY - Open for reading.</p>
- <p>O_READ - Same as O_RDONLY.</p>
- <p>O_WRONLY - Open for writing.</p>
- <p>O_WRITE - Same as O_WRONLY.</p>
- <p>O_RDWR - Open for reading and writing.</p>
- <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>
- <p>O_AT_END - Set the initial position at the end of the file.</p>
- <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>
- <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>
- <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>
- <p>WARNING: A given file must not be opened by more than one file object or file corruption may occur.</p>
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a414b64dc30551e05dcc46f04e0f6413a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a414b64dc30551e05dcc46f04e0f6413a">◆ </a></span>open() <span class="overload">[3/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> * </td>
- <td class="paramname"><em>dirFile</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">oflag_t </td>
- <td class="paramname"><em>oflag</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file by index.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <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>
- <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>
- </table>
- </dd>
- </dl>
- <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>
-
- </div>
- </div>
- <a id="a825447643e6c9e8284a3ed78e3363788"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a825447643e6c9e8284a3ed78e3363788">◆ </a></span>open() <span class="overload">[4/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> * </td>
- <td class="paramname"><em>vol</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>oflag</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file in the volume working directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a89b6021cf70b7adb9feb162260d5a101"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a89b6021cf70b7adb9feb162260d5a101">◆ </a></span>openNext()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::openNext </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> * </td>
- <td class="paramname"><em>dirFile</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">oflag_t </td>
- <td class="paramname"><em>oflag</em> = <code>0X00</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open the next file or subdirectory in a directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ada8cd27e9a2f604f5c05088024a46a63"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ada8cd27e9a2f604f5c05088024a46a63">◆ </a></span>openNextFile()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_ex_file.html">ExFile</a> ExFile::openNextFile </td>
- <td>(</td>
- <td class="paramtype">oflag_t </td>
- <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Opens the next file or folder in a directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>
-
- </div>
- </div>
- <a id="af664c1da1bfa0bb5f6eb933bc25f757e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af664c1da1bfa0bb5f6eb933bc25f757e">◆ </a></span>openRoot()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::openRoot </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_volume.html">ExFatVolume</a> * </td>
- <td class="paramname"><em>vol</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a volume's root directory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="aa1abbd813f27d488f0ff439ccbc9ca98"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa1abbd813f27d488f0ff439ccbc9ca98">◆ </a></span>operator bool()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">ExFatFile::operator bool </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The parenthesis operator.</p>
- <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>
-
- </div>
- </div>
- <a id="af0da96e502485133ca0cff27fa130082"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">◆ </a></span>peek()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::peek </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the next available byte without consuming it.</p>
- <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>
-
- </div>
- </div>
- <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">◆ </a></span>position()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::position </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>
-
- </div>
- </div>
- <a id="a35a5093014e80965e49c84b61780556f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35a5093014e80965e49c84b61780556f">◆ </a></span>preAllocate()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::preAllocate </td>
- <td>(</td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>length</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allocate contiguous clusters to an empty file.</p>
- <p>The file must be empty with no clusters allocated.</p>
- <p>The file will have zero validLength and dataLength will equal the requested length.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of allocated space in bytes. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ad9ba8aa00b9db683d40fc2989dbe1922"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad9ba8aa00b9db683d40fc2989dbe1922">◆ </a></span>printAccessDateTime()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printAccessDateTime </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a file's access date and time</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a7318b2d7594d6ba52421c413f5fc35cd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7318b2d7594d6ba52421c413f5fc35cd">◆ </a></span>printCreateDateTime()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printCreateDateTime </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a file's creation date and time</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a496ac61e367a24665425d54956a46346"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a496ac61e367a24665425d54956a46346">◆ </a></span>printField() <span class="overload">[1/3]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printField </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>term</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>prec</em> = <code>2</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
-
- </div>
- </div>
- <a id="a70eda4191df90f608694c1faede7fb33"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a70eda4191df90f608694c1faede7fb33">◆ </a></span>printField() <span class="overload">[2/3]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printField </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>term</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>prec</em> = <code>2</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
-
- </div>
- </div>
- <a id="a9759c13e804c01ff9e7e2ac8fbabc5b8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9759c13e804c01ff9e7e2ac8fbabc5b8">◆ </a></span>printField() <span class="overload">[3/3]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename Type > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printField </td>
- <td>(</td>
- <td class="paramtype">Type </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char </td>
- <td class="paramname"><em>term</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
-
- </div>
- </div>
- <a id="a16d527f98cff3ffd3ba8bc594a22d186"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a16d527f98cff3ffd3ba8bc594a22d186">◆ </a></span>printFileSize()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printFileSize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a file's size in bytes. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Prtin stream for the output. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>
-
- </div>
- </div>
- <a id="a16488d3e0d946f108240b7d6c536c6f4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a16488d3e0d946f108240b7d6c536c6f4">◆ </a></span>printModifyDateTime()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printModifyDateTime </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a file's modify date and time</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a095c0a865e5e5b6463c3dc0c90680635"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a095c0a865e5e5b6463c3dc0c90680635">◆ </a></span>printName()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::printName </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> * </td>
- <td class="paramname"><em>pr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Print a file's name</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">◆ </a></span>read() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::read </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Read the next byte from a file.</p>
- <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>
-
- </div>
- </div>
- <a id="a5ae5477efe55179cf07e173c62654313"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ae5477efe55179cf07e173c62654313">◆ </a></span>read() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int ExFatFile::read </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>buf</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>count</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Read data from a file starting at the current position.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
-
- </div>
- </div>
- <a id="a8e88c8e79551a72cc98310038514c47a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8e88c8e79551a72cc98310038514c47a">◆ </a></span>remove() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::remove </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a file.</p>
- <p>The directory entry and all data for the file are deleted.</p>
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ad10417a851dba3d40a78eb2c0eb11fff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad10417a851dba3d40a78eb2c0eb11fff">◆ </a></span>remove() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::remove </td>
- <td>(</td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>path</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a file.</p>
- <p>The directory entry and all data for the file are deleted.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>
- </table>
- </dd>
- </dl>
- <p>Example use: dirFile.remove(filenameToRemove);</p>
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="aab50b2646035f76834c75230d2b55c64"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aab50b2646035f76834c75230d2b55c64">◆ </a></span>rename() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::rename </td>
- <td>(</td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>newPath</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rename a file or subdirectory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="aea570a3b6afbe633d874803b137a46b8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea570a3b6afbe633d874803b137a46b8">◆ </a></span>rename() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::rename </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_ex_fat_file.html">ExFatFile</a> * </td>
- <td class="paramname"><em>dirFile</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const ExChar_t * </td>
- <td class="paramname"><em>newPath</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rename a file or subdirectory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a3c1d3ef65284ffb13ed3ceee472adf9a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3c1d3ef65284ffb13ed3ceee472adf9a">◆ </a></span>rewind()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ExFatFile::rewind </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the file's current position to zero. </p>
-
- </div>
- </div>
- <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">◆ </a></span>rewindDirectory()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::rewindDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rewind a file if it is a directory </p>
-
- </div>
- </div>
- <a id="a0165e0fde12a53e419bd92cd37f9cfed"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0165e0fde12a53e419bd92cd37f9cfed">◆ </a></span>rmdir()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::rmdir </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a directory file.</p>
- <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>
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a773ee6f661fc689a5187f51cb5498086"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">◆ </a></span>seek()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::seek </td>
- <td>(</td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>pos</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="ab42494880cf229adfb0fc8edb0647686"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab42494880cf229adfb0fc8edb0647686">◆ </a></span>seekCur()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::seekCur </td>
- <td>(</td>
- <td class="paramtype">int64_t </td>
- <td class="paramname"><em>offset</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a2994a71751ed4f137f48b2e9a7d94091"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2994a71751ed4f137f48b2e9a7d94091">◆ </a></span>seekEnd()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::seekEnd </td>
- <td>(</td>
- <td class="paramtype">int64_t </td>
- <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a9834c4da2f14c66f4bda26938ebb36f6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9834c4da2f14c66f4bda26938ebb36f6">◆ </a></span>seekSet()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::seekSet </td>
- <td>(</td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>pos</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets a file's position.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">◆ </a></span>size()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::size </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>
-
- </div>
- </div>
- <a id="a2cb3638069afd2d01b79e5dff1a66f55"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2cb3638069afd2d01b79e5dff1a66f55">◆ </a></span>sync()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::sync </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a6d3ab10983e206401ebd5c24a1c46174"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6d3ab10983e206401ebd5c24a1c46174">◆ </a></span>timestamp()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::timestamp </td>
- <td>(</td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>flags</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint16_t </td>
- <td class="paramname"><em>year</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>month</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>day</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>hour</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>minute</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>second</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Truncate a file at the current file position.</p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <p>T_ACCESS - Set the file's last access date.</p>
- <p>T_CREATE - Set the file's creation date and time.</p>
- <p>T_WRITE - Set the file's last write/modification date and time.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dd>
- Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="aca37955d3c7cce40f7f9e1ea078e5636"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aca37955d3c7cce40f7f9e1ea078e5636">◆ </a></span>truncate() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::truncate </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a6262b0d6d43d2a426953a0a7d90f624f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6262b0d6d43d2a426953a0a7d90f624f">◆ </a></span>truncate() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool ExFatFile::truncate </td>
- <td>(</td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>length</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
-
- </div>
- </div>
- <a id="afc8af11ba8e3a830dff1dd5e59446243"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afc8af11ba8e3a830dff1dd5e59446243">◆ </a></span>validLength()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint64_t ExFatFile::validLength </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The valid number of bytes in a file. </dd></dl>
-
- </div>
- </div>
- <a id="a6fb2905a5e363554a5118b5d1322cd87"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6fb2905a5e363554a5118b5d1322cd87">◆ </a></span>write() <span class="overload">[1/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::write </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>str</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>
-
- </div>
- </div>
- <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">◆ </a></span>write() <span class="overload">[2/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::write </td>
- <td>(</td>
- <td class="paramtype">const uint8_t * </td>
- <td class="paramname"><em>buffer</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write data to an open file.</p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
-
- </div>
- </div>
- <a id="abc1423c7b550614d1067e7173f8b46a8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abc1423c7b550614d1067e7173f8b46a8">◆ </a></span>write() <span class="overload">[3/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t ExFatFile::write </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>buf</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>count</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write data to an open file.</p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>
- </table>
- </dd>
- </dl>
- <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>
-
- </div>
- </div>
- <a id="a0695220134825199b39dee82f18ab1ec"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">◆ </a></span>write() <span class="overload">[4/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>< <a class="el" href="class_ex_fat_file.html">ExFatFile</a> , uint64_t >::write </td>
- <td>(</td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>b</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_file_8h.html">ExFatFile.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Fri Dec 6 2019 09:45:12 for SdFat by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.16
- </small></address>
- </body>
- </html>
|