class_fat_file.html 147 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: FatFile Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  65. <a href="#friends">Friends</a> &#124;
  66. <a href="class_fat_file-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">FatFile Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>Basic file class.
  72. <a href="class_fat_file.html#details">More...</a></p>
  73. <p><code>#include &lt;FatFile.h&gt;</code></p>
  74. <div class="dynheader">
  75. Inheritance diagram for FatFile:</div>
  76. <div class="dyncontent">
  77. <div class="center"><img src="class_fat_file__inherit__graph.png" border="0" usemap="#_fat_file_inherit__map" alt="Inheritance graph"/></div>
  78. <map name="_fat_file_inherit__map" id="_fat_file_inherit__map">
  79. <area shape="rect" title="Basic file class." alt="" coords="273,5,336,32"/>
  80. <area shape="rect" href="class_print_file.html" title=" " alt="" coords="5,87,167,114"/>
  81. <area shape="rect" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream." alt="" coords="191,87,285,114"/>
  82. <area shape="rect" href="class_stream_base_class.html" title="base type for FAT and exFAT streams" alt="" coords="309,87,436,114"/>
  83. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="467,80,609,121"/>
  84. <area shape="rect" href="class_sd_file.html" title="FAT16/FAT32 file with Print." alt="" coords="57,169,115,196"/>
  85. <area shape="rect" href="classfstream.html" title="file input/output stream." alt="" coords="243,169,308,196"/>
  86. <area shape="rect" href="classifstream.html" title="file input stream." alt="" coords="332,169,400,196"/>
  87. <area shape="rect" href="classofstream.html" title="file output stream." alt="" coords="425,169,497,196"/>
  88. <area shape="rect" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="521,169,579,196"/>
  89. </map>
  90. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  93. Public Member Functions</h2></td></tr>
  94. <tr class="memitem:a4baea142c9cd53293a93ef3d6a67aa16"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4baea142c9cd53293a93ef3d6a67aa16">available</a> ()</td></tr>
  95. <tr class="separator:a4baea142c9cd53293a93ef3d6a67aa16"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a651ffa37e7e586fc3c2de8cbbd500ea6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a651ffa37e7e586fc3c2de8cbbd500ea6">available32</a> ()</td></tr>
  97. <tr class="separator:a651ffa37e7e586fc3c2de8cbbd500ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a052e2c15a39b322a5307b693b8835b22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a052e2c15a39b322a5307b693b8835b22">clearError</a> ()</td></tr>
  99. <tr class="separator:a052e2c15a39b322a5307b693b8835b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:aeca2a2eff91e6aa55fe1b0e3860c9a05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aeca2a2eff91e6aa55fe1b0e3860c9a05">clearWriteError</a> ()</td></tr>
  101. <tr class="separator:aeca2a2eff91e6aa55fe1b0e3860c9a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:afd16af325e0642e4bff6430b7d8bb18b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd16af325e0642e4bff6430b7d8bb18b">close</a> ()</td></tr>
  103. <tr class="separator:afd16af325e0642e4bff6430b7d8bb18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a12b3c5a763416ca62c70e3db74033cd0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a12b3c5a763416ca62c70e3db74033cd0">contiguousRange</a> (uint32_t *bgnSector, uint32_t *endSector)</td></tr>
  105. <tr class="separator:a12b3c5a763416ca62c70e3db74033cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a0853fbd44aee2798d14d8e3aed78f8bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0853fbd44aee2798d14d8e3aed78f8bf">createContiguous</a> (const char *path, uint32_t size)</td></tr>
  107. <tr class="separator:a0853fbd44aee2798d14d8e3aed78f8bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0afc2a1cffa238d1cb2049bfa2d8d199">createContiguous</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint32_t size)</td></tr>
  109. <tr class="separator:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a526f3dd56ce205690e45ffc86ef6f891"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a526f3dd56ce205690e45ffc86ef6f891">curCluster</a> () const</td></tr>
  111. <tr class="separator:a526f3dd56ce205690e45ffc86ef6f891"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a97e0620949f97e9b9c91ed1094d728aa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a97e0620949f97e9b9c91ed1094d728aa">curPosition</a> () const</td></tr>
  113. <tr class="separator:a97e0620949f97e9b9c91ed1094d728aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a2f4e9ab3056125b07f15d14ca26d5346"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a2f4e9ab3056125b07f15d14ca26d5346">dirEntry</a> (DirFat_t *dir)</td></tr>
  115. <tr class="separator:a2f4e9ab3056125b07f15d14ca26d5346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae5ec24d4a94d3780384d3f2b731c7eb9">dirIndex</a> ()</td></tr>
  117. <tr class="separator:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae2ed15f05c9ccbce355e7a8d3ce8382d">dirSize</a> ()</td></tr>
  119. <tr class="separator:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4f01d27954ae49aeb6888ac7302f55d9">dmpFile</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>
  121. <tr class="separator:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a50242f98dea0d4488ce4039a279f2a57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a50242f98dea0d4488ce4039a279f2a57">exists</a> (const char *path)</td></tr>
  123. <tr class="separator:a50242f98dea0d4488ce4039a279f2a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a7b591c9b92165fa8e4eae8c30c30e533"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7b591c9b92165fa8e4eae8c30c30e533">FatFile</a> ()</td></tr>
  125. <tr class="separator:a7b591c9b92165fa8e4eae8c30c30e533"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a38f9a296138648d6135cbbbf41ef6b92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a38f9a296138648d6135cbbbf41ef6b92">FatFile</a> (const char *path, oflag_t oflag)</td></tr>
  127. <tr class="separator:a38f9a296138648d6135cbbbf41ef6b92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a33e0b0a8a342047f29ab8e8aae9cae14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a33e0b0a8a342047f29ab8e8aae9cae14">fgetpos</a> (fspos_t *pos)</td></tr>
  129. <tr class="separator:a33e0b0a8a342047f29ab8e8aae9cae14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a9e05a51767f7c8f70c6f337eecbdca03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets</a> (char *str, int num, char *delim=<a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>
  131. <tr class="separator:a9e05a51767f7c8f70c6f337eecbdca03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a874940574b9c99e763526465adf8dc28"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a874940574b9c99e763526465adf8dc28">fileSize</a> () const</td></tr>
  133. <tr class="separator:a874940574b9c99e763526465adf8dc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a5ac8a604863d18840f4a93c5c788b7c8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5ac8a604863d18840f4a93c5c788b7c8">firstBlock</a> () const</td></tr>
  135. <tr class="separator:a5ac8a604863d18840f4a93c5c788b7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:af3108df387f30ca3d367dd390a04daaa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af3108df387f30ca3d367dd390a04daaa">firstSector</a> () const</td></tr>
  137. <tr class="separator:af3108df387f30ca3d367dd390a04daaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a166b5ff04754cc925f2aee71bf92f800"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a166b5ff04754cc925f2aee71bf92f800">flush</a> ()</td></tr>
  139. <tr class="separator:a166b5ff04754cc925f2aee71bf92f800"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ac042c43d41ecfff4e101b88f3f82086e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac042c43d41ecfff4e101b88f3f82086e">fsetpos</a> (const fspos_t *pos)</td></tr>
  141. <tr class="separator:ac042c43d41ecfff4e101b88f3f82086e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a5d085c695e920b658a1505e480bc467f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5d085c695e920b658a1505e480bc467f">getAccessDate</a> (uint16_t *pdate)</td></tr>
  143. <tr class="separator:a5d085c695e920b658a1505e480bc467f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:af70c42baeb45e0d7047ae63de568d0d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af70c42baeb45e0d7047ae63de568d0d2">getAccessDateTime</a> (uint16_t *pdate, uint16_t *ptime)</td></tr>
  145. <tr class="separator:af70c42baeb45e0d7047ae63de568d0d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a94d484b5198032a9e00194e72182cc57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a94d484b5198032a9e00194e72182cc57">getCreateDateTime</a> (uint16_t *pdate, uint16_t *ptime)</td></tr>
  147. <tr class="separator:a94d484b5198032a9e00194e72182cc57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ad0dbbd083180f44c7a3ce7124d4ce19c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad0dbbd083180f44c7a3ce7124d4ce19c">getError</a> ()</td></tr>
  149. <tr class="separator:ad0dbbd083180f44c7a3ce7124d4ce19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a28537b48ed2cb886c5f22984d07492b7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a28537b48ed2cb886c5f22984d07492b7">getModifyDateTime</a> (uint16_t *pdate, uint16_t *ptime)</td></tr>
  151. <tr class="separator:a28537b48ed2cb886c5f22984d07492b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:aafa565e286440aab612cdb430fc01da5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aafa565e286440aab612cdb430fc01da5">getName</a> (char *name, size_t size)</td></tr>
  153. <tr class="separator:aafa565e286440aab612cdb430fc01da5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aba30e92a66f8e0d2f815c85662772a58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aba30e92a66f8e0d2f815c85662772a58">getSFN</a> (char *name)</td></tr>
  155. <tr class="separator:aba30e92a66f8e0d2f815c85662772a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a8062c0d3a118e8d77d0310418703d5f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8062c0d3a118e8d77d0310418703d5f5">getWriteError</a> ()</td></tr>
  157. <tr class="separator:a8062c0d3a118e8d77d0310418703d5f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a16478eafdb731e867fb627d19091c3ce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a16478eafdb731e867fb627d19091c3ce">isContiguous</a> () const</td></tr>
  159. <tr class="separator:a16478eafdb731e867fb627d19091c3ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a933360b20b496421b2bd9ee7a95563a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a933360b20b496421b2bd9ee7a95563a6">isDir</a> () const</td></tr>
  161. <tr class="separator:a933360b20b496421b2bd9ee7a95563a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:acc5a87da1a5c8cb9758bfeaa7ae47b57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acc5a87da1a5c8cb9758bfeaa7ae47b57">isFile</a> () const</td></tr>
  163. <tr class="separator:acc5a87da1a5c8cb9758bfeaa7ae47b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:ae216b4a2bc44a9cfb88478fa051a1fd8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae216b4a2bc44a9cfb88478fa051a1fd8">isHidden</a> () const</td></tr>
  165. <tr class="separator:ae216b4a2bc44a9cfb88478fa051a1fd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:af8f456ab790e818bfdd225cf6ffd40f3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af8f456ab790e818bfdd225cf6ffd40f3">isLFN</a> () const</td></tr>
  167. <tr class="separator:af8f456ab790e818bfdd225cf6ffd40f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a8b8a2850c086d3ce79bee64a23fbf7a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8b8a2850c086d3ce79bee64a23fbf7a6">isOpen</a> () const</td></tr>
  169. <tr class="separator:a8b8a2850c086d3ce79bee64a23fbf7a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ae60b4cedb69c88ac641813d5edfa6b4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae60b4cedb69c88ac641813d5edfa6b4a">isReadable</a> () const</td></tr>
  171. <tr class="separator:ae60b4cedb69c88ac641813d5edfa6b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:abaf639ec8f86f34aeb7e6b3615526f0b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abaf639ec8f86f34aeb7e6b3615526f0b">isReadOnly</a> () const</td></tr>
  173. <tr class="separator:abaf639ec8f86f34aeb7e6b3615526f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a03421a0c28649332f55e6ca06d3aeedb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a03421a0c28649332f55e6ca06d3aeedb">isRoot</a> () const</td></tr>
  175. <tr class="separator:a03421a0c28649332f55e6ca06d3aeedb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a8fda8004720ec4cc55710869dbb52e35"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8fda8004720ec4cc55710869dbb52e35">isRoot32</a> () const</td></tr>
  177. <tr class="separator:a8fda8004720ec4cc55710869dbb52e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a0cc65089f7ce6c1ff92edbf0bff59dee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0cc65089f7ce6c1ff92edbf0bff59dee">isRootFixed</a> () const</td></tr>
  179. <tr class="separator:a0cc65089f7ce6c1ff92edbf0bff59dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:abfd02c5d26f7d4f8739a8610116a6660"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abfd02c5d26f7d4f8739a8610116a6660">isSubDir</a> () const</td></tr>
  181. <tr class="separator:abfd02c5d26f7d4f8739a8610116a6660"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a48087bdeb6b94fc27e0f74c3d90af5a9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a48087bdeb6b94fc27e0f74c3d90af5a9">isSystem</a> () const</td></tr>
  183. <tr class="separator:a48087bdeb6b94fc27e0f74c3d90af5a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:aa484d5b2b147c5f3fe0e26b6eaf11ffc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa484d5b2b147c5f3fe0e26b6eaf11ffc">isWritable</a> () const</td></tr>
  185. <tr class="separator:aa484d5b2b147c5f3fe0e26b6eaf11ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a60ab9d16bcc778150a364c26de467de1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a60ab9d16bcc778150a364c26de467de1">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0, uint8_t indent=0)</td></tr>
  187. <tr class="separator:a60ab9d16bcc778150a364c26de467de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a6a11f3307da6232b5f2d11812832d93a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6a11f3307da6232b5f2d11812832d93a">ls</a> (uint8_t flags=0)</td></tr>
  189. <tr class="separator:a6a11f3307da6232b5f2d11812832d93a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:abab5b9f72cc796388dd4eed01d13d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abab5b9f72cc796388dd4eed01d13d90d">mkdir</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir, const char *path, bool pFlag=true)</td></tr>
  191. <tr class="separator:abab5b9f72cc796388dd4eed01d13d90d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:afd3e4d5a76b6751ca796fc57f4dd2be4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd3e4d5a76b6751ca796fc57f4dd2be4">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>
  193. <tr class="separator:afd3e4d5a76b6751ca796fc57f4dd2be4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:a58d6ea245f1bc3ae7a6df311cd25052f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, oflag_t oflag)</td></tr>
  195. <tr class="separator:a58d6ea245f1bc3ae7a6df311cd25052f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:ab44920bb9cd5414b8e69c9dc4343394a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab44920bb9cd5414b8e69c9dc4343394a">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, oflag_t oflag)</td></tr>
  197. <tr class="separator:ab44920bb9cd5414b8e69c9dc4343394a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:af49a42dc64cd954debb271eae5639059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol, const char *path, oflag_t oflag)</td></tr>
  199. <tr class="separator:af49a42dc64cd954debb271eae5639059"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a7f98b908a686574efbd7e1d20121ef9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7f98b908a686574efbd7e1d20121ef9a">openNext</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, oflag_t oflag=0X00)</td></tr>
  201. <tr class="separator:a7f98b908a686574efbd7e1d20121ef9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a7e0c0548fed3a69e7284b91b694439d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e0c0548fed3a69e7284b91b694439d4">openRoot</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol)</td></tr>
  203. <tr class="separator:a7e0c0548fed3a69e7284b91b694439d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:acd141c43d03cf790b3b9806f3b059e77"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acd141c43d03cf790b3b9806f3b059e77">operator bool</a> ()</td></tr>
  205. <tr class="separator:acd141c43d03cf790b3b9806f3b059e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:ac05b7136b887539426856c623869aa3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac05b7136b887539426856c623869aa3a">peek</a> ()</td></tr>
  207. <tr class="separator:ac05b7136b887539426856c623869aa3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:aeeb13b9de68bf9097c863c41d655ee83"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aeeb13b9de68bf9097c863c41d655ee83">preAllocate</a> (uint32_t length)</td></tr>
  209. <tr class="separator:aeeb13b9de68bf9097c863c41d655ee83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:a22be4c339d0bfa331f75415b74dd4f37"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a22be4c339d0bfa331f75415b74dd4f37">printAccessDate</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  211. <tr class="separator:a22be4c339d0bfa331f75415b74dd4f37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:a19b3196bb1f6a68a2447e53b09369aef"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a19b3196bb1f6a68a2447e53b09369aef">printAccessDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  213. <tr class="separator:a19b3196bb1f6a68a2447e53b09369aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:ab22396a285e27b53501a0047ddd97f59"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab22396a285e27b53501a0047ddd97f59">printCreateDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  215. <tr class="separator:ab22396a285e27b53501a0047ddd97f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:aa4a61a0cca1813d2ad0f6fe99cc4e41d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa4a61a0cca1813d2ad0f6fe99cc4e41d">printField</a> (double value, char term, uint8_t prec=2)</td></tr>
  217. <tr class="separator:aa4a61a0cca1813d2ad0f6fe99cc4e41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:a90ccef676afd62bbe7c773dd863a56e0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a90ccef676afd62bbe7c773dd863a56e0">printField</a> (float value, char term, uint8_t prec=2)</td></tr>
  219. <tr class="separator:a90ccef676afd62bbe7c773dd863a56e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  221. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8f906be79086f38943cb0911310d67bf">printField</a> (Type value, char term)</td></tr>
  222. <tr class="separator:a8f906be79086f38943cb0911310d67bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a12a5d2de2737c201aa39ca1bd2ab9c47">printFileSize</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  224. <tr class="separator:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:a43c8a1cabcae673e43c590f5db44c65a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a43c8a1cabcae673e43c590f5db44c65a">printModifyDateTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  226. <tr class="separator:a43c8a1cabcae673e43c590f5db44c65a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <tr class="memitem:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad1cbc3aeb0f5193b7a26595966da9621">printName</a> ()</td></tr>
  228. <tr class="separator:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:afe18a787fb8640e2d2483370c770f82f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe18a787fb8640e2d2483370c770f82f">printName</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  230. <tr class="separator:afe18a787fb8640e2d2483370c770f82f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:a791cd7aade71f609aab62ec018aea3c0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a791cd7aade71f609aab62ec018aea3c0">printSFN</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>
  232. <tr class="separator:a791cd7aade71f609aab62ec018aea3c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  233. <tr class="memitem:a60ae55ff6fe158c2340071d702a363c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read</a> ()</td></tr>
  234. <tr class="separator:a60ae55ff6fe158c2340071d702a363c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:aba893af8107a18017482d2311b066187"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aba893af8107a18017482d2311b066187">read</a> (void *buf, size_t count)</td></tr>
  236. <tr class="separator:aba893af8107a18017482d2311b066187"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:a29502cd34ef186763d2196daef27df1f"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir</a> (DirFat_t *dir)</td></tr>
  238. <tr class="separator:a29502cd34ef186763d2196daef27df1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  239. <tr class="memitem:ac837a537fbcca14c7aa390c5fc9f4e7c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove</a> ()</td></tr>
  240. <tr class="separator:ac837a537fbcca14c7aa390c5fc9f4e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  241. <tr class="memitem:a75d3276f0b02b03e863afafe5731fedb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a75d3276f0b02b03e863afafe5731fedb">remove</a> (const char *path)</td></tr>
  242. <tr class="separator:a75d3276f0b02b03e863afafe5731fedb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  243. <tr class="memitem:a4cebcac13c1f4c9de7a055ae73133599"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4cebcac13c1f4c9de7a055ae73133599">rename</a> (const char *newPath)</td></tr>
  244. <tr class="separator:a4cebcac13c1f4c9de7a055ae73133599"><td class="memSeparator" colspan="2">&#160;</td></tr>
  245. <tr class="memitem:a4b42f2454ff462555c07ea094a92a1e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4b42f2454ff462555c07ea094a92a1e0">rename</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *newPath)</td></tr>
  246. <tr class="separator:a4b42f2454ff462555c07ea094a92a1e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  247. <tr class="memitem:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5aac6e0b3cb08fc8b8668e916a8b0ca5">rewind</a> ()</td></tr>
  248. <tr class="separator:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. <tr class="memitem:a9515bac181d33e7f0125e88fa2ccd283"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir</a> ()</td></tr>
  250. <tr class="separator:a9515bac181d33e7f0125e88fa2ccd283"><td class="memSeparator" colspan="2">&#160;</td></tr>
  251. <tr class="memitem:ac780a80526f86d3def701ecdc99d8bfe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac780a80526f86d3def701ecdc99d8bfe">rmRfStar</a> ()</td></tr>
  252. <tr class="separator:ac780a80526f86d3def701ecdc99d8bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  253. <tr class="memitem:a5812037ea30777cc350698ad26f2c73f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5812037ea30777cc350698ad26f2c73f">seekCur</a> (int32_t offset)</td></tr>
  254. <tr class="separator:a5812037ea30777cc350698ad26f2c73f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  255. <tr class="memitem:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a84f677f4e75ef6fa2eb632f4cdf6b486">seekEnd</a> (int32_t offset=0)</td></tr>
  256. <tr class="separator:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memSeparator" colspan="2">&#160;</td></tr>
  257. <tr class="memitem:ab067190d25733ed7e697d9890f61fd7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet</a> (uint32_t pos)</td></tr>
  258. <tr class="separator:ab067190d25733ed7e697d9890f61fd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  259. <tr class="memitem:a67f3dc4896c542d695e11aac927f585e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync</a> ()</td></tr>
  260. <tr class="separator:a67f3dc4896c542d695e11aac927f585e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  261. <tr class="memitem:a56dabdf73833b7e961c4530eb8e16d23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a56dabdf73833b7e961c4530eb8e16d23">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>
  262. <tr class="separator:a56dabdf73833b7e961c4530eb8e16d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  263. <tr class="memitem:a7dda881dac19ea2aa9b2e85a229a98d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7dda881dac19ea2aa9b2e85a229a98d7">truncate</a> ()</td></tr>
  264. <tr class="separator:a7dda881dac19ea2aa9b2e85a229a98d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  265. <tr class="memitem:aa6e663098a578635d37d92e82d18d616"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa6e663098a578635d37d92e82d18d616">truncate</a> (uint32_t length)</td></tr>
  266. <tr class="separator:aa6e663098a578635d37d92e82d18d616"><td class="memSeparator" colspan="2">&#160;</td></tr>
  267. <tr class="memitem:a081dd810835f1ebf8c23ffe92706b485"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write</a> (const char *str)</td></tr>
  268. <tr class="separator:a081dd810835f1ebf8c23ffe92706b485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  269. <tr class="memitem:a5d84d871ac904a22aa48308713d14682"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5d84d871ac904a22aa48308713d14682">write</a> (const void *buf, size_t count)</td></tr>
  270. <tr class="separator:a5d84d871ac904a22aa48308713d14682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  271. <tr class="memitem:ae51e724ac6cc3d67d64a5a666d5850f1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae51e724ac6cc3d67d64a5a666d5850f1">write</a> (uint8_t b)</td></tr>
  272. <tr class="separator:ae51e724ac6cc3d67d64a5a666d5850f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  273. </table><table class="memberdecls">
  274. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  275. Static Public Member Functions</h2></td></tr>
  276. <tr class="memitem:a94df8090f16e9666cdc53ca20f6aff90"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a94df8090f16e9666cdc53ca20f6aff90">legal83Char</a> (uint8_t c)</td></tr>
  277. <tr class="separator:a94df8090f16e9666cdc53ca20f6aff90"><td class="memSeparator" colspan="2">&#160;</td></tr>
  278. <tr class="memitem:aabcd863883bfcfb37b63dbd6021f7eb8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aabcd863883bfcfb37b63dbd6021f7eb8">printFatDate</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatDate)</td></tr>
  279. <tr class="separator:aabcd863883bfcfb37b63dbd6021f7eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  280. <tr class="memitem:a7f84d953190ea94710dad9ebb897b957"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7f84d953190ea94710dad9ebb897b957">printFatTime</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatTime)</td></tr>
  281. <tr class="separator:a7f84d953190ea94710dad9ebb897b957"><td class="memSeparator" colspan="2">&#160;</td></tr>
  282. </table><table class="memberdecls">
  283. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  284. Friends</h2></td></tr>
  285. <tr class="memitem:a6ca3f436167f187097347a20ea221555"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6ca3f436167f187097347a20ea221555">FatVolume</a></td></tr>
  286. <tr class="separator:a6ca3f436167f187097347a20ea221555"><td class="memSeparator" colspan="2">&#160;</td></tr>
  287. </table>
  288. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  289. <div class="textblock"><p>Basic file class. </p>
  290. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  291. <a id="a7b591c9b92165fa8e4eae8c30c30e533"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#a7b591c9b92165fa8e4eae8c30c30e533">&#9670;&nbsp;</a></span>FatFile() <span class="overload">[1/2]</span></h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">FatFile::FatFile </td>
  301. <td>(</td>
  302. <td class="paramname"></td><td>)</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </td>
  307. <td class="mlabels-right">
  308. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <p>Create an instance. </p>
  313. </div>
  314. </div>
  315. <a id="a38f9a296138648d6135cbbbf41ef6b92"></a>
  316. <h2 class="memtitle"><span class="permalink"><a href="#a38f9a296138648d6135cbbbf41ef6b92">&#9670;&nbsp;</a></span>FatFile() <span class="overload">[2/2]</span></h2>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">FatFile::FatFile </td>
  325. <td>(</td>
  326. <td class="paramtype">const char *&#160;</td>
  327. <td class="paramname"><em>path</em>, </td>
  328. </tr>
  329. <tr>
  330. <td class="paramkey"></td>
  331. <td></td>
  332. <td class="paramtype">oflag_t&#160;</td>
  333. <td class="paramname"><em>oflag</em>&#160;</td>
  334. </tr>
  335. <tr>
  336. <td></td>
  337. <td>)</td>
  338. <td></td><td></td>
  339. </tr>
  340. </table>
  341. </td>
  342. <td class="mlabels-right">
  343. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <p>Create a file object and open it in the current working directory.</p>
  348. <dl class="params"><dt>Parameters</dt><dd>
  349. <table class="params">
  350. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>
  351. <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 open flags. see <a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>. </td></tr>
  352. </table>
  353. </dd>
  354. </dl>
  355. </div>
  356. </div>
  357. <h2 class="groupheader">Member Function Documentation</h2>
  358. <a id="a4baea142c9cd53293a93ef3d6a67aa16"></a>
  359. <h2 class="memtitle"><span class="permalink"><a href="#a4baea142c9cd53293a93ef3d6a67aa16">&#9670;&nbsp;</a></span>available()</h2>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="mlabels">
  363. <tr>
  364. <td class="mlabels-left">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">int FatFile::available </td>
  368. <td>(</td>
  369. <td class="paramname"></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </td>
  374. <td class="mlabels-right">
  375. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <dl class="section return"><dt>Returns</dt><dd>The number of bytes available from the current position to EOF for normal files. INT_MAX is returned for very large files.</dd></dl>
  380. <p>available64() is recomended for very large files.</p>
  381. <p>Zero is returned for directory files. </p>
  382. </div>
  383. </div>
  384. <a id="a651ffa37e7e586fc3c2de8cbbd500ea6"></a>
  385. <h2 class="memtitle"><span class="permalink"><a href="#a651ffa37e7e586fc3c2de8cbbd500ea6">&#9670;&nbsp;</a></span>available32()</h2>
  386. <div class="memitem">
  387. <div class="memproto">
  388. <table class="mlabels">
  389. <tr>
  390. <td class="mlabels-left">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname">uint32_t FatFile::available32 </td>
  394. <td>(</td>
  395. <td class="paramname"></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </td>
  400. <td class="mlabels-right">
  401. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <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>
  406. </div>
  407. </div>
  408. <a id="a052e2c15a39b322a5307b693b8835b22"></a>
  409. <h2 class="memtitle"><span class="permalink"><a href="#a052e2c15a39b322a5307b693b8835b22">&#9670;&nbsp;</a></span>clearError()</h2>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="mlabels">
  413. <tr>
  414. <td class="mlabels-left">
  415. <table class="memname">
  416. <tr>
  417. <td class="memname">void FatFile::clearError </td>
  418. <td>(</td>
  419. <td class="paramname"></td><td>)</td>
  420. <td></td>
  421. </tr>
  422. </table>
  423. </td>
  424. <td class="mlabels-right">
  425. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Clear all error bits. </p>
  430. </div>
  431. </div>
  432. <a id="aeca2a2eff91e6aa55fe1b0e3860c9a05"></a>
  433. <h2 class="memtitle"><span class="permalink"><a href="#aeca2a2eff91e6aa55fe1b0e3860c9a05">&#9670;&nbsp;</a></span>clearWriteError()</h2>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="mlabels">
  437. <tr>
  438. <td class="mlabels-left">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname">void FatFile::clearWriteError </td>
  442. <td>(</td>
  443. <td class="paramname"></td><td>)</td>
  444. <td></td>
  445. </tr>
  446. </table>
  447. </td>
  448. <td class="mlabels-right">
  449. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Set writeError to zero </p>
  454. </div>
  455. </div>
  456. <a id="afd16af325e0642e4bff6430b7d8bb18b"></a>
  457. <h2 class="memtitle"><span class="permalink"><a href="#afd16af325e0642e4bff6430b7d8bb18b">&#9670;&nbsp;</a></span>close()</h2>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">bool FatFile::close </td>
  463. <td>(</td>
  464. <td class="paramname"></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>Close a file and force cached data and directory information to be written to the storage device.</p>
  470. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  471. </div>
  472. </div>
  473. <a id="a12b3c5a763416ca62c70e3db74033cd0"></a>
  474. <h2 class="memtitle"><span class="permalink"><a href="#a12b3c5a763416ca62c70e3db74033cd0">&#9670;&nbsp;</a></span>contiguousRange()</h2>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname">bool FatFile::contiguousRange </td>
  480. <td>(</td>
  481. <td class="paramtype">uint32_t *&#160;</td>
  482. <td class="paramname"><em>bgnSector</em>, </td>
  483. </tr>
  484. <tr>
  485. <td class="paramkey"></td>
  486. <td></td>
  487. <td class="paramtype">uint32_t *&#160;</td>
  488. <td class="paramname"><em>endSector</em>&#160;</td>
  489. </tr>
  490. <tr>
  491. <td></td>
  492. <td>)</td>
  493. <td></td><td></td>
  494. </tr>
  495. </table>
  496. </div><div class="memdoc">
  497. <p>Check for contiguous file and return its raw sector range.</p>
  498. <dl class="params"><dt>Parameters</dt><dd>
  499. <table class="params">
  500. <tr><td class="paramdir">[out]</td><td class="paramname">bgnSector</td><td>the first sector address for the file. </td></tr>
  501. <tr><td class="paramdir">[out]</td><td class="paramname">endSector</td><td>the last sector address for the file.</td></tr>
  502. </table>
  503. </dd>
  504. </dl>
  505. <p>Set the contiguous flag if the file is contiguous. The parameters may be nullptr to only set the flag. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  506. </div>
  507. </div>
  508. <a id="a0853fbd44aee2798d14d8e3aed78f8bf"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#a0853fbd44aee2798d14d8e3aed78f8bf">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[1/2]</span></h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <table class="memname">
  513. <tr>
  514. <td class="memname">bool FatFile::createContiguous </td>
  515. <td>(</td>
  516. <td class="paramtype">const char *&#160;</td>
  517. <td class="paramname"><em>path</em>, </td>
  518. </tr>
  519. <tr>
  520. <td class="paramkey"></td>
  521. <td></td>
  522. <td class="paramtype">uint32_t&#160;</td>
  523. <td class="paramname"><em>size</em>&#160;</td>
  524. </tr>
  525. <tr>
  526. <td></td>
  527. <td>)</td>
  528. <td></td><td></td>
  529. </tr>
  530. </table>
  531. </div><div class="memdoc">
  532. <p>Create and open a new contiguous file of a specified size.</p>
  533. <dl class="params"><dt>Parameters</dt><dd>
  534. <table class="params">
  535. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid file name. </td></tr>
  536. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>
  537. </table>
  538. </dd>
  539. </dl>
  540. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  541. </div>
  542. </div>
  543. <a id="a0afc2a1cffa238d1cb2049bfa2d8d199"></a>
  544. <h2 class="memtitle"><span class="permalink"><a href="#a0afc2a1cffa238d1cb2049bfa2d8d199">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[2/2]</span></h2>
  545. <div class="memitem">
  546. <div class="memproto">
  547. <table class="memname">
  548. <tr>
  549. <td class="memname">bool FatFile::createContiguous </td>
  550. <td>(</td>
  551. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  552. <td class="paramname"><em>dirFile</em>, </td>
  553. </tr>
  554. <tr>
  555. <td class="paramkey"></td>
  556. <td></td>
  557. <td class="paramtype">const char *&#160;</td>
  558. <td class="paramname"><em>path</em>, </td>
  559. </tr>
  560. <tr>
  561. <td class="paramkey"></td>
  562. <td></td>
  563. <td class="paramtype">uint32_t&#160;</td>
  564. <td class="paramname"><em>size</em>&#160;</td>
  565. </tr>
  566. <tr>
  567. <td></td>
  568. <td>)</td>
  569. <td></td><td></td>
  570. </tr>
  571. </table>
  572. </div><div class="memdoc">
  573. <p>Create and open a new contiguous file of a specified size.</p>
  574. <dl class="params"><dt>Parameters</dt><dd>
  575. <table class="params">
  576. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory where the file will be created. </td></tr>
  577. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid file name. </td></tr>
  578. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>
  579. </table>
  580. </dd>
  581. </dl>
  582. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  583. </div>
  584. </div>
  585. <a id="a526f3dd56ce205690e45ffc86ef6f891"></a>
  586. <h2 class="memtitle"><span class="permalink"><a href="#a526f3dd56ce205690e45ffc86ef6f891">&#9670;&nbsp;</a></span>curCluster()</h2>
  587. <div class="memitem">
  588. <div class="memproto">
  589. <table class="mlabels">
  590. <tr>
  591. <td class="mlabels-left">
  592. <table class="memname">
  593. <tr>
  594. <td class="memname">uint32_t FatFile::curCluster </td>
  595. <td>(</td>
  596. <td class="paramname"></td><td>)</td>
  597. <td> const</td>
  598. </tr>
  599. </table>
  600. </td>
  601. <td class="mlabels-right">
  602. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  603. </tr>
  604. </table>
  605. </div><div class="memdoc">
  606. <dl class="section return"><dt>Returns</dt><dd>The current cluster number for a file or directory. </dd></dl>
  607. </div>
  608. </div>
  609. <a id="a97e0620949f97e9b9c91ed1094d728aa"></a>
  610. <h2 class="memtitle"><span class="permalink"><a href="#a97e0620949f97e9b9c91ed1094d728aa">&#9670;&nbsp;</a></span>curPosition()</h2>
  611. <div class="memitem">
  612. <div class="memproto">
  613. <table class="mlabels">
  614. <tr>
  615. <td class="mlabels-left">
  616. <table class="memname">
  617. <tr>
  618. <td class="memname">uint32_t FatFile::curPosition </td>
  619. <td>(</td>
  620. <td class="paramname"></td><td>)</td>
  621. <td> const</td>
  622. </tr>
  623. </table>
  624. </td>
  625. <td class="mlabels-right">
  626. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  627. </tr>
  628. </table>
  629. </div><div class="memdoc">
  630. <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>
  631. </div>
  632. </div>
  633. <a id="a2f4e9ab3056125b07f15d14ca26d5346"></a>
  634. <h2 class="memtitle"><span class="permalink"><a href="#a2f4e9ab3056125b07f15d14ca26d5346">&#9670;&nbsp;</a></span>dirEntry()</h2>
  635. <div class="memitem">
  636. <div class="memproto">
  637. <table class="memname">
  638. <tr>
  639. <td class="memname">bool FatFile::dirEntry </td>
  640. <td>(</td>
  641. <td class="paramtype">DirFat_t *&#160;</td>
  642. <td class="paramname"><em>dir</em></td><td>)</td>
  643. <td></td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. <p>Return a file's directory entry.</p>
  648. <dl class="params"><dt>Parameters</dt><dd>
  649. <table class="params">
  650. <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>Location for return of the file's directory entry.</td></tr>
  651. </table>
  652. </dd>
  653. </dl>
  654. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  655. </div>
  656. </div>
  657. <a id="ae5ec24d4a94d3780384d3f2b731c7eb9"></a>
  658. <h2 class="memtitle"><span class="permalink"><a href="#ae5ec24d4a94d3780384d3f2b731c7eb9">&#9670;&nbsp;</a></span>dirIndex()</h2>
  659. <div class="memitem">
  660. <div class="memproto">
  661. <table class="mlabels">
  662. <tr>
  663. <td class="mlabels-left">
  664. <table class="memname">
  665. <tr>
  666. <td class="memname">uint16_t FatFile::dirIndex </td>
  667. <td>(</td>
  668. <td class="paramname"></td><td>)</td>
  669. <td></td>
  670. </tr>
  671. </table>
  672. </td>
  673. <td class="mlabels-right">
  674. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  675. </tr>
  676. </table>
  677. </div><div class="memdoc">
  678. <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>
  679. </div>
  680. </div>
  681. <a id="ae2ed15f05c9ccbce355e7a8d3ce8382d"></a>
  682. <h2 class="memtitle"><span class="permalink"><a href="#ae2ed15f05c9ccbce355e7a8d3ce8382d">&#9670;&nbsp;</a></span>dirSize()</h2>
  683. <div class="memitem">
  684. <div class="memproto">
  685. <table class="memname">
  686. <tr>
  687. <td class="memname">uint32_t FatFile::dirSize </td>
  688. <td>(</td>
  689. <td class="paramname"></td><td>)</td>
  690. <td></td>
  691. </tr>
  692. </table>
  693. </div><div class="memdoc">
  694. <dl class="section return"><dt>Returns</dt><dd>The number of bytes allocated to a directory or zero if an error occurs. </dd></dl>
  695. </div>
  696. </div>
  697. <a id="a4f01d27954ae49aeb6888ac7302f55d9"></a>
  698. <h2 class="memtitle"><span class="permalink"><a href="#a4f01d27954ae49aeb6888ac7302f55d9">&#9670;&nbsp;</a></span>dmpFile()</h2>
  699. <div class="memitem">
  700. <div class="memproto">
  701. <table class="memname">
  702. <tr>
  703. <td class="memname">void FatFile::dmpFile </td>
  704. <td>(</td>
  705. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  706. <td class="paramname"><em>pr</em>, </td>
  707. </tr>
  708. <tr>
  709. <td class="paramkey"></td>
  710. <td></td>
  711. <td class="paramtype">uint32_t&#160;</td>
  712. <td class="paramname"><em>pos</em>, </td>
  713. </tr>
  714. <tr>
  715. <td class="paramkey"></td>
  716. <td></td>
  717. <td class="paramtype">size_t&#160;</td>
  718. <td class="paramname"><em>n</em>&#160;</td>
  719. </tr>
  720. <tr>
  721. <td></td>
  722. <td>)</td>
  723. <td></td><td></td>
  724. </tr>
  725. </table>
  726. </div><div class="memdoc">
  727. <p>Dump file in Hex </p><dl class="params"><dt>Parameters</dt><dd>
  728. <table class="params">
  729. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list. </td></tr>
  730. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>Start position in file. </td></tr>
  731. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number of locations to dump. </td></tr>
  732. </table>
  733. </dd>
  734. </dl>
  735. </div>
  736. </div>
  737. <a id="a50242f98dea0d4488ce4039a279f2a57"></a>
  738. <h2 class="memtitle"><span class="permalink"><a href="#a50242f98dea0d4488ce4039a279f2a57">&#9670;&nbsp;</a></span>exists()</h2>
  739. <div class="memitem">
  740. <div class="memproto">
  741. <table class="mlabels">
  742. <tr>
  743. <td class="mlabels-left">
  744. <table class="memname">
  745. <tr>
  746. <td class="memname">bool FatFile::exists </td>
  747. <td>(</td>
  748. <td class="paramtype">const char *&#160;</td>
  749. <td class="paramname"><em>path</em></td><td>)</td>
  750. <td></td>
  751. </tr>
  752. </table>
  753. </td>
  754. <td class="mlabels-right">
  755. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  756. </tr>
  757. </table>
  758. </div><div class="memdoc">
  759. <p>Test for the existence of a file in a directory</p>
  760. <dl class="params"><dt>Parameters</dt><dd>
  761. <table class="params">
  762. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  763. </table>
  764. </dd>
  765. </dl>
  766. <p>The calling instance must be an open directory file.</p>
  767. <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>
  768. <dl class="section return"><dt>Returns</dt><dd>True if the file exists. </dd></dl>
  769. </div>
  770. </div>
  771. <a id="a33e0b0a8a342047f29ab8e8aae9cae14"></a>
  772. <h2 class="memtitle"><span class="permalink"><a href="#a33e0b0a8a342047f29ab8e8aae9cae14">&#9670;&nbsp;</a></span>fgetpos()</h2>
  773. <div class="memitem">
  774. <div class="memproto">
  775. <table class="memname">
  776. <tr>
  777. <td class="memname">void FatFile::fgetpos </td>
  778. <td>(</td>
  779. <td class="paramtype">fspos_t *&#160;</td>
  780. <td class="paramname"><em>pos</em></td><td>)</td>
  781. <td></td>
  782. </tr>
  783. </table>
  784. </div><div class="memdoc">
  785. <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  786. <table class="params">
  787. <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>
  788. </table>
  789. </dd>
  790. </dl>
  791. </div>
  792. </div>
  793. <a id="a9e05a51767f7c8f70c6f337eecbdca03"></a>
  794. <h2 class="memtitle"><span class="permalink"><a href="#a9e05a51767f7c8f70c6f337eecbdca03">&#9670;&nbsp;</a></span>fgets()</h2>
  795. <div class="memitem">
  796. <div class="memproto">
  797. <table class="memname">
  798. <tr>
  799. <td class="memname">int FatFile::fgets </td>
  800. <td>(</td>
  801. <td class="paramtype">char *&#160;</td>
  802. <td class="paramname"><em>str</em>, </td>
  803. </tr>
  804. <tr>
  805. <td class="paramkey"></td>
  806. <td></td>
  807. <td class="paramtype">int&#160;</td>
  808. <td class="paramname"><em>num</em>, </td>
  809. </tr>
  810. <tr>
  811. <td class="paramkey"></td>
  812. <td></td>
  813. <td class="paramtype">char *&#160;</td>
  814. <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code>&#160;</td>
  815. </tr>
  816. <tr>
  817. <td></td>
  818. <td>)</td>
  819. <td></td><td></td>
  820. </tr>
  821. </table>
  822. </div><div class="memdoc">
  823. <p>Get a string from a file.</p>
  824. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">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>
  825. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">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>
  826. <dl class="params"><dt>Parameters</dt><dd>
  827. <table class="params">
  828. <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>
  829. <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>
  830. <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>
  831. </table>
  832. </dd>
  833. </dl>
  834. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> returns the length of the string in <em>str</em>. If no data is read, <a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>
  835. </div>
  836. </div>
  837. <a id="a874940574b9c99e763526465adf8dc28"></a>
  838. <h2 class="memtitle"><span class="permalink"><a href="#a874940574b9c99e763526465adf8dc28">&#9670;&nbsp;</a></span>fileSize()</h2>
  839. <div class="memitem">
  840. <div class="memproto">
  841. <table class="mlabels">
  842. <tr>
  843. <td class="mlabels-left">
  844. <table class="memname">
  845. <tr>
  846. <td class="memname">uint32_t FatFile::fileSize </td>
  847. <td>(</td>
  848. <td class="paramname"></td><td>)</td>
  849. <td> const</td>
  850. </tr>
  851. </table>
  852. </td>
  853. <td class="mlabels-right">
  854. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  855. </tr>
  856. </table>
  857. </div><div class="memdoc">
  858. <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>
  859. </div>
  860. </div>
  861. <a id="a5ac8a604863d18840f4a93c5c788b7c8"></a>
  862. <h2 class="memtitle"><span class="permalink"><a href="#a5ac8a604863d18840f4a93c5c788b7c8">&#9670;&nbsp;</a></span>firstBlock()</h2>
  863. <div class="memitem">
  864. <div class="memproto">
  865. <table class="mlabels">
  866. <tr>
  867. <td class="mlabels-left">
  868. <table class="memname">
  869. <tr>
  870. <td class="memname">uint32_t FatFile::firstBlock </td>
  871. <td>(</td>
  872. <td class="paramname"></td><td>)</td>
  873. <td> const</td>
  874. </tr>
  875. </table>
  876. </td>
  877. <td class="mlabels-right">
  878. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  879. </tr>
  880. </table>
  881. </div><div class="memdoc">
  882. <dl class="section return"><dt>Returns</dt><dd>first sector of file or zero for empty file. </dd></dl>
  883. </div>
  884. </div>
  885. <a id="af3108df387f30ca3d367dd390a04daaa"></a>
  886. <h2 class="memtitle"><span class="permalink"><a href="#af3108df387f30ca3d367dd390a04daaa">&#9670;&nbsp;</a></span>firstSector()</h2>
  887. <div class="memitem">
  888. <div class="memproto">
  889. <table class="memname">
  890. <tr>
  891. <td class="memname">uint32_t FatFile::firstSector </td>
  892. <td>(</td>
  893. <td class="paramname"></td><td>)</td>
  894. <td> const</td>
  895. </tr>
  896. </table>
  897. </div><div class="memdoc">
  898. <dl class="section return"><dt>Returns</dt><dd>Address of first sector or zero for empty file. </dd></dl>
  899. </div>
  900. </div>
  901. <a id="a166b5ff04754cc925f2aee71bf92f800"></a>
  902. <h2 class="memtitle"><span class="permalink"><a href="#a166b5ff04754cc925f2aee71bf92f800">&#9670;&nbsp;</a></span>flush()</h2>
  903. <div class="memitem">
  904. <div class="memproto">
  905. <table class="mlabels">
  906. <tr>
  907. <td class="mlabels-left">
  908. <table class="memname">
  909. <tr>
  910. <td class="memname">void FatFile::flush </td>
  911. <td>(</td>
  912. <td class="paramname"></td><td>)</td>
  913. <td></td>
  914. </tr>
  915. </table>
  916. </td>
  917. <td class="mlabels-right">
  918. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  919. </tr>
  920. </table>
  921. </div><div class="memdoc">
  922. <p>Arduino name for <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> </p>
  923. </div>
  924. </div>
  925. <a id="ac042c43d41ecfff4e101b88f3f82086e"></a>
  926. <h2 class="memtitle"><span class="permalink"><a href="#ac042c43d41ecfff4e101b88f3f82086e">&#9670;&nbsp;</a></span>fsetpos()</h2>
  927. <div class="memitem">
  928. <div class="memproto">
  929. <table class="memname">
  930. <tr>
  931. <td class="memname">void FatFile::fsetpos </td>
  932. <td>(</td>
  933. <td class="paramtype">const fspos_t *&#160;</td>
  934. <td class="paramname"><em>pos</em></td><td>)</td>
  935. <td></td>
  936. </tr>
  937. </table>
  938. </div><div class="memdoc">
  939. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  940. <table class="params">
  941. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>
  942. </table>
  943. </dd>
  944. </dl>
  945. </div>
  946. </div>
  947. <a id="a5d085c695e920b658a1505e480bc467f"></a>
  948. <h2 class="memtitle"><span class="permalink"><a href="#a5d085c695e920b658a1505e480bc467f">&#9670;&nbsp;</a></span>getAccessDate()</h2>
  949. <div class="memitem">
  950. <div class="memproto">
  951. <table class="memname">
  952. <tr>
  953. <td class="memname">bool FatFile::getAccessDate </td>
  954. <td>(</td>
  955. <td class="paramtype">uint16_t *&#160;</td>
  956. <td class="paramname"><em>pdate</em></td><td>)</td>
  957. <td></td>
  958. </tr>
  959. </table>
  960. </div><div class="memdoc">
  961. <p>Get a file's access date.</p>
  962. <dl class="params"><dt>Parameters</dt><dd>
  963. <table class="params">
  964. <tr><td class="paramdir">[out]</td><td class="paramname">pdate</td><td>Packed date for directory entry.</td></tr>
  965. </table>
  966. </dd>
  967. </dl>
  968. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  969. </div>
  970. </div>
  971. <a id="af70c42baeb45e0d7047ae63de568d0d2"></a>
  972. <h2 class="memtitle"><span class="permalink"><a href="#af70c42baeb45e0d7047ae63de568d0d2">&#9670;&nbsp;</a></span>getAccessDateTime()</h2>
  973. <div class="memitem">
  974. <div class="memproto">
  975. <table class="mlabels">
  976. <tr>
  977. <td class="mlabels-left">
  978. <table class="memname">
  979. <tr>
  980. <td class="memname">bool FatFile::getAccessDateTime </td>
  981. <td>(</td>
  982. <td class="paramtype">uint16_t *&#160;</td>
  983. <td class="paramname"><em>pdate</em>, </td>
  984. </tr>
  985. <tr>
  986. <td class="paramkey"></td>
  987. <td></td>
  988. <td class="paramtype">uint16_t *&#160;</td>
  989. <td class="paramname"><em>ptime</em>&#160;</td>
  990. </tr>
  991. <tr>
  992. <td></td>
  993. <td>)</td>
  994. <td></td><td></td>
  995. </tr>
  996. </table>
  997. </td>
  998. <td class="mlabels-right">
  999. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1000. </tr>
  1001. </table>
  1002. </div><div class="memdoc">
  1003. <p>Get a file's access date and time.</p>
  1004. <dl class="params"><dt>Parameters</dt><dd>
  1005. <table class="params">
  1006. <tr><td class="paramdir">[out]</td><td class="paramname">pdate</td><td>Packed date for directory entry. </td></tr>
  1007. <tr><td class="paramdir">[out]</td><td class="paramname">ptime</td><td>return zero since FAT has no time.</td></tr>
  1008. </table>
  1009. </dd>
  1010. </dl>
  1011. <p>This function is for comparability in <a class="el" href="class_fs_file.html" title="FsBaseFile file with Arduino Stream.">FsFile</a>.</p>
  1012. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1013. </div>
  1014. </div>
  1015. <a id="a94d484b5198032a9e00194e72182cc57"></a>
  1016. <h2 class="memtitle"><span class="permalink"><a href="#a94d484b5198032a9e00194e72182cc57">&#9670;&nbsp;</a></span>getCreateDateTime()</h2>
  1017. <div class="memitem">
  1018. <div class="memproto">
  1019. <table class="memname">
  1020. <tr>
  1021. <td class="memname">bool FatFile::getCreateDateTime </td>
  1022. <td>(</td>
  1023. <td class="paramtype">uint16_t *&#160;</td>
  1024. <td class="paramname"><em>pdate</em>, </td>
  1025. </tr>
  1026. <tr>
  1027. <td class="paramkey"></td>
  1028. <td></td>
  1029. <td class="paramtype">uint16_t *&#160;</td>
  1030. <td class="paramname"><em>ptime</em>&#160;</td>
  1031. </tr>
  1032. <tr>
  1033. <td></td>
  1034. <td>)</td>
  1035. <td></td><td></td>
  1036. </tr>
  1037. </table>
  1038. </div><div class="memdoc">
  1039. <p>Get a file's create date and time.</p>
  1040. <dl class="params"><dt>Parameters</dt><dd>
  1041. <table class="params">
  1042. <tr><td class="paramdir">[out]</td><td class="paramname">pdate</td><td>Packed date for directory entry. </td></tr>
  1043. <tr><td class="paramdir">[out]</td><td class="paramname">ptime</td><td>Packed time for directory entry.</td></tr>
  1044. </table>
  1045. </dd>
  1046. </dl>
  1047. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1048. </div>
  1049. </div>
  1050. <a id="ad0dbbd083180f44c7a3ce7124d4ce19c"></a>
  1051. <h2 class="memtitle"><span class="permalink"><a href="#ad0dbbd083180f44c7a3ce7124d4ce19c">&#9670;&nbsp;</a></span>getError()</h2>
  1052. <div class="memitem">
  1053. <div class="memproto">
  1054. <table class="mlabels">
  1055. <tr>
  1056. <td class="mlabels-left">
  1057. <table class="memname">
  1058. <tr>
  1059. <td class="memname">uint8_t FatFile::getError </td>
  1060. <td>(</td>
  1061. <td class="paramname"></td><td>)</td>
  1062. <td></td>
  1063. </tr>
  1064. </table>
  1065. </td>
  1066. <td class="mlabels-right">
  1067. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1068. </tr>
  1069. </table>
  1070. </div><div class="memdoc">
  1071. <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>
  1072. </div>
  1073. </div>
  1074. <a id="a28537b48ed2cb886c5f22984d07492b7"></a>
  1075. <h2 class="memtitle"><span class="permalink"><a href="#a28537b48ed2cb886c5f22984d07492b7">&#9670;&nbsp;</a></span>getModifyDateTime()</h2>
  1076. <div class="memitem">
  1077. <div class="memproto">
  1078. <table class="memname">
  1079. <tr>
  1080. <td class="memname">bool FatFile::getModifyDateTime </td>
  1081. <td>(</td>
  1082. <td class="paramtype">uint16_t *&#160;</td>
  1083. <td class="paramname"><em>pdate</em>, </td>
  1084. </tr>
  1085. <tr>
  1086. <td class="paramkey"></td>
  1087. <td></td>
  1088. <td class="paramtype">uint16_t *&#160;</td>
  1089. <td class="paramname"><em>ptime</em>&#160;</td>
  1090. </tr>
  1091. <tr>
  1092. <td></td>
  1093. <td>)</td>
  1094. <td></td><td></td>
  1095. </tr>
  1096. </table>
  1097. </div><div class="memdoc">
  1098. <p>Get a file's modify date and time.</p>
  1099. <dl class="params"><dt>Parameters</dt><dd>
  1100. <table class="params">
  1101. <tr><td class="paramdir">[out]</td><td class="paramname">pdate</td><td>Packed date for directory entry. </td></tr>
  1102. <tr><td class="paramdir">[out]</td><td class="paramname">ptime</td><td>Packed time for directory entry.</td></tr>
  1103. </table>
  1104. </dd>
  1105. </dl>
  1106. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1107. </div>
  1108. </div>
  1109. <a id="aafa565e286440aab612cdb430fc01da5"></a>
  1110. <h2 class="memtitle"><span class="permalink"><a href="#aafa565e286440aab612cdb430fc01da5">&#9670;&nbsp;</a></span>getName()</h2>
  1111. <div class="memitem">
  1112. <div class="memproto">
  1113. <table class="memname">
  1114. <tr>
  1115. <td class="memname">bool FatFile::getName </td>
  1116. <td>(</td>
  1117. <td class="paramtype">char *&#160;</td>
  1118. <td class="paramname"><em>name</em>, </td>
  1119. </tr>
  1120. <tr>
  1121. <td class="paramkey"></td>
  1122. <td></td>
  1123. <td class="paramtype">size_t&#160;</td>
  1124. <td class="paramname"><em>size</em>&#160;</td>
  1125. </tr>
  1126. <tr>
  1127. <td></td>
  1128. <td>)</td>
  1129. <td></td><td></td>
  1130. </tr>
  1131. </table>
  1132. </div><div class="memdoc">
  1133. <p>Get a file's name followed by a zero byte.</p>
  1134. <dl class="params"><dt>Parameters</dt><dd>
  1135. <table class="params">
  1136. <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>
  1137. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in bytes. The array must be at least 13 bytes long. The file's name will be truncated if the file's name is too long. </td></tr>
  1138. </table>
  1139. </dd>
  1140. </dl>
  1141. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1142. </div>
  1143. </div>
  1144. <a id="aba30e92a66f8e0d2f815c85662772a58"></a>
  1145. <h2 class="memtitle"><span class="permalink"><a href="#aba30e92a66f8e0d2f815c85662772a58">&#9670;&nbsp;</a></span>getSFN()</h2>
  1146. <div class="memitem">
  1147. <div class="memproto">
  1148. <table class="memname">
  1149. <tr>
  1150. <td class="memname">bool FatFile::getSFN </td>
  1151. <td>(</td>
  1152. <td class="paramtype">char *&#160;</td>
  1153. <td class="paramname"><em>name</em></td><td>)</td>
  1154. <td></td>
  1155. </tr>
  1156. </table>
  1157. </div><div class="memdoc">
  1158. <p>Get a file's Short File Name followed by a zero byte.</p>
  1159. <dl class="params"><dt>Parameters</dt><dd>
  1160. <table class="params">
  1161. <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. The array must be at least 13 bytes long. </td></tr>
  1162. </table>
  1163. </dd>
  1164. </dl>
  1165. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1166. </div>
  1167. </div>
  1168. <a id="a8062c0d3a118e8d77d0310418703d5f5"></a>
  1169. <h2 class="memtitle"><span class="permalink"><a href="#a8062c0d3a118e8d77d0310418703d5f5">&#9670;&nbsp;</a></span>getWriteError()</h2>
  1170. <div class="memitem">
  1171. <div class="memproto">
  1172. <table class="mlabels">
  1173. <tr>
  1174. <td class="mlabels-left">
  1175. <table class="memname">
  1176. <tr>
  1177. <td class="memname">bool FatFile::getWriteError </td>
  1178. <td>(</td>
  1179. <td class="paramname"></td><td>)</td>
  1180. <td></td>
  1181. </tr>
  1182. </table>
  1183. </td>
  1184. <td class="mlabels-right">
  1185. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1186. </tr>
  1187. </table>
  1188. </div><div class="memdoc">
  1189. <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>
  1190. </div>
  1191. </div>
  1192. <a id="a16478eafdb731e867fb627d19091c3ce"></a>
  1193. <h2 class="memtitle"><span class="permalink"><a href="#a16478eafdb731e867fb627d19091c3ce">&#9670;&nbsp;</a></span>isContiguous()</h2>
  1194. <div class="memitem">
  1195. <div class="memproto">
  1196. <table class="mlabels">
  1197. <tr>
  1198. <td class="mlabels-left">
  1199. <table class="memname">
  1200. <tr>
  1201. <td class="memname">bool FatFile::isContiguous </td>
  1202. <td>(</td>
  1203. <td class="paramname"></td><td>)</td>
  1204. <td> const</td>
  1205. </tr>
  1206. </table>
  1207. </td>
  1208. <td class="mlabels-right">
  1209. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1210. </tr>
  1211. </table>
  1212. </div><div class="memdoc">
  1213. <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>
  1214. </div>
  1215. </div>
  1216. <a id="a933360b20b496421b2bd9ee7a95563a6"></a>
  1217. <h2 class="memtitle"><span class="permalink"><a href="#a933360b20b496421b2bd9ee7a95563a6">&#9670;&nbsp;</a></span>isDir()</h2>
  1218. <div class="memitem">
  1219. <div class="memproto">
  1220. <table class="mlabels">
  1221. <tr>
  1222. <td class="mlabels-left">
  1223. <table class="memname">
  1224. <tr>
  1225. <td class="memname">bool FatFile::isDir </td>
  1226. <td>(</td>
  1227. <td class="paramname"></td><td>)</td>
  1228. <td> const</td>
  1229. </tr>
  1230. </table>
  1231. </td>
  1232. <td class="mlabels-right">
  1233. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1234. </tr>
  1235. </table>
  1236. </div><div class="memdoc">
  1237. <dl class="section return"><dt>Returns</dt><dd>True if this is a directory. </dd></dl>
  1238. </div>
  1239. </div>
  1240. <a id="acc5a87da1a5c8cb9758bfeaa7ae47b57"></a>
  1241. <h2 class="memtitle"><span class="permalink"><a href="#acc5a87da1a5c8cb9758bfeaa7ae47b57">&#9670;&nbsp;</a></span>isFile()</h2>
  1242. <div class="memitem">
  1243. <div class="memproto">
  1244. <table class="mlabels">
  1245. <tr>
  1246. <td class="mlabels-left">
  1247. <table class="memname">
  1248. <tr>
  1249. <td class="memname">bool FatFile::isFile </td>
  1250. <td>(</td>
  1251. <td class="paramname"></td><td>)</td>
  1252. <td> const</td>
  1253. </tr>
  1254. </table>
  1255. </td>
  1256. <td class="mlabels-right">
  1257. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1258. </tr>
  1259. </table>
  1260. </div><div class="memdoc">
  1261. <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file. </dd></dl>
  1262. </div>
  1263. </div>
  1264. <a id="ae216b4a2bc44a9cfb88478fa051a1fd8"></a>
  1265. <h2 class="memtitle"><span class="permalink"><a href="#ae216b4a2bc44a9cfb88478fa051a1fd8">&#9670;&nbsp;</a></span>isHidden()</h2>
  1266. <div class="memitem">
  1267. <div class="memproto">
  1268. <table class="mlabels">
  1269. <tr>
  1270. <td class="mlabels-left">
  1271. <table class="memname">
  1272. <tr>
  1273. <td class="memname">bool FatFile::isHidden </td>
  1274. <td>(</td>
  1275. <td class="paramname"></td><td>)</td>
  1276. <td> const</td>
  1277. </tr>
  1278. </table>
  1279. </td>
  1280. <td class="mlabels-right">
  1281. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1282. </tr>
  1283. </table>
  1284. </div><div class="memdoc">
  1285. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden file. </dd></dl>
  1286. </div>
  1287. </div>
  1288. <a id="af8f456ab790e818bfdd225cf6ffd40f3"></a>
  1289. <h2 class="memtitle"><span class="permalink"><a href="#af8f456ab790e818bfdd225cf6ffd40f3">&#9670;&nbsp;</a></span>isLFN()</h2>
  1290. <div class="memitem">
  1291. <div class="memproto">
  1292. <table class="mlabels">
  1293. <tr>
  1294. <td class="mlabels-left">
  1295. <table class="memname">
  1296. <tr>
  1297. <td class="memname">bool FatFile::isLFN </td>
  1298. <td>(</td>
  1299. <td class="paramname"></td><td>)</td>
  1300. <td> const</td>
  1301. </tr>
  1302. </table>
  1303. </td>
  1304. <td class="mlabels-right">
  1305. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1306. </tr>
  1307. </table>
  1308. </div><div class="memdoc">
  1309. <dl class="section return"><dt>Returns</dt><dd>true if this file has a Long File Name. </dd></dl>
  1310. </div>
  1311. </div>
  1312. <a id="a8b8a2850c086d3ce79bee64a23fbf7a6"></a>
  1313. <h2 class="memtitle"><span class="permalink"><a href="#a8b8a2850c086d3ce79bee64a23fbf7a6">&#9670;&nbsp;</a></span>isOpen()</h2>
  1314. <div class="memitem">
  1315. <div class="memproto">
  1316. <table class="mlabels">
  1317. <tr>
  1318. <td class="mlabels-left">
  1319. <table class="memname">
  1320. <tr>
  1321. <td class="memname">bool FatFile::isOpen </td>
  1322. <td>(</td>
  1323. <td class="paramname"></td><td>)</td>
  1324. <td> const</td>
  1325. </tr>
  1326. </table>
  1327. </td>
  1328. <td class="mlabels-right">
  1329. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1330. </tr>
  1331. </table>
  1332. </div><div class="memdoc">
  1333. <dl class="section return"><dt>Returns</dt><dd>True if this is an open file/directory. </dd></dl>
  1334. </div>
  1335. </div>
  1336. <a id="ae60b4cedb69c88ac641813d5edfa6b4a"></a>
  1337. <h2 class="memtitle"><span class="permalink"><a href="#ae60b4cedb69c88ac641813d5edfa6b4a">&#9670;&nbsp;</a></span>isReadable()</h2>
  1338. <div class="memitem">
  1339. <div class="memproto">
  1340. <table class="mlabels">
  1341. <tr>
  1342. <td class="mlabels-left">
  1343. <table class="memname">
  1344. <tr>
  1345. <td class="memname">bool FatFile::isReadable </td>
  1346. <td>(</td>
  1347. <td class="paramname"></td><td>)</td>
  1348. <td> const</td>
  1349. </tr>
  1350. </table>
  1351. </td>
  1352. <td class="mlabels-right">
  1353. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1354. </tr>
  1355. </table>
  1356. </div><div class="memdoc">
  1357. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  1358. </div>
  1359. </div>
  1360. <a id="abaf639ec8f86f34aeb7e6b3615526f0b"></a>
  1361. <h2 class="memtitle"><span class="permalink"><a href="#abaf639ec8f86f34aeb7e6b3615526f0b">&#9670;&nbsp;</a></span>isReadOnly()</h2>
  1362. <div class="memitem">
  1363. <div class="memproto">
  1364. <table class="mlabels">
  1365. <tr>
  1366. <td class="mlabels-left">
  1367. <table class="memname">
  1368. <tr>
  1369. <td class="memname">bool FatFile::isReadOnly </td>
  1370. <td>(</td>
  1371. <td class="paramname"></td><td>)</td>
  1372. <td> const</td>
  1373. </tr>
  1374. </table>
  1375. </td>
  1376. <td class="mlabels-right">
  1377. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1378. </tr>
  1379. </table>
  1380. </div><div class="memdoc">
  1381. <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>
  1382. </div>
  1383. </div>
  1384. <a id="a03421a0c28649332f55e6ca06d3aeedb"></a>
  1385. <h2 class="memtitle"><span class="permalink"><a href="#a03421a0c28649332f55e6ca06d3aeedb">&#9670;&nbsp;</a></span>isRoot()</h2>
  1386. <div class="memitem">
  1387. <div class="memproto">
  1388. <table class="mlabels">
  1389. <tr>
  1390. <td class="mlabels-left">
  1391. <table class="memname">
  1392. <tr>
  1393. <td class="memname">bool FatFile::isRoot </td>
  1394. <td>(</td>
  1395. <td class="paramname"></td><td>)</td>
  1396. <td> const</td>
  1397. </tr>
  1398. </table>
  1399. </td>
  1400. <td class="mlabels-right">
  1401. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1402. </tr>
  1403. </table>
  1404. </div><div class="memdoc">
  1405. <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>
  1406. </div>
  1407. </div>
  1408. <a id="a8fda8004720ec4cc55710869dbb52e35"></a>
  1409. <h2 class="memtitle"><span class="permalink"><a href="#a8fda8004720ec4cc55710869dbb52e35">&#9670;&nbsp;</a></span>isRoot32()</h2>
  1410. <div class="memitem">
  1411. <div class="memproto">
  1412. <table class="mlabels">
  1413. <tr>
  1414. <td class="mlabels-left">
  1415. <table class="memname">
  1416. <tr>
  1417. <td class="memname">bool FatFile::isRoot32 </td>
  1418. <td>(</td>
  1419. <td class="paramname"></td><td>)</td>
  1420. <td> const</td>
  1421. </tr>
  1422. </table>
  1423. </td>
  1424. <td class="mlabels-right">
  1425. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1426. </tr>
  1427. </table>
  1428. </div><div class="memdoc">
  1429. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT32 root directory. </dd></dl>
  1430. </div>
  1431. </div>
  1432. <a id="a0cc65089f7ce6c1ff92edbf0bff59dee"></a>
  1433. <h2 class="memtitle"><span class="permalink"><a href="#a0cc65089f7ce6c1ff92edbf0bff59dee">&#9670;&nbsp;</a></span>isRootFixed()</h2>
  1434. <div class="memitem">
  1435. <div class="memproto">
  1436. <table class="mlabels">
  1437. <tr>
  1438. <td class="mlabels-left">
  1439. <table class="memname">
  1440. <tr>
  1441. <td class="memname">bool FatFile::isRootFixed </td>
  1442. <td>(</td>
  1443. <td class="paramname"></td><td>)</td>
  1444. <td> const</td>
  1445. </tr>
  1446. </table>
  1447. </td>
  1448. <td class="mlabels-right">
  1449. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1450. </tr>
  1451. </table>
  1452. </div><div class="memdoc">
  1453. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT12 of FAT16 root directory. </dd></dl>
  1454. </div>
  1455. </div>
  1456. <a id="abfd02c5d26f7d4f8739a8610116a6660"></a>
  1457. <h2 class="memtitle"><span class="permalink"><a href="#abfd02c5d26f7d4f8739a8610116a6660">&#9670;&nbsp;</a></span>isSubDir()</h2>
  1458. <div class="memitem">
  1459. <div class="memproto">
  1460. <table class="mlabels">
  1461. <tr>
  1462. <td class="mlabels-left">
  1463. <table class="memname">
  1464. <tr>
  1465. <td class="memname">bool FatFile::isSubDir </td>
  1466. <td>(</td>
  1467. <td class="paramname"></td><td>)</td>
  1468. <td> const</td>
  1469. </tr>
  1470. </table>
  1471. </td>
  1472. <td class="mlabels-right">
  1473. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1474. </tr>
  1475. </table>
  1476. </div><div class="memdoc">
  1477. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory. </dd></dl>
  1478. </div>
  1479. </div>
  1480. <a id="a48087bdeb6b94fc27e0f74c3d90af5a9"></a>
  1481. <h2 class="memtitle"><span class="permalink"><a href="#a48087bdeb6b94fc27e0f74c3d90af5a9">&#9670;&nbsp;</a></span>isSystem()</h2>
  1482. <div class="memitem">
  1483. <div class="memproto">
  1484. <table class="mlabels">
  1485. <tr>
  1486. <td class="mlabels-left">
  1487. <table class="memname">
  1488. <tr>
  1489. <td class="memname">bool FatFile::isSystem </td>
  1490. <td>(</td>
  1491. <td class="paramname"></td><td>)</td>
  1492. <td> const</td>
  1493. </tr>
  1494. </table>
  1495. </td>
  1496. <td class="mlabels-right">
  1497. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1498. </tr>
  1499. </table>
  1500. </div><div class="memdoc">
  1501. <dl class="section return"><dt>Returns</dt><dd>True if this is a system file. </dd></dl>
  1502. </div>
  1503. </div>
  1504. <a id="aa484d5b2b147c5f3fe0e26b6eaf11ffc"></a>
  1505. <h2 class="memtitle"><span class="permalink"><a href="#aa484d5b2b147c5f3fe0e26b6eaf11ffc">&#9670;&nbsp;</a></span>isWritable()</h2>
  1506. <div class="memitem">
  1507. <div class="memproto">
  1508. <table class="mlabels">
  1509. <tr>
  1510. <td class="mlabels-left">
  1511. <table class="memname">
  1512. <tr>
  1513. <td class="memname">bool FatFile::isWritable </td>
  1514. <td>(</td>
  1515. <td class="paramname"></td><td>)</td>
  1516. <td> const</td>
  1517. </tr>
  1518. </table>
  1519. </td>
  1520. <td class="mlabels-right">
  1521. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1522. </tr>
  1523. </table>
  1524. </div><div class="memdoc">
  1525. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  1526. </div>
  1527. </div>
  1528. <a id="a94df8090f16e9666cdc53ca20f6aff90"></a>
  1529. <h2 class="memtitle"><span class="permalink"><a href="#a94df8090f16e9666cdc53ca20f6aff90">&#9670;&nbsp;</a></span>legal83Char()</h2>
  1530. <div class="memitem">
  1531. <div class="memproto">
  1532. <table class="mlabels">
  1533. <tr>
  1534. <td class="mlabels-left">
  1535. <table class="memname">
  1536. <tr>
  1537. <td class="memname">static bool FatFile::legal83Char </td>
  1538. <td>(</td>
  1539. <td class="paramtype">uint8_t&#160;</td>
  1540. <td class="paramname"><em>c</em></td><td>)</td>
  1541. <td></td>
  1542. </tr>
  1543. </table>
  1544. </td>
  1545. <td class="mlabels-right">
  1546. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  1547. </tr>
  1548. </table>
  1549. </div><div class="memdoc">
  1550. <p>Check for a legal 8.3 character. </p><dl class="params"><dt>Parameters</dt><dd>
  1551. <table class="params">
  1552. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Character to be checked. </td></tr>
  1553. </table>
  1554. </dd>
  1555. </dl>
  1556. <dl class="section return"><dt>Returns</dt><dd>true for a legal 8.3 character. </dd></dl>
  1557. </div>
  1558. </div>
  1559. <a id="a60ab9d16bcc778150a364c26de467de1"></a>
  1560. <h2 class="memtitle"><span class="permalink"><a href="#a60ab9d16bcc778150a364c26de467de1">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>
  1561. <div class="memitem">
  1562. <div class="memproto">
  1563. <table class="memname">
  1564. <tr>
  1565. <td class="memname">bool FatFile::ls </td>
  1566. <td>(</td>
  1567. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1568. <td class="paramname"><em>pr</em>, </td>
  1569. </tr>
  1570. <tr>
  1571. <td class="paramkey"></td>
  1572. <td></td>
  1573. <td class="paramtype">uint8_t&#160;</td>
  1574. <td class="paramname"><em>flags</em> = <code>0</code>, </td>
  1575. </tr>
  1576. <tr>
  1577. <td class="paramkey"></td>
  1578. <td></td>
  1579. <td class="paramtype">uint8_t&#160;</td>
  1580. <td class="paramname"><em>indent</em> = <code>0</code>&#160;</td>
  1581. </tr>
  1582. <tr>
  1583. <td></td>
  1584. <td>)</td>
  1585. <td></td><td></td>
  1586. </tr>
  1587. </table>
  1588. </div><div class="memdoc">
  1589. <p>List directory contents.</p>
  1590. <dl class="params"><dt>Parameters</dt><dd>
  1591. <table class="params">
  1592. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1593. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1594. </table>
  1595. </dd>
  1596. </dl>
  1597. <p>LS_DATE - Print file modification date</p>
  1598. <p>LS_SIZE - Print file size.</p>
  1599. <p>LS_R - Recursive list of subdirectories.</p>
  1600. <dl class="params"><dt>Parameters</dt><dd>
  1601. <table class="params">
  1602. <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>
  1603. </table>
  1604. </dd>
  1605. </dl>
  1606. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1607. </div>
  1608. </div>
  1609. <a id="a6a11f3307da6232b5f2d11812832d93a"></a>
  1610. <h2 class="memtitle"><span class="permalink"><a href="#a6a11f3307da6232b5f2d11812832d93a">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>
  1611. <div class="memitem">
  1612. <div class="memproto">
  1613. <table class="mlabels">
  1614. <tr>
  1615. <td class="mlabels-left">
  1616. <table class="memname">
  1617. <tr>
  1618. <td class="memname">bool FatFile::ls </td>
  1619. <td>(</td>
  1620. <td class="paramtype">uint8_t&#160;</td>
  1621. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1622. <td></td>
  1623. </tr>
  1624. </table>
  1625. </td>
  1626. <td class="mlabels-right">
  1627. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1628. </tr>
  1629. </table>
  1630. </div><div class="memdoc">
  1631. <p>List directory contents.</p>
  1632. <dl class="params"><dt>Parameters</dt><dd>
  1633. <table class="params">
  1634. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1635. </table>
  1636. </dd>
  1637. </dl>
  1638. <p>LS_DATE - Print file modification date</p>
  1639. <p>LS_SIZE - Print file size.</p>
  1640. <p>LS_R - Recursive list of subdirectories.</p>
  1641. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1642. </div>
  1643. </div>
  1644. <a id="abab5b9f72cc796388dd4eed01d13d90d"></a>
  1645. <h2 class="memtitle"><span class="permalink"><a href="#abab5b9f72cc796388dd4eed01d13d90d">&#9670;&nbsp;</a></span>mkdir()</h2>
  1646. <div class="memitem">
  1647. <div class="memproto">
  1648. <table class="memname">
  1649. <tr>
  1650. <td class="memname">bool FatFile::mkdir </td>
  1651. <td>(</td>
  1652. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1653. <td class="paramname"><em>dir</em>, </td>
  1654. </tr>
  1655. <tr>
  1656. <td class="paramkey"></td>
  1657. <td></td>
  1658. <td class="paramtype">const char *&#160;</td>
  1659. <td class="paramname"><em>path</em>, </td>
  1660. </tr>
  1661. <tr>
  1662. <td class="paramkey"></td>
  1663. <td></td>
  1664. <td class="paramtype">bool&#160;</td>
  1665. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1666. </tr>
  1667. <tr>
  1668. <td></td>
  1669. <td>)</td>
  1670. <td></td><td></td>
  1671. </tr>
  1672. </table>
  1673. </div><div class="memdoc">
  1674. <p>Make a new directory.</p>
  1675. <dl class="params"><dt>Parameters</dt><dd>
  1676. <table class="params">
  1677. <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> instance for the directory that will contain the new directory.</td></tr>
  1678. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the new directory.</td></tr>
  1679. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1680. </table>
  1681. </dd>
  1682. </dl>
  1683. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1684. </div>
  1685. </div>
  1686. <a id="afd3e4d5a76b6751ca796fc57f4dd2be4"></a>
  1687. <h2 class="memtitle"><span class="permalink"><a href="#afd3e4d5a76b6751ca796fc57f4dd2be4">&#9670;&nbsp;</a></span>open() <span class="overload">[1/4]</span></h2>
  1688. <div class="memitem">
  1689. <div class="memproto">
  1690. <table class="memname">
  1691. <tr>
  1692. <td class="memname">bool FatFile::open </td>
  1693. <td>(</td>
  1694. <td class="paramtype">const char *&#160;</td>
  1695. <td class="paramname"><em>path</em>, </td>
  1696. </tr>
  1697. <tr>
  1698. <td class="paramkey"></td>
  1699. <td></td>
  1700. <td class="paramtype">oflag_t&#160;</td>
  1701. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1702. </tr>
  1703. <tr>
  1704. <td></td>
  1705. <td>)</td>
  1706. <td></td><td></td>
  1707. </tr>
  1708. </table>
  1709. </div><div class="memdoc">
  1710. <p>Open a file in the current working volume.</p>
  1711. <dl class="params"><dt>Parameters</dt><dd>
  1712. <table class="params">
  1713. <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>
  1714. <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_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>
  1715. </table>
  1716. </dd>
  1717. </dl>
  1718. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1719. </div>
  1720. </div>
  1721. <a id="a58d6ea245f1bc3ae7a6df311cd25052f"></a>
  1722. <h2 class="memtitle"><span class="permalink"><a href="#a58d6ea245f1bc3ae7a6df311cd25052f">&#9670;&nbsp;</a></span>open() <span class="overload">[2/4]</span></h2>
  1723. <div class="memitem">
  1724. <div class="memproto">
  1725. <table class="memname">
  1726. <tr>
  1727. <td class="memname">bool FatFile::open </td>
  1728. <td>(</td>
  1729. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1730. <td class="paramname"><em>dirFile</em>, </td>
  1731. </tr>
  1732. <tr>
  1733. <td class="paramkey"></td>
  1734. <td></td>
  1735. <td class="paramtype">const char *&#160;</td>
  1736. <td class="paramname"><em>path</em>, </td>
  1737. </tr>
  1738. <tr>
  1739. <td class="paramkey"></td>
  1740. <td></td>
  1741. <td class="paramtype">oflag_t&#160;</td>
  1742. <td class="paramname"><em>oflag</em>&#160;</td>
  1743. </tr>
  1744. <tr>
  1745. <td></td>
  1746. <td>)</td>
  1747. <td></td><td></td>
  1748. </tr>
  1749. </table>
  1750. </div><div class="memdoc">
  1751. <p>Open a file or directory by name.</p>
  1752. <dl class="params"><dt>Parameters</dt><dd>
  1753. <table class="params">
  1754. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> instance for the directory containing the file to be opened.</td></tr>
  1755. <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>
  1756. <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>
  1757. </table>
  1758. </dd>
  1759. </dl>
  1760. <p>O_RDONLY - Open for reading.</p>
  1761. <p>O_READ - Same as O_RDONLY.</p>
  1762. <p>O_WRONLY - Open for writing.</p>
  1763. <p>O_WRITE - Same as O_WRONLY.</p>
  1764. <p>O_RDWR - Open for reading and writing.</p>
  1765. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>
  1766. <p>O_AT_END - Set the initial position at the end of the file.</p>
  1767. <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>
  1768. <p>O_EXCL - If O_CREAT and O_EXCL are set, <a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open()</a> shall fail if the file exists.</p>
  1769. <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>
  1770. <p>WARNING: A given file must not be opened by more than one <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> object or file corruption may occur.</p>
  1771. <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>
  1772. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1773. </div>
  1774. </div>
  1775. <a id="ab44920bb9cd5414b8e69c9dc4343394a"></a>
  1776. <h2 class="memtitle"><span class="permalink"><a href="#ab44920bb9cd5414b8e69c9dc4343394a">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>
  1777. <div class="memitem">
  1778. <div class="memproto">
  1779. <table class="memname">
  1780. <tr>
  1781. <td class="memname">bool FatFile::open </td>
  1782. <td>(</td>
  1783. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1784. <td class="paramname"><em>dirFile</em>, </td>
  1785. </tr>
  1786. <tr>
  1787. <td class="paramkey"></td>
  1788. <td></td>
  1789. <td class="paramtype">uint16_t&#160;</td>
  1790. <td class="paramname"><em>index</em>, </td>
  1791. </tr>
  1792. <tr>
  1793. <td class="paramkey"></td>
  1794. <td></td>
  1795. <td class="paramtype">oflag_t&#160;</td>
  1796. <td class="paramname"><em>oflag</em>&#160;</td>
  1797. </tr>
  1798. <tr>
  1799. <td></td>
  1800. <td>)</td>
  1801. <td></td><td></td>
  1802. </tr>
  1803. </table>
  1804. </div><div class="memdoc">
  1805. <p>Open a file by index.</p>
  1806. <dl class="params"><dt>Parameters</dt><dd>
  1807. <table class="params">
  1808. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> instance for the directory.</td></tr>
  1809. <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>
  1810. <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_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>
  1811. </table>
  1812. </dd>
  1813. </dl>
  1814. <p>See <a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">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>
  1815. </div>
  1816. </div>
  1817. <a id="af49a42dc64cd954debb271eae5639059"></a>
  1818. <h2 class="memtitle"><span class="permalink"><a href="#af49a42dc64cd954debb271eae5639059">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>
  1819. <div class="memitem">
  1820. <div class="memproto">
  1821. <table class="memname">
  1822. <tr>
  1823. <td class="memname">bool FatFile::open </td>
  1824. <td>(</td>
  1825. <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>
  1826. <td class="paramname"><em>vol</em>, </td>
  1827. </tr>
  1828. <tr>
  1829. <td class="paramkey"></td>
  1830. <td></td>
  1831. <td class="paramtype">const char *&#160;</td>
  1832. <td class="paramname"><em>path</em>, </td>
  1833. </tr>
  1834. <tr>
  1835. <td class="paramkey"></td>
  1836. <td></td>
  1837. <td class="paramtype">oflag_t&#160;</td>
  1838. <td class="paramname"><em>oflag</em>&#160;</td>
  1839. </tr>
  1840. <tr>
  1841. <td></td>
  1842. <td>)</td>
  1843. <td></td><td></td>
  1844. </tr>
  1845. </table>
  1846. </div><div class="memdoc">
  1847. <p>Open a file in the volume root directory.</p>
  1848. <dl class="params"><dt>Parameters</dt><dd>
  1849. <table class="params">
  1850. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>
  1851. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>
  1852. <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_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>
  1853. </table>
  1854. </dd>
  1855. </dl>
  1856. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1857. </div>
  1858. </div>
  1859. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>
  1860. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>
  1861. <div class="memitem">
  1862. <div class="memproto">
  1863. <table class="memname">
  1864. <tr>
  1865. <td class="memname">bool FatFile::openNext </td>
  1866. <td>(</td>
  1867. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1868. <td class="paramname"><em>dirFile</em>, </td>
  1869. </tr>
  1870. <tr>
  1871. <td class="paramkey"></td>
  1872. <td></td>
  1873. <td class="paramtype">oflag_t&#160;</td>
  1874. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1875. </tr>
  1876. <tr>
  1877. <td></td>
  1878. <td>)</td>
  1879. <td></td><td></td>
  1880. </tr>
  1881. </table>
  1882. </div><div class="memdoc">
  1883. <p>Open the next file or subdirectory in a directory.</p>
  1884. <dl class="params"><dt>Parameters</dt><dd>
  1885. <table class="params">
  1886. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> instance for the directory containing the file to be opened.</td></tr>
  1887. <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_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>
  1888. </table>
  1889. </dd>
  1890. </dl>
  1891. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1892. </div>
  1893. </div>
  1894. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>
  1895. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>
  1896. <div class="memitem">
  1897. <div class="memproto">
  1898. <table class="memname">
  1899. <tr>
  1900. <td class="memname">bool FatFile::openRoot </td>
  1901. <td>(</td>
  1902. <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>
  1903. <td class="paramname"><em>vol</em></td><td>)</td>
  1904. <td></td>
  1905. </tr>
  1906. </table>
  1907. </div><div class="memdoc">
  1908. <p>Open a volume's root directory.</p>
  1909. <dl class="params"><dt>Parameters</dt><dd>
  1910. <table class="params">
  1911. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>
  1912. </table>
  1913. </dd>
  1914. </dl>
  1915. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1916. </div>
  1917. </div>
  1918. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>
  1919. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>
  1920. <div class="memitem">
  1921. <div class="memproto">
  1922. <table class="mlabels">
  1923. <tr>
  1924. <td class="mlabels-left">
  1925. <table class="memname">
  1926. <tr>
  1927. <td class="memname">FatFile::operator bool </td>
  1928. <td>(</td>
  1929. <td class="paramname"></td><td>)</td>
  1930. <td></td>
  1931. </tr>
  1932. </table>
  1933. </td>
  1934. <td class="mlabels-right">
  1935. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1936. </tr>
  1937. </table>
  1938. </div><div class="memdoc">
  1939. <p>The parenthesis operator.</p>
  1940. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>
  1941. </div>
  1942. </div>
  1943. <a id="ac05b7136b887539426856c623869aa3a"></a>
  1944. <h2 class="memtitle"><span class="permalink"><a href="#ac05b7136b887539426856c623869aa3a">&#9670;&nbsp;</a></span>peek()</h2>
  1945. <div class="memitem">
  1946. <div class="memproto">
  1947. <table class="memname">
  1948. <tr>
  1949. <td class="memname">int FatFile::peek </td>
  1950. <td>(</td>
  1951. <td class="paramname"></td><td>)</td>
  1952. <td></td>
  1953. </tr>
  1954. </table>
  1955. </div><div class="memdoc">
  1956. <p>Return the next available byte without consuming it.</p>
  1957. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>
  1958. </div>
  1959. </div>
  1960. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>
  1961. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>
  1962. <div class="memitem">
  1963. <div class="memproto">
  1964. <table class="memname">
  1965. <tr>
  1966. <td class="memname">bool FatFile::preAllocate </td>
  1967. <td>(</td>
  1968. <td class="paramtype">uint32_t&#160;</td>
  1969. <td class="paramname"><em>length</em></td><td>)</td>
  1970. <td></td>
  1971. </tr>
  1972. </table>
  1973. </div><div class="memdoc">
  1974. <p>Allocate contiguous clusters to an empty file.</p>
  1975. <p>The file must be empty with no clusters allocated.</p>
  1976. <p>The file will contain uninitialized data.</p>
  1977. <dl class="params"><dt>Parameters</dt><dd>
  1978. <table class="params">
  1979. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>
  1980. </table>
  1981. </dd>
  1982. </dl>
  1983. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1984. </div>
  1985. </div>
  1986. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>
  1987. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>
  1988. <div class="memitem">
  1989. <div class="memproto">
  1990. <table class="memname">
  1991. <tr>
  1992. <td class="memname">size_t FatFile::printAccessDate </td>
  1993. <td>(</td>
  1994. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1995. <td class="paramname"><em>pr</em></td><td>)</td>
  1996. <td></td>
  1997. </tr>
  1998. </table>
  1999. </div><div class="memdoc">
  2000. <p>Print a file's access date</p>
  2001. <dl class="params"><dt>Parameters</dt><dd>
  2002. <table class="params">
  2003. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2004. </table>
  2005. </dd>
  2006. </dl>
  2007. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2008. </div>
  2009. </div>
  2010. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>
  2011. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>
  2012. <div class="memitem">
  2013. <div class="memproto">
  2014. <table class="mlabels">
  2015. <tr>
  2016. <td class="mlabels-left">
  2017. <table class="memname">
  2018. <tr>
  2019. <td class="memname">size_t FatFile::printAccessDateTime </td>
  2020. <td>(</td>
  2021. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2022. <td class="paramname"><em>pr</em></td><td>)</td>
  2023. <td></td>
  2024. </tr>
  2025. </table>
  2026. </td>
  2027. <td class="mlabels-right">
  2028. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2029. </tr>
  2030. </table>
  2031. </div><div class="memdoc">
  2032. <p>Print a file's access date</p>
  2033. <dl class="params"><dt>Parameters</dt><dd>
  2034. <table class="params">
  2035. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2036. </table>
  2037. </dd>
  2038. </dl>
  2039. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2040. </div>
  2041. </div>
  2042. <a id="ab22396a285e27b53501a0047ddd97f59"></a>
  2043. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>
  2044. <div class="memitem">
  2045. <div class="memproto">
  2046. <table class="memname">
  2047. <tr>
  2048. <td class="memname">size_t FatFile::printCreateDateTime </td>
  2049. <td>(</td>
  2050. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2051. <td class="paramname"><em>pr</em></td><td>)</td>
  2052. <td></td>
  2053. </tr>
  2054. </table>
  2055. </div><div class="memdoc">
  2056. <p>Print a file's creation date and time</p>
  2057. <dl class="params"><dt>Parameters</dt><dd>
  2058. <table class="params">
  2059. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2060. </table>
  2061. </dd>
  2062. </dl>
  2063. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>
  2064. </div>
  2065. </div>
  2066. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>
  2067. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>
  2068. <div class="memitem">
  2069. <div class="memproto">
  2070. <table class="mlabels">
  2071. <tr>
  2072. <td class="mlabels-left">
  2073. <table class="memname">
  2074. <tr>
  2075. <td class="memname">static void FatFile::printFatDate </td>
  2076. <td>(</td>
  2077. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2078. <td class="paramname"><em>pr</em>, </td>
  2079. </tr>
  2080. <tr>
  2081. <td class="paramkey"></td>
  2082. <td></td>
  2083. <td class="paramtype">uint16_t&#160;</td>
  2084. <td class="paramname"><em>fatDate</em>&#160;</td>
  2085. </tr>
  2086. <tr>
  2087. <td></td>
  2088. <td>)</td>
  2089. <td></td><td></td>
  2090. </tr>
  2091. </table>
  2092. </td>
  2093. <td class="mlabels-right">
  2094. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  2095. </tr>
  2096. </table>
  2097. </div><div class="memdoc">
  2098. <p>Print a directory date field.</p>
  2099. <p>Format is yyyy-mm-dd.</p>
  2100. <dl class="params"><dt>Parameters</dt><dd>
  2101. <table class="params">
  2102. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>
  2103. <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>
  2104. </table>
  2105. </dd>
  2106. </dl>
  2107. </div>
  2108. </div>
  2109. <a id="a7f84d953190ea94710dad9ebb897b957"></a>
  2110. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>
  2111. <div class="memitem">
  2112. <div class="memproto">
  2113. <table class="mlabels">
  2114. <tr>
  2115. <td class="mlabels-left">
  2116. <table class="memname">
  2117. <tr>
  2118. <td class="memname">static void FatFile::printFatTime </td>
  2119. <td>(</td>
  2120. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2121. <td class="paramname"><em>pr</em>, </td>
  2122. </tr>
  2123. <tr>
  2124. <td class="paramkey"></td>
  2125. <td></td>
  2126. <td class="paramtype">uint16_t&#160;</td>
  2127. <td class="paramname"><em>fatTime</em>&#160;</td>
  2128. </tr>
  2129. <tr>
  2130. <td></td>
  2131. <td>)</td>
  2132. <td></td><td></td>
  2133. </tr>
  2134. </table>
  2135. </td>
  2136. <td class="mlabels-right">
  2137. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  2138. </tr>
  2139. </table>
  2140. </div><div class="memdoc">
  2141. <p>Print a directory time field.</p>
  2142. <p>Format is hh:mm:ss.</p>
  2143. <dl class="params"><dt>Parameters</dt><dd>
  2144. <table class="params">
  2145. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>
  2146. <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>
  2147. </table>
  2148. </dd>
  2149. </dl>
  2150. </div>
  2151. </div>
  2152. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>
  2153. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>
  2154. <div class="memitem">
  2155. <div class="memproto">
  2156. <table class="mlabels">
  2157. <tr>
  2158. <td class="mlabels-left">
  2159. <table class="memname">
  2160. <tr>
  2161. <td class="memname">size_t FatFile::printField </td>
  2162. <td>(</td>
  2163. <td class="paramtype">double&#160;</td>
  2164. <td class="paramname"><em>value</em>, </td>
  2165. </tr>
  2166. <tr>
  2167. <td class="paramkey"></td>
  2168. <td></td>
  2169. <td class="paramtype">char&#160;</td>
  2170. <td class="paramname"><em>term</em>, </td>
  2171. </tr>
  2172. <tr>
  2173. <td class="paramkey"></td>
  2174. <td></td>
  2175. <td class="paramtype">uint8_t&#160;</td>
  2176. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  2177. </tr>
  2178. <tr>
  2179. <td></td>
  2180. <td>)</td>
  2181. <td></td><td></td>
  2182. </tr>
  2183. </table>
  2184. </td>
  2185. <td class="mlabels-right">
  2186. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2187. </tr>
  2188. </table>
  2189. </div><div class="memdoc">
  2190. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2191. <table class="params">
  2192. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2193. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2194. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  2195. </table>
  2196. </dd>
  2197. </dl>
  2198. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2199. </div>
  2200. </div>
  2201. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>
  2202. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>
  2203. <div class="memitem">
  2204. <div class="memproto">
  2205. <table class="mlabels">
  2206. <tr>
  2207. <td class="mlabels-left">
  2208. <table class="memname">
  2209. <tr>
  2210. <td class="memname">size_t FatFile::printField </td>
  2211. <td>(</td>
  2212. <td class="paramtype">float&#160;</td>
  2213. <td class="paramname"><em>value</em>, </td>
  2214. </tr>
  2215. <tr>
  2216. <td class="paramkey"></td>
  2217. <td></td>
  2218. <td class="paramtype">char&#160;</td>
  2219. <td class="paramname"><em>term</em>, </td>
  2220. </tr>
  2221. <tr>
  2222. <td class="paramkey"></td>
  2223. <td></td>
  2224. <td class="paramtype">uint8_t&#160;</td>
  2225. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  2226. </tr>
  2227. <tr>
  2228. <td></td>
  2229. <td>)</td>
  2230. <td></td><td></td>
  2231. </tr>
  2232. </table>
  2233. </td>
  2234. <td class="mlabels-right">
  2235. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2236. </tr>
  2237. </table>
  2238. </div><div class="memdoc">
  2239. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2240. <table class="params">
  2241. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2242. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2243. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  2244. </table>
  2245. </dd>
  2246. </dl>
  2247. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2248. </div>
  2249. </div>
  2250. <a id="a8f906be79086f38943cb0911310d67bf"></a>
  2251. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>
  2252. <div class="memitem">
  2253. <div class="memproto">
  2254. <div class="memtemplate">
  2255. template&lt;typename Type &gt; </div>
  2256. <table class="mlabels">
  2257. <tr>
  2258. <td class="mlabels-left">
  2259. <table class="memname">
  2260. <tr>
  2261. <td class="memname">size_t FatFile::printField </td>
  2262. <td>(</td>
  2263. <td class="paramtype">Type&#160;</td>
  2264. <td class="paramname"><em>value</em>, </td>
  2265. </tr>
  2266. <tr>
  2267. <td class="paramkey"></td>
  2268. <td></td>
  2269. <td class="paramtype">char&#160;</td>
  2270. <td class="paramname"><em>term</em>&#160;</td>
  2271. </tr>
  2272. <tr>
  2273. <td></td>
  2274. <td>)</td>
  2275. <td></td><td></td>
  2276. </tr>
  2277. </table>
  2278. </td>
  2279. <td class="mlabels-right">
  2280. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2281. </tr>
  2282. </table>
  2283. </div><div class="memdoc">
  2284. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2285. <table class="params">
  2286. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2287. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2288. </table>
  2289. </dd>
  2290. </dl>
  2291. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2292. </div>
  2293. </div>
  2294. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>
  2295. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>
  2296. <div class="memitem">
  2297. <div class="memproto">
  2298. <table class="memname">
  2299. <tr>
  2300. <td class="memname">size_t FatFile::printFileSize </td>
  2301. <td>(</td>
  2302. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2303. <td class="paramname"><em>pr</em></td><td>)</td>
  2304. <td></td>
  2305. </tr>
  2306. </table>
  2307. </div><div class="memdoc">
  2308. <p>Print a file's size.</p>
  2309. <dl class="params"><dt>Parameters</dt><dd>
  2310. <table class="params">
  2311. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2312. </table>
  2313. </dd>
  2314. </dl>
  2315. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>
  2316. </div>
  2317. </div>
  2318. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>
  2319. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>
  2320. <div class="memitem">
  2321. <div class="memproto">
  2322. <table class="memname">
  2323. <tr>
  2324. <td class="memname">size_t FatFile::printModifyDateTime </td>
  2325. <td>(</td>
  2326. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2327. <td class="paramname"><em>pr</em></td><td>)</td>
  2328. <td></td>
  2329. </tr>
  2330. </table>
  2331. </div><div class="memdoc">
  2332. <p>Print a file's modify date and time</p>
  2333. <dl class="params"><dt>Parameters</dt><dd>
  2334. <table class="params">
  2335. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2336. </table>
  2337. </dd>
  2338. </dl>
  2339. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2340. </div>
  2341. </div>
  2342. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>
  2343. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>
  2344. <div class="memitem">
  2345. <div class="memproto">
  2346. <table class="mlabels">
  2347. <tr>
  2348. <td class="mlabels-left">
  2349. <table class="memname">
  2350. <tr>
  2351. <td class="memname">size_t FatFile::printName </td>
  2352. <td>(</td>
  2353. <td class="paramname"></td><td>)</td>
  2354. <td></td>
  2355. </tr>
  2356. </table>
  2357. </td>
  2358. <td class="mlabels-right">
  2359. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2360. </tr>
  2361. </table>
  2362. </div><div class="memdoc">
  2363. <p>Print a file's name.</p>
  2364. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2365. </div>
  2366. </div>
  2367. <a id="afe18a787fb8640e2d2483370c770f82f"></a>
  2368. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>
  2369. <div class="memitem">
  2370. <div class="memproto">
  2371. <table class="memname">
  2372. <tr>
  2373. <td class="memname">size_t FatFile::printName </td>
  2374. <td>(</td>
  2375. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2376. <td class="paramname"><em>pr</em></td><td>)</td>
  2377. <td></td>
  2378. </tr>
  2379. </table>
  2380. </div><div class="memdoc">
  2381. <p>Print a file's name</p>
  2382. <dl class="params"><dt>Parameters</dt><dd>
  2383. <table class="params">
  2384. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2385. </table>
  2386. </dd>
  2387. </dl>
  2388. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2389. </div>
  2390. </div>
  2391. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>
  2392. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>
  2393. <div class="memitem">
  2394. <div class="memproto">
  2395. <table class="memname">
  2396. <tr>
  2397. <td class="memname">size_t FatFile::printSFN </td>
  2398. <td>(</td>
  2399. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2400. <td class="paramname"><em>pr</em></td><td>)</td>
  2401. <td></td>
  2402. </tr>
  2403. </table>
  2404. </div><div class="memdoc">
  2405. <p>Print a file's Short File Name.</p>
  2406. <dl class="params"><dt>Parameters</dt><dd>
  2407. <table class="params">
  2408. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2409. </table>
  2410. </dd>
  2411. </dl>
  2412. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>
  2413. </div>
  2414. </div>
  2415. <a id="a60ae55ff6fe158c2340071d702a363c5"></a>
  2416. <h2 class="memtitle"><span class="permalink"><a href="#a60ae55ff6fe158c2340071d702a363c5">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>
  2417. <div class="memitem">
  2418. <div class="memproto">
  2419. <table class="mlabels">
  2420. <tr>
  2421. <td class="mlabels-left">
  2422. <table class="memname">
  2423. <tr>
  2424. <td class="memname">int FatFile::read </td>
  2425. <td>(</td>
  2426. <td class="paramname"></td><td>)</td>
  2427. <td></td>
  2428. </tr>
  2429. </table>
  2430. </td>
  2431. <td class="mlabels-right">
  2432. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2433. </tr>
  2434. </table>
  2435. </div><div class="memdoc">
  2436. <p>Read the next byte from a file.</p>
  2437. <dl class="section return"><dt>Returns</dt><dd>For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned. </dd></dl>
  2438. </div>
  2439. </div>
  2440. <a id="aba893af8107a18017482d2311b066187"></a>
  2441. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>
  2442. <div class="memitem">
  2443. <div class="memproto">
  2444. <table class="memname">
  2445. <tr>
  2446. <td class="memname">int FatFile::read </td>
  2447. <td>(</td>
  2448. <td class="paramtype">void *&#160;</td>
  2449. <td class="paramname"><em>buf</em>, </td>
  2450. </tr>
  2451. <tr>
  2452. <td class="paramkey"></td>
  2453. <td></td>
  2454. <td class="paramtype">size_t&#160;</td>
  2455. <td class="paramname"><em>count</em>&#160;</td>
  2456. </tr>
  2457. <tr>
  2458. <td></td>
  2459. <td>)</td>
  2460. <td></td><td></td>
  2461. </tr>
  2462. </table>
  2463. </div><div class="memdoc">
  2464. <p>Read data from a file starting at the current position.</p>
  2465. <dl class="params"><dt>Parameters</dt><dd>
  2466. <table class="params">
  2467. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>
  2468. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>
  2469. </table>
  2470. </dd>
  2471. </dl>
  2472. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">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_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns -1. </dd></dl>
  2473. </div>
  2474. </div>
  2475. <a id="a29502cd34ef186763d2196daef27df1f"></a>
  2476. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>
  2477. <div class="memitem">
  2478. <div class="memproto">
  2479. <table class="memname">
  2480. <tr>
  2481. <td class="memname">int8_t FatFile::readDir </td>
  2482. <td>(</td>
  2483. <td class="paramtype">DirFat_t *&#160;</td>
  2484. <td class="paramname"><em>dir</em></td><td>)</td>
  2485. <td></td>
  2486. </tr>
  2487. </table>
  2488. </div><div class="memdoc">
  2489. <p>Read the next directory entry from a directory file.</p>
  2490. <dl class="params"><dt>Parameters</dt><dd>
  2491. <table class="params">
  2492. <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>
  2493. </table>
  2494. </dd>
  2495. </dl>
  2496. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>
  2497. </div>
  2498. </div>
  2499. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>
  2500. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  2501. <div class="memitem">
  2502. <div class="memproto">
  2503. <table class="memname">
  2504. <tr>
  2505. <td class="memname">bool FatFile::remove </td>
  2506. <td>(</td>
  2507. <td class="paramname"></td><td>)</td>
  2508. <td></td>
  2509. </tr>
  2510. </table>
  2511. </div><div class="memdoc">
  2512. <p>Remove a file.</p>
  2513. <p>The directory entry and all data for the file are deleted.</p>
  2514. <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>
  2515. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2516. </div>
  2517. </div>
  2518. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>
  2519. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  2520. <div class="memitem">
  2521. <div class="memproto">
  2522. <table class="memname">
  2523. <tr>
  2524. <td class="memname">bool FatFile::remove </td>
  2525. <td>(</td>
  2526. <td class="paramtype">const char *&#160;</td>
  2527. <td class="paramname"><em>path</em></td><td>)</td>
  2528. <td></td>
  2529. </tr>
  2530. </table>
  2531. </div><div class="memdoc">
  2532. <p>Remove a file.</p>
  2533. <p>The directory entry and all data for the file are deleted.</p>
  2534. <dl class="params"><dt>Parameters</dt><dd>
  2535. <table class="params">
  2536. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>
  2537. </table>
  2538. </dd>
  2539. </dl>
  2540. <p>Example use: dirFile.remove(filenameToRemove);</p>
  2541. <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>
  2542. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2543. </div>
  2544. </div>
  2545. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>
  2546. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  2547. <div class="memitem">
  2548. <div class="memproto">
  2549. <table class="memname">
  2550. <tr>
  2551. <td class="memname">bool FatFile::rename </td>
  2552. <td>(</td>
  2553. <td class="paramtype">const char *&#160;</td>
  2554. <td class="paramname"><em>newPath</em></td><td>)</td>
  2555. <td></td>
  2556. </tr>
  2557. </table>
  2558. </div><div class="memdoc">
  2559. <p>Rename a file or subdirectory. </p><dl class="section note"><dt>Note</dt><dd>the renamed file will be moved to the current volume working directory.</dd></dl>
  2560. <dl class="params"><dt>Parameters</dt><dd>
  2561. <table class="params">
  2562. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2563. </table>
  2564. </dd>
  2565. </dl>
  2566. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2567. </div>
  2568. </div>
  2569. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>
  2570. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  2571. <div class="memitem">
  2572. <div class="memproto">
  2573. <table class="memname">
  2574. <tr>
  2575. <td class="memname">bool FatFile::rename </td>
  2576. <td>(</td>
  2577. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  2578. <td class="paramname"><em>dirFile</em>, </td>
  2579. </tr>
  2580. <tr>
  2581. <td class="paramkey"></td>
  2582. <td></td>
  2583. <td class="paramtype">const char *&#160;</td>
  2584. <td class="paramname"><em>newPath</em>&#160;</td>
  2585. </tr>
  2586. <tr>
  2587. <td></td>
  2588. <td>)</td>
  2589. <td></td><td></td>
  2590. </tr>
  2591. </table>
  2592. </div><div class="memdoc">
  2593. <p>Rename a file or subdirectory.</p>
  2594. <dl class="params"><dt>Parameters</dt><dd>
  2595. <table class="params">
  2596. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>
  2597. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2598. </table>
  2599. </dd>
  2600. </dl>
  2601. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2602. </div>
  2603. </div>
  2604. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>
  2605. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>
  2606. <div class="memitem">
  2607. <div class="memproto">
  2608. <table class="mlabels">
  2609. <tr>
  2610. <td class="mlabels-left">
  2611. <table class="memname">
  2612. <tr>
  2613. <td class="memname">void FatFile::rewind </td>
  2614. <td>(</td>
  2615. <td class="paramname"></td><td>)</td>
  2616. <td></td>
  2617. </tr>
  2618. </table>
  2619. </td>
  2620. <td class="mlabels-right">
  2621. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2622. </tr>
  2623. </table>
  2624. </div><div class="memdoc">
  2625. <p>Set the file's current position to zero. </p>
  2626. </div>
  2627. </div>
  2628. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>
  2629. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>
  2630. <div class="memitem">
  2631. <div class="memproto">
  2632. <table class="memname">
  2633. <tr>
  2634. <td class="memname">bool FatFile::rmdir </td>
  2635. <td>(</td>
  2636. <td class="paramname"></td><td>)</td>
  2637. <td></td>
  2638. </tr>
  2639. </table>
  2640. </div><div class="memdoc">
  2641. <p>Remove a directory file.</p>
  2642. <p>The directory file will be removed only if it is empty and is not the root directory. <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a> follows DOS and Windows and ignores the read-only attribute for the directory.</p>
  2643. <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>
  2644. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2645. </div>
  2646. </div>
  2647. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>
  2648. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>
  2649. <div class="memitem">
  2650. <div class="memproto">
  2651. <table class="memname">
  2652. <tr>
  2653. <td class="memname">bool FatFile::rmRfStar </td>
  2654. <td>(</td>
  2655. <td class="paramname"></td><td>)</td>
  2656. <td></td>
  2657. </tr>
  2658. </table>
  2659. </div><div class="memdoc">
  2660. <p>Recursively delete a directory and all contained files.</p>
  2661. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>
  2662. <p>Warning - This will remove all contents of the directory including subdirectories. The directory will then be removed if it is not root. The read-only attribute for files will be ignored.</p>
  2663. <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. See <a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove()</a> and <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a>.</dd></dl>
  2664. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2665. </div>
  2666. </div>
  2667. <a id="a5812037ea30777cc350698ad26f2c73f"></a>
  2668. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>
  2669. <div class="memitem">
  2670. <div class="memproto">
  2671. <table class="mlabels">
  2672. <tr>
  2673. <td class="mlabels-left">
  2674. <table class="memname">
  2675. <tr>
  2676. <td class="memname">bool FatFile::seekCur </td>
  2677. <td>(</td>
  2678. <td class="paramtype">int32_t&#160;</td>
  2679. <td class="paramname"><em>offset</em></td><td>)</td>
  2680. <td></td>
  2681. </tr>
  2682. </table>
  2683. </td>
  2684. <td class="mlabels-right">
  2685. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2686. </tr>
  2687. </table>
  2688. </div><div class="memdoc">
  2689. <p>Set the files position to current position + <em>pos</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  2690. <table class="params">
  2691. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>
  2692. </table>
  2693. </dd>
  2694. </dl>
  2695. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2696. </div>
  2697. </div>
  2698. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>
  2699. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>
  2700. <div class="memitem">
  2701. <div class="memproto">
  2702. <table class="mlabels">
  2703. <tr>
  2704. <td class="mlabels-left">
  2705. <table class="memname">
  2706. <tr>
  2707. <td class="memname">bool FatFile::seekEnd </td>
  2708. <td>(</td>
  2709. <td class="paramtype">int32_t&#160;</td>
  2710. <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>
  2711. <td></td>
  2712. </tr>
  2713. </table>
  2714. </td>
  2715. <td class="mlabels-right">
  2716. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2717. </tr>
  2718. </table>
  2719. </div><div class="memdoc">
  2720. <p>Set the files position to end-of-file + <em>offset</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. Can't be used for directory files since file size is not defined. </p><dl class="params"><dt>Parameters</dt><dd>
  2721. <table class="params">
  2722. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>
  2723. </table>
  2724. </dd>
  2725. </dl>
  2726. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2727. </div>
  2728. </div>
  2729. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>
  2730. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>
  2731. <div class="memitem">
  2732. <div class="memproto">
  2733. <table class="memname">
  2734. <tr>
  2735. <td class="memname">bool FatFile::seekSet </td>
  2736. <td>(</td>
  2737. <td class="paramtype">uint32_t&#160;</td>
  2738. <td class="paramname"><em>pos</em></td><td>)</td>
  2739. <td></td>
  2740. </tr>
  2741. </table>
  2742. </div><div class="memdoc">
  2743. <p>Sets a file's position.</p>
  2744. <dl class="params"><dt>Parameters</dt><dd>
  2745. <table class="params">
  2746. <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>
  2747. </table>
  2748. </dd>
  2749. </dl>
  2750. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2751. </div>
  2752. </div>
  2753. <a id="a67f3dc4896c542d695e11aac927f585e"></a>
  2754. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>
  2755. <div class="memitem">
  2756. <div class="memproto">
  2757. <table class="memname">
  2758. <tr>
  2759. <td class="memname">bool FatFile::sync </td>
  2760. <td>(</td>
  2761. <td class="paramname"></td><td>)</td>
  2762. <td></td>
  2763. </tr>
  2764. </table>
  2765. </div><div class="memdoc">
  2766. <p>The <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> call causes all modified data and directory fields to be written to the storage device.</p>
  2767. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2768. </div>
  2769. </div>
  2770. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>
  2771. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>
  2772. <div class="memitem">
  2773. <div class="memproto">
  2774. <table class="memname">
  2775. <tr>
  2776. <td class="memname">bool FatFile::timestamp </td>
  2777. <td>(</td>
  2778. <td class="paramtype">uint8_t&#160;</td>
  2779. <td class="paramname"><em>flags</em>, </td>
  2780. </tr>
  2781. <tr>
  2782. <td class="paramkey"></td>
  2783. <td></td>
  2784. <td class="paramtype">uint16_t&#160;</td>
  2785. <td class="paramname"><em>year</em>, </td>
  2786. </tr>
  2787. <tr>
  2788. <td class="paramkey"></td>
  2789. <td></td>
  2790. <td class="paramtype">uint8_t&#160;</td>
  2791. <td class="paramname"><em>month</em>, </td>
  2792. </tr>
  2793. <tr>
  2794. <td class="paramkey"></td>
  2795. <td></td>
  2796. <td class="paramtype">uint8_t&#160;</td>
  2797. <td class="paramname"><em>day</em>, </td>
  2798. </tr>
  2799. <tr>
  2800. <td class="paramkey"></td>
  2801. <td></td>
  2802. <td class="paramtype">uint8_t&#160;</td>
  2803. <td class="paramname"><em>hour</em>, </td>
  2804. </tr>
  2805. <tr>
  2806. <td class="paramkey"></td>
  2807. <td></td>
  2808. <td class="paramtype">uint8_t&#160;</td>
  2809. <td class="paramname"><em>minute</em>, </td>
  2810. </tr>
  2811. <tr>
  2812. <td class="paramkey"></td>
  2813. <td></td>
  2814. <td class="paramtype">uint8_t&#160;</td>
  2815. <td class="paramname"><em>second</em>&#160;</td>
  2816. </tr>
  2817. <tr>
  2818. <td></td>
  2819. <td>)</td>
  2820. <td></td><td></td>
  2821. </tr>
  2822. </table>
  2823. </div><div class="memdoc">
  2824. <p>Set a file's timestamps in its directory entry.</p>
  2825. <dl class="params"><dt>Parameters</dt><dd>
  2826. <table class="params">
  2827. <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>
  2828. </table>
  2829. </dd>
  2830. </dl>
  2831. <p>T_ACCESS - Set the file's last access date.</p>
  2832. <p>T_CREATE - Set the file's creation date and time.</p>
  2833. <p>T_WRITE - Set the file's last write/modification date and time.</p>
  2834. <dl class="params"><dt>Parameters</dt><dd>
  2835. <table class="params">
  2836. <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>
  2837. <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>
  2838. <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>
  2839. <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>
  2840. <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>
  2841. <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>
  2842. </table>
  2843. </dd>
  2844. </dl>
  2845. <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>
  2846. <dd>
  2847. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>
  2848. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2849. </div>
  2850. </div>
  2851. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>
  2852. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>
  2853. <div class="memitem">
  2854. <div class="memproto">
  2855. <table class="memname">
  2856. <tr>
  2857. <td class="memname">bool FatFile::truncate </td>
  2858. <td>(</td>
  2859. <td class="paramname"></td><td>)</td>
  2860. <td></td>
  2861. </tr>
  2862. </table>
  2863. </div><div class="memdoc">
  2864. <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>
  2865. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2866. </div>
  2867. </div>
  2868. <a id="aa6e663098a578635d37d92e82d18d616"></a>
  2869. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>
  2870. <div class="memitem">
  2871. <div class="memproto">
  2872. <table class="mlabels">
  2873. <tr>
  2874. <td class="mlabels-left">
  2875. <table class="memname">
  2876. <tr>
  2877. <td class="memname">bool FatFile::truncate </td>
  2878. <td>(</td>
  2879. <td class="paramtype">uint32_t&#160;</td>
  2880. <td class="paramname"><em>length</em></td><td>)</td>
  2881. <td></td>
  2882. </tr>
  2883. </table>
  2884. </td>
  2885. <td class="mlabels-right">
  2886. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2887. </tr>
  2888. </table>
  2889. </div><div class="memdoc">
  2890. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>
  2891. <dl class="params"><dt>Parameters</dt><dd>
  2892. <table class="params">
  2893. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2894. </table>
  2895. </dd>
  2896. </dl>
  2897. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2898. </div>
  2899. </div>
  2900. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>
  2901. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>
  2902. <div class="memitem">
  2903. <div class="memproto">
  2904. <table class="mlabels">
  2905. <tr>
  2906. <td class="mlabels-left">
  2907. <table class="memname">
  2908. <tr>
  2909. <td class="memname">size_t FatFile::write </td>
  2910. <td>(</td>
  2911. <td class="paramtype">const char *&#160;</td>
  2912. <td class="paramname"><em>str</em></td><td>)</td>
  2913. <td></td>
  2914. </tr>
  2915. </table>
  2916. </td>
  2917. <td class="mlabels-right">
  2918. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2919. </tr>
  2920. </table>
  2921. </div><div class="memdoc">
  2922. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
  2923. <table class="params">
  2924. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>
  2925. </table>
  2926. </dd>
  2927. </dl>
  2928. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>
  2929. </div>
  2930. </div>
  2931. <a id="a5d84d871ac904a22aa48308713d14682"></a>
  2932. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>
  2933. <div class="memitem">
  2934. <div class="memproto">
  2935. <table class="memname">
  2936. <tr>
  2937. <td class="memname">size_t FatFile::write </td>
  2938. <td>(</td>
  2939. <td class="paramtype">const void *&#160;</td>
  2940. <td class="paramname"><em>buf</em>, </td>
  2941. </tr>
  2942. <tr>
  2943. <td class="paramkey"></td>
  2944. <td></td>
  2945. <td class="paramtype">size_t&#160;</td>
  2946. <td class="paramname"><em>count</em>&#160;</td>
  2947. </tr>
  2948. <tr>
  2949. <td></td>
  2950. <td>)</td>
  2951. <td></td><td></td>
  2952. </tr>
  2953. </table>
  2954. </div><div class="memdoc">
  2955. <p>Write data to an open file.</p>
  2956. <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_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> is called.</dd></dl>
  2957. <dl class="params"><dt>Parameters</dt><dd>
  2958. <table class="params">
  2959. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>
  2960. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>
  2961. </table>
  2962. </dd>
  2963. </dl>
  2964. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns the number of bytes written, always <em>count</em>. If an error occurs, <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error. </dd></dl>
  2965. </div>
  2966. </div>
  2967. <a id="ae51e724ac6cc3d67d64a5a666d5850f1"></a>
  2968. <h2 class="memtitle"><span class="permalink"><a href="#ae51e724ac6cc3d67d64a5a666d5850f1">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>
  2969. <div class="memitem">
  2970. <div class="memproto">
  2971. <table class="mlabels">
  2972. <tr>
  2973. <td class="mlabels-left">
  2974. <table class="memname">
  2975. <tr>
  2976. <td class="memname">size_t FatFile::write </td>
  2977. <td>(</td>
  2978. <td class="paramtype">uint8_t&#160;</td>
  2979. <td class="paramname"><em>b</em></td><td>)</td>
  2980. <td></td>
  2981. </tr>
  2982. </table>
  2983. </td>
  2984. <td class="mlabels-right">
  2985. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2986. </tr>
  2987. </table>
  2988. </div><div class="memdoc">
  2989. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>
  2990. <table class="params">
  2991. <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>
  2992. </table>
  2993. </dd>
  2994. </dl>
  2995. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>
  2996. </div>
  2997. </div>
  2998. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  2999. <a id="a6ca3f436167f187097347a20ea221555"></a>
  3000. <h2 class="memtitle"><span class="permalink"><a href="#a6ca3f436167f187097347a20ea221555">&#9670;&nbsp;</a></span>FatVolume</h2>
  3001. <div class="memitem">
  3002. <div class="memproto">
  3003. <table class="mlabels">
  3004. <tr>
  3005. <td class="mlabels-left">
  3006. <table class="memname">
  3007. <tr>
  3008. <td class="memname">friend class <a class="el" href="class_fat_volume.html">FatVolume</a></td>
  3009. </tr>
  3010. </table>
  3011. </td>
  3012. <td class="mlabels-right">
  3013. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  3014. </tr>
  3015. </table>
  3016. </div><div class="memdoc">
  3017. <p><a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library.">FatVolume</a> allowed access to private members. </p>
  3018. </div>
  3019. </div>
  3020. <hr/>The documentation for this class was generated from the following files:<ul>
  3021. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>
  3022. <li>Arduino/libraries/SdFat/src/FatLib/FatFile.cpp</li>
  3023. <li>Arduino/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>
  3024. <li>Arduino/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>
  3025. <li>Arduino/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>
  3026. </ul>
  3027. </div><!-- contents -->
  3028. <!-- start footer part -->
  3029. <hr class="footer"/><address class="footer"><small>
  3030. Generated on Sat Dec 5 2020 05:21:24 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  3031. <img class="footer" src="doxygen.png" alt="doxygen"/>
  3032. </a> 1.8.16
  3033. </small></address>
  3034. </body>
  3035. </html>