class_sd_fat_e_x.html 110 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: SdFatEX 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.14 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="class_sd_fat_e_x-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">SdFatEX Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p><a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class with extended SD I/O.
  70. <a href="class_sd_fat_e_x.html#details">More...</a></p>
  71. <p><code>#include &lt;SdFat.h&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for SdFatEX:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="class_sd_fat_e_x__inherit__graph.png" border="0" usemap="#_sd_fat_e_x_inherit__map" alt="Inheritance graph"/></div>
  76. <map name="_sd_fat_e_x_inherit__map" id="_sd_fat_e_x_inherit__map">
  77. <area shape="rect" id="node2" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCardEX \&gt;" alt="" coords="5,155,212,181"/>
  78. <area shape="rect" id="node3" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="55,80,162,107"/>
  79. <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="66,5,151,32"/>
  80. </map>
  81. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  82. <div class="dynheader">
  83. Collaboration diagram for SdFatEX:</div>
  84. <div class="dyncontent">
  85. <div class="center"><img src="class_sd_fat_e_x__coll__graph.png" border="0" usemap="#_sd_fat_e_x_coll__map" alt="Collaboration graph"/></div>
  86. <map name="_sd_fat_e_x_coll__map" id="_sd_fat_e_x_coll__map">
  87. <area shape="rect" id="node2" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCardEX \&gt;" alt="" coords="5,155,212,181"/>
  88. <area shape="rect" id="node3" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="55,80,162,107"/>
  89. <area shape="rect" id="node4" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="66,5,151,32"/>
  90. </map>
  91. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>
  96. <tr class="separator:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ad94237ef45c52698e97b04e8c131f21e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin</a> ()</td></tr>
  98. <tr class="separator:ad94237ef45c52698e97b04e8c131f21e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a25acc97272c6004a6a4118bacef07467"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_e_x.html#a25acc97272c6004a6a4118bacef07467">begin</a> (uint8_t csPin=SS, SPISettings spiSettings=SPI_FULL_SPEED)</td></tr>
  100. <tr class="separator:a25acc97272c6004a6a4118bacef07467"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:af6ab43bc0853febb38298406c4067a43"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af6ab43bc0853febb38298406c4067a43">blocksPerCluster</a> () const</td></tr>
  102. <tr class="separator:af6ab43bc0853febb38298406c4067a43"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:adb87da3b10344f28a92dfade492b8398"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#adb87da3b10344f28a92dfade492b8398">blocksPerFat</a> () const</td></tr>
  104. <tr class="separator:adb87da3b10344f28a92dfade492b8398"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>
  106. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab5dcfbeeb7caa38a38db86003341eb07">card</a> ()</td></tr>
  108. <tr class="separator:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#aedfd5a0830c955bc5514e52f2f2dd066">cardErrorCode</a> ()</td></tr>
  110. <tr class="separator:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a0602ab3c04ea33293649f0a15fc81e05"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0602ab3c04ea33293649f0a15fc81e05">cardErrorData</a> ()</td></tr>
  112. <tr class="separator:a0602ab3c04ea33293649f0a15fc81e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>
  114. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>
  116. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:af24917d6e00c8766dab168eb834047ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#af24917d6e00c8766dab168eb834047ec">chvol</a> ()</td></tr>
  118. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ae724879a554174e31a737f73da418009"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae724879a554174e31a737f73da418009">clusterCount</a> () const</td></tr>
  120. <tr class="separator:ae724879a554174e31a737f73da418009"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ab36468240ef6846578ad7f58d1bc41ac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab36468240ef6846578ad7f58d1bc41ac">clusterSizeShift</a> () const</td></tr>
  122. <tr class="separator:ab36468240ef6846578ad7f58d1bc41ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a55906112e0d151db3b144d29630f5066"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a55906112e0d151db3b144d29630f5066">dataStartBlock</a> () const</td></tr>
  124. <tr class="separator:a55906112e0d151db3b144d29630f5066"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  126. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a855267374306bfee2df67642c99d4d18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a855267374306bfee2df67642c99d4d18">errorHalt</a> ()</td></tr>
  128. <tr class="separator:a855267374306bfee2df67642c99d4d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ae1f79a2974ebe134e70f898c32d97e98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae1f79a2974ebe134e70f898c32d97e98">errorHalt</a> (Print *pr)</td></tr>
  130. <tr class="separator:ae1f79a2974ebe134e70f898c32d97e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a32c20dfa6a8cb8af95f25847b19bdbca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a32c20dfa6a8cb8af95f25847b19bdbca">errorHalt</a> (char const *msg)</td></tr>
  132. <tr class="separator:a32c20dfa6a8cb8af95f25847b19bdbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a27fb329d6aee79a63c20386218ce7e9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a27fb329d6aee79a63c20386218ce7e9e">errorHalt</a> (Print *pr, char const *msg)</td></tr>
  134. <tr class="separator:a27fb329d6aee79a63c20386218ce7e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:af856494745a9842d9728dfeabf19c51e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#af856494745a9842d9728dfeabf19c51e">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  136. <tr class="separator:af856494745a9842d9728dfeabf19c51e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a746c80d048c30baf0b281e16932670a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a746c80d048c30baf0b281e16932670a2">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  138. <tr class="separator:a746c80d048c30baf0b281e16932670a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ab0b78154d6874c29279ba81f36ccb09c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab0b78154d6874c29279ba81f36ccb09c">errorPrint</a> ()</td></tr>
  140. <tr class="separator:ab0b78154d6874c29279ba81f36ccb09c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a03736274debea71fef5e2ff34d7ec3dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a03736274debea71fef5e2ff34d7ec3dc">errorPrint</a> (Print *pr)</td></tr>
  142. <tr class="separator:a03736274debea71fef5e2ff34d7ec3dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a2e2436b7b2666737cbaf4b22218bc69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2e2436b7b2666737cbaf4b22218bc69f">errorPrint</a> (const char *msg)</td></tr>
  144. <tr class="separator:a2e2436b7b2666737cbaf4b22218bc69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a0eb6b92a0700ba932f6127962981d153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0eb6b92a0700ba932f6127962981d153">errorPrint</a> (Print *pr, char const *msg)</td></tr>
  146. <tr class="separator:a0eb6b92a0700ba932f6127962981d153"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a1ccb1f937f42e9c1331c942bc357f6da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a1ccb1f937f42e9c1331c942bc357f6da">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  148. <tr class="separator:a1ccb1f937f42e9c1331c942bc357f6da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a43344a079d9af92ea4b550914d0512f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a43344a079d9af92ea4b550914d0512f6">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  150. <tr class="separator:a43344a079d9af92ea4b550914d0512f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:aee58c6352652f216577196e32a594b67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aee58c6352652f216577196e32a594b67">exists</a> (const char *path)</td></tr>
  152. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acdedc6a200b01e401c9cd9b511eae6ec">fatCount</a> ()</td></tr>
  154. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a260bc030ab188a481dd34d6062f7b9d2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a260bc030ab188a481dd34d6062f7b9d2">fatStartBlock</a> () const</td></tr>
  156. <tr class="separator:a260bc030ab188a481dd34d6062f7b9d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a0d736f0e8f03476b896307fbe5427376"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0d736f0e8f03476b896307fbe5427376">fatType</a> () const</td></tr>
  158. <tr class="separator:a0d736f0e8f03476b896307fbe5427376"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a1683b063fc6202ab85470b9610f16f93"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1683b063fc6202ab85470b9610f16f93">freeClusterCount</a> ()</td></tr>
  160. <tr class="separator:a1683b063fc6202ab85470b9610f16f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">init</a> ()</td></tr>
  162. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>
  164. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a8e1f26486bb878a24fa9868e59dbbbc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8e1f26486bb878a24fa9868e59dbbbc2">initErrorHalt</a> ()</td></tr>
  166. <tr class="separator:a8e1f26486bb878a24fa9868e59dbbbc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a24bd0f699cf0fe11fd2148b15c49251a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a24bd0f699cf0fe11fd2148b15c49251a">initErrorHalt</a> (Print *pr)</td></tr>
  168. <tr class="separator:a24bd0f699cf0fe11fd2148b15c49251a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a893833a880e2a83757480ba4c1351041"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a893833a880e2a83757480ba4c1351041">initErrorHalt</a> (char const *msg)</td></tr>
  170. <tr class="separator:a893833a880e2a83757480ba4c1351041"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a3077b1a53d789d0401b707963cb28f46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a3077b1a53d789d0401b707963cb28f46">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>
  172. <tr class="separator:a3077b1a53d789d0401b707963cb28f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:a2a1e4cc8056ba23b55dfa2c6486b8798"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2a1e4cc8056ba23b55dfa2c6486b8798">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  174. <tr class="separator:a2a1e4cc8056ba23b55dfa2c6486b8798"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:ab03d98012dea18733c3252f27832de69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab03d98012dea18733c3252f27832de69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  176. <tr class="separator:ab03d98012dea18733c3252f27832de69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:ae31c9cbd7e1c03129d6c99b25f73cd50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae31c9cbd7e1c03129d6c99b25f73cd50">initErrorPrint</a> ()</td></tr>
  178. <tr class="separator:ae31c9cbd7e1c03129d6c99b25f73cd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a066707dce0667213b5f083d59f67448d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a066707dce0667213b5f083d59f67448d">initErrorPrint</a> (Print *pr)</td></tr>
  180. <tr class="separator:a066707dce0667213b5f083d59f67448d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a538796f79fd9db9c5bbeefd9defe639a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a538796f79fd9db9c5bbeefd9defe639a">initErrorPrint</a> (char const *msg)</td></tr>
  182. <tr class="separator:a538796f79fd9db9c5bbeefd9defe639a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:ad9855d33ebd465715b706d0926291b13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad9855d33ebd465715b706d0926291b13">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>
  184. <tr class="separator:ad9855d33ebd465715b706d0926291b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:ad6ffec5a7d82be46d46b8a4f82d0803b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad6ffec5a7d82be46d46b8a4f82d0803b">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  186. <tr class="separator:ad6ffec5a7d82be46d46b8a4f82d0803b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a8a2018b6366145a9843d3d29a47d6560"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8a2018b6366145a9843d3d29a47d6560">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  188. <tr class="separator:a8a2018b6366145a9843d3d29a47d6560"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a2398fb37a7a9d5e0dc0ffde6a44a993d">ls</a> (uint8_t flags=0)</td></tr>
  190. <tr class="separator:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:a122b61dbec5051304bcc81bc08b1b99d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a122b61dbec5051304bcc81bc08b1b99d">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  192. <tr class="separator:a122b61dbec5051304bcc81bc08b1b99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  194. <tr class="separator:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  196. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a231c62c98ba8ac3c2624dc5ad2053ebf">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  198. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:a1590dbde58cf1622a18d1350058a6e18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a1590dbde58cf1622a18d1350058a6e18">open</a> (const char *path, oflag_t oflag=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  200. <tr class="separator:a1590dbde58cf1622a18d1350058a6e18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a7c44842544967e0083bec1a6089e5061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a7c44842544967e0083bec1a6089e5061">open</a> (const String &amp;path, oflag_t oflag=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  202. <tr class="separator:a7c44842544967e0083bec1a6089e5061"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#abf7d7d0dab43083d5be10d70ff4669e4">remove</a> (const char *path)</td></tr>
  204. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a0187891a24017b41bd7c5ba63e659e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  206. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:aaed2edc7ff7fedb163458c870bb41b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aaed2edc7ff7fedb163458c870bb41b33">rmdir</a> (const char *path)</td></tr>
  208. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a31d0efaf3e47c9342da0dfb3735eecf1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a31d0efaf3e47c9342da0dfb3735eecf1">rootDirEntryCount</a> () const</td></tr>
  210. <tr class="separator:a31d0efaf3e47c9342da0dfb3735eecf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:a372f1f1fab71f5744eaf538156abe64d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a372f1f1fab71f5744eaf538156abe64d">rootDirStart</a> () const</td></tr>
  212. <tr class="separator:a372f1f1fab71f5744eaf538156abe64d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:aef4d79f9a36785543f48ddc18ac2af78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat_e_x.html#aef4d79f9a36785543f48ddc18ac2af78">SdFatEX</a> (SPIClass *spiPort)</td></tr>
  214. <tr class="separator:aef4d79f9a36785543f48ddc18ac2af78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:ad60cb13557f35578f868e03e9ccb8be1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ad60cb13557f35578f868e03e9ccb8be1">truncate</a> (const char *path, uint32_t length)</td></tr>
  216. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a4ca68fe47bb675df0a80df1ed7a53698">vol</a> ()</td></tr>
  218. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:ada9f893c796559c132ef9da061f04a39"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ada9f893c796559c132ef9da061f04a39">volumeBlockCount</a> () const</td></tr>
  220. <tr class="separator:ada9f893c796559c132ef9da061f04a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  221. <tr class="memitem:acf257d02b7166683bda2abc5058004bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#acf257d02b7166683bda2abc5058004bf">vwd</a> ()</td></tr>
  222. <tr class="separator:acf257d02b7166683bda2abc5058004bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a36d7831f92acfbfef1c4a24dd7103dc4">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>
  224. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. </table>
  226. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  227. <div class="textblock"><p><a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> class with extended SD I/O. </p>
  228. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  229. <a id="aef4d79f9a36785543f48ddc18ac2af78"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#aef4d79f9a36785543f48ddc18ac2af78">&#9670;&nbsp;</a></span>SdFatEX()</h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="mlabels">
  234. <tr>
  235. <td class="mlabels-left">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">SdFatEX::SdFatEX </td>
  239. <td>(</td>
  240. <td class="paramtype">SPIClass *&#160;</td>
  241. <td class="paramname"><em>spiPort</em></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </td>
  246. <td class="mlabels-right">
  247. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Constructor with SPI port selection. </p><dl class="params"><dt>Parameters</dt><dd>
  252. <table class="params">
  253. <tr><td class="paramdir">[in]</td><td class="paramname">spiPort</td><td>SPI port number. </td></tr>
  254. </table>
  255. </dd>
  256. </dl>
  257. </div>
  258. </div>
  259. <h2 class="groupheader">Member Function Documentation</h2>
  260. <a id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a5dda20d3dcbfc8c641babbb2c9aac382">&#9670;&nbsp;</a></span>begin() <span class="overload">[1/3]</span></h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">bool FatFileSystem::begin </td>
  270. <td>(</td>
  271. <td class="paramtype"><a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *&#160;</td>
  272. <td class="paramname"><em>blockDev</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">uint8_t&#160;</td>
  278. <td class="paramname"><em>part</em> = <code>0</code>&#160;</td>
  279. </tr>
  280. <tr>
  281. <td></td>
  282. <td>)</td>
  283. <td></td><td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>Initialize an <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  293. <table class="params">
  294. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  295. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  296. </table>
  297. </dd>
  298. </dl>
  299. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  300. </div>
  301. </div>
  302. <a id="ad94237ef45c52698e97b04e8c131f21e"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#ad94237ef45c52698e97b04e8c131f21e">&#9670;&nbsp;</a></span>begin() <span class="overload">[2/3]</span></h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">bool <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::begin </td>
  312. <td>(</td>
  313. <td class="paramname"></td><td>)</td>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </td>
  318. <td class="mlabels-right">
  319. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Initialize file system. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  324. </div>
  325. </div>
  326. <a id="a25acc97272c6004a6a4118bacef07467"></a>
  327. <h2 class="memtitle"><span class="permalink"><a href="#a25acc97272c6004a6a4118bacef07467">&#9670;&nbsp;</a></span>begin() <span class="overload">[3/3]</span></h2>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="mlabels">
  331. <tr>
  332. <td class="mlabels-left">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">bool SdFatEX::begin </td>
  336. <td>(</td>
  337. <td class="paramtype">uint8_t&#160;</td>
  338. <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>
  339. </tr>
  340. <tr>
  341. <td class="paramkey"></td>
  342. <td></td>
  343. <td class="paramtype">SPISettings&#160;</td>
  344. <td class="paramname"><em>spiSettings</em> = <code>SPI_FULL_SPEED</code>&#160;</td>
  345. </tr>
  346. <tr>
  347. <td></td>
  348. <td>)</td>
  349. <td></td><td></td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Initialize SD card and file system.</p>
  359. <dl class="params"><dt>Parameters</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>
  362. <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  367. </div>
  368. </div>
  369. <a id="af6ab43bc0853febb38298406c4067a43"></a>
  370. <h2 class="memtitle"><span class="permalink"><a href="#af6ab43bc0853febb38298406c4067a43">&#9670;&nbsp;</a></span>blocksPerCluster()</h2>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="mlabels">
  374. <tr>
  375. <td class="mlabels-left">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname">uint8_t FatVolume::blocksPerCluster </td>
  379. <td>(</td>
  380. <td class="paramname"></td><td>)</td>
  381. <td> const</td>
  382. </tr>
  383. </table>
  384. </td>
  385. <td class="mlabels-right">
  386. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  391. </div>
  392. </div>
  393. <a id="adb87da3b10344f28a92dfade492b8398"></a>
  394. <h2 class="memtitle"><span class="permalink"><a href="#adb87da3b10344f28a92dfade492b8398">&#9670;&nbsp;</a></span>blocksPerFat()</h2>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="mlabels">
  398. <tr>
  399. <td class="mlabels-left">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  403. <td>(</td>
  404. <td class="paramname"></td><td>)</td>
  405. <td> const</td>
  406. </tr>
  407. </table>
  408. </td>
  409. <td class="mlabels-right">
  410. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  415. </div>
  416. </div>
  417. <a id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  418. <h2 class="memtitle"><span class="permalink"><a href="#aa1e3b1d0c21d202deb82668068ab00e8">&#9670;&nbsp;</a></span>cacheClear()</h2>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  427. <td>(</td>
  428. <td class="paramname"></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Clear the cache and returns a pointer to the cache. Not for normal apps. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>
  439. </div>
  440. </div>
  441. <a id="ab5dcfbeeb7caa38a38db86003341eb07"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#ab5dcfbeeb7caa38a38db86003341eb07">&#9670;&nbsp;</a></span>card()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="mlabels">
  446. <tr>
  447. <td class="mlabels-left">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname"><a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> * <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::card </td>
  451. <td>(</td>
  452. <td class="paramname"></td><td>)</td>
  453. <td></td>
  454. </tr>
  455. </table>
  456. </td>
  457. <td class="mlabels-right">
  458. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  459. </tr>
  460. </table>
  461. </div><div class="memdoc">
  462. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>
  463. </div>
  464. </div>
  465. <a id="aedfd5a0830c955bc5514e52f2f2dd066"></a>
  466. <h2 class="memtitle"><span class="permalink"><a href="#aedfd5a0830c955bc5514e52f2f2dd066">&#9670;&nbsp;</a></span>cardErrorCode()</h2>
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="mlabels">
  470. <tr>
  471. <td class="mlabels-left">
  472. <table class="memname">
  473. <tr>
  474. <td class="memname">uint8_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::cardErrorCode </td>
  475. <td>(</td>
  476. <td class="paramname"></td><td>)</td>
  477. <td></td>
  478. </tr>
  479. </table>
  480. </td>
  481. <td class="mlabels-right">
  482. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <dl class="section return"><dt>Returns</dt><dd>The card error code </dd></dl>
  487. </div>
  488. </div>
  489. <a id="a0602ab3c04ea33293649f0a15fc81e05"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#a0602ab3c04ea33293649f0a15fc81e05">&#9670;&nbsp;</a></span>cardErrorData()</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="mlabels">
  494. <tr>
  495. <td class="mlabels-left">
  496. <table class="memname">
  497. <tr>
  498. <td class="memname">uint32_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::cardErrorData </td>
  499. <td>(</td>
  500. <td class="paramname"></td><td>)</td>
  501. <td></td>
  502. </tr>
  503. </table>
  504. </td>
  505. <td class="mlabels-right">
  506. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <dl class="section return"><dt>Returns</dt><dd>the card error data </dd></dl>
  511. </div>
  512. </div>
  513. <a id="a5667915e63187a43a71dfada63800865"></a>
  514. <h2 class="memtitle"><span class="permalink"><a href="#a5667915e63187a43a71dfada63800865">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/2]</span></h2>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="mlabels">
  518. <tr>
  519. <td class="mlabels-left">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">bool FatFileSystem::chdir </td>
  523. <td>(</td>
  524. <td class="paramtype">bool&#160;</td>
  525. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </td>
  530. <td class="mlabels-right">
  531. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Change a volume's working directory to root</p>
  536. <p>Changes the volume's working directory to the SD's root directory. Optionally set the current working directory to the volume's working directory.</p>
  537. <dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  540. </table>
  541. </dd>
  542. </dl>
  543. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  544. </div>
  545. </div>
  546. <a id="a44af1b98e8d986d12107b654453acbc4"></a>
  547. <h2 class="memtitle"><span class="permalink"><a href="#a44af1b98e8d986d12107b654453acbc4">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/2]</span></h2>
  548. <div class="memitem">
  549. <div class="memproto">
  550. <table class="mlabels">
  551. <tr>
  552. <td class="mlabels-left">
  553. <table class="memname">
  554. <tr>
  555. <td class="memname">bool FatFileSystem::chdir </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">bool&#160;</td>
  564. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  565. </tr>
  566. <tr>
  567. <td></td>
  568. <td>)</td>
  569. <td></td><td></td>
  570. </tr>
  571. </table>
  572. </td>
  573. <td class="mlabels-right">
  574. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <p>Change a volume's working directory</p>
  579. <p>Changes the volume working directory to the <em>path</em> subdirectory. Optionally set the current working directory to the volume's working directory.</p>
  580. <p>Example: If the volume's working directory is "/DIR", chdir("SUB") will change the volume's working directory from "/DIR" to "/DIR/SUB".</p>
  581. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  582. <dl class="params"><dt>Parameters</dt><dd>
  583. <table class="params">
  584. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  585. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  586. </table>
  587. </dd>
  588. </dl>
  589. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  590. </div>
  591. </div>
  592. <a id="af24917d6e00c8766dab168eb834047ec"></a>
  593. <h2 class="memtitle"><span class="permalink"><a href="#af24917d6e00c8766dab168eb834047ec">&#9670;&nbsp;</a></span>chvol()</h2>
  594. <div class="memitem">
  595. <div class="memproto">
  596. <table class="mlabels">
  597. <tr>
  598. <td class="mlabels-left">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname">void FatFileSystem::chvol </td>
  602. <td>(</td>
  603. <td class="paramname"></td><td>)</td>
  604. <td></td>
  605. </tr>
  606. </table>
  607. </td>
  608. <td class="mlabels-right">
  609. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <p>Set the current working directory to a volume's working directory.</p>
  614. <p>This is useful with multiple SD cards.</p>
  615. <p>The current working directory is changed to this volume's working directory.</p>
  616. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  617. </div>
  618. </div>
  619. <a id="ae724879a554174e31a737f73da418009"></a>
  620. <h2 class="memtitle"><span class="permalink"><a href="#ae724879a554174e31a737f73da418009">&#9670;&nbsp;</a></span>clusterCount()</h2>
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="mlabels">
  624. <tr>
  625. <td class="mlabels-left">
  626. <table class="memname">
  627. <tr>
  628. <td class="memname">uint32_t FatVolume::clusterCount </td>
  629. <td>(</td>
  630. <td class="paramname"></td><td>)</td>
  631. <td> const</td>
  632. </tr>
  633. </table>
  634. </td>
  635. <td class="mlabels-right">
  636. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  637. </tr>
  638. </table>
  639. </div><div class="memdoc">
  640. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  641. </div>
  642. </div>
  643. <a id="ab36468240ef6846578ad7f58d1bc41ac"></a>
  644. <h2 class="memtitle"><span class="permalink"><a href="#ab36468240ef6846578ad7f58d1bc41ac">&#9670;&nbsp;</a></span>clusterSizeShift()</h2>
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="mlabels">
  648. <tr>
  649. <td class="mlabels-left">
  650. <table class="memname">
  651. <tr>
  652. <td class="memname">uint8_t FatVolume::clusterSizeShift </td>
  653. <td>(</td>
  654. <td class="paramname"></td><td>)</td>
  655. <td> const</td>
  656. </tr>
  657. </table>
  658. </td>
  659. <td class="mlabels-right">
  660. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  661. </tr>
  662. </table>
  663. </div><div class="memdoc">
  664. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  665. </div>
  666. </div>
  667. <a id="a55906112e0d151db3b144d29630f5066"></a>
  668. <h2 class="memtitle"><span class="permalink"><a href="#a55906112e0d151db3b144d29630f5066">&#9670;&nbsp;</a></span>dataStartBlock()</h2>
  669. <div class="memitem">
  670. <div class="memproto">
  671. <table class="mlabels">
  672. <tr>
  673. <td class="mlabels-left">
  674. <table class="memname">
  675. <tr>
  676. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  677. <td>(</td>
  678. <td class="paramname"></td><td>)</td>
  679. <td> const</td>
  680. </tr>
  681. </table>
  682. </td>
  683. <td class="mlabels-right">
  684. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  685. </tr>
  686. </table>
  687. </div><div class="memdoc">
  688. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  689. </div>
  690. </div>
  691. <a id="a25c6311b70fa274b3be94ff25fdebba7"></a>
  692. <h2 class="memtitle"><span class="permalink"><a href="#a25c6311b70fa274b3be94ff25fdebba7">&#9670;&nbsp;</a></span>dbgFat()</h2>
  693. <div class="memitem">
  694. <div class="memproto">
  695. <table class="mlabels">
  696. <tr>
  697. <td class="mlabels-left">
  698. <table class="memname">
  699. <tr>
  700. <td class="memname">int8_t FatVolume::dbgFat </td>
  701. <td>(</td>
  702. <td class="paramtype">uint32_t&#160;</td>
  703. <td class="paramname"><em>n</em>, </td>
  704. </tr>
  705. <tr>
  706. <td class="paramkey"></td>
  707. <td></td>
  708. <td class="paramtype">uint32_t *&#160;</td>
  709. <td class="paramname"><em>v</em>&#160;</td>
  710. </tr>
  711. <tr>
  712. <td></td>
  713. <td>)</td>
  714. <td></td><td></td>
  715. </tr>
  716. </table>
  717. </td>
  718. <td class="mlabels-right">
  719. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  720. </tr>
  721. </table>
  722. </div><div class="memdoc">
  723. <p>Debug access to FAT table</p>
  724. <dl class="params"><dt>Parameters</dt><dd>
  725. <table class="params">
  726. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  727. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  728. </table>
  729. </dd>
  730. </dl>
  731. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>
  732. </div>
  733. </div>
  734. <a id="a855267374306bfee2df67642c99d4d18"></a>
  735. <h2 class="memtitle"><span class="permalink"><a href="#a855267374306bfee2df67642c99d4d18">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[1/6]</span></h2>
  736. <div class="memitem">
  737. <div class="memproto">
  738. <table class="mlabels">
  739. <tr>
  740. <td class="mlabels-left">
  741. <table class="memname">
  742. <tr>
  743. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  744. <td>(</td>
  745. <td class="paramname"></td><td>)</td>
  746. <td></td>
  747. </tr>
  748. </table>
  749. </td>
  750. <td class="mlabels-right">
  751. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  752. </tr>
  753. </table>
  754. </div><div class="memdoc">
  755. <p>Print any SD error code to Serial and halt. </p>
  756. </div>
  757. </div>
  758. <a id="ae1f79a2974ebe134e70f898c32d97e98"></a>
  759. <h2 class="memtitle"><span class="permalink"><a href="#ae1f79a2974ebe134e70f898c32d97e98">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[2/6]</span></h2>
  760. <div class="memitem">
  761. <div class="memproto">
  762. <table class="mlabels">
  763. <tr>
  764. <td class="mlabels-left">
  765. <table class="memname">
  766. <tr>
  767. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  768. <td>(</td>
  769. <td class="paramtype">Print *&#160;</td>
  770. <td class="paramname"><em>pr</em></td><td>)</td>
  771. <td></td>
  772. </tr>
  773. </table>
  774. </td>
  775. <td class="mlabels-right">
  776. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  777. </tr>
  778. </table>
  779. </div><div class="memdoc">
  780. <p>Print any SD error code and halt.</p>
  781. <dl class="params"><dt>Parameters</dt><dd>
  782. <table class="params">
  783. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  784. </table>
  785. </dd>
  786. </dl>
  787. </div>
  788. </div>
  789. <a id="a32c20dfa6a8cb8af95f25847b19bdbca"></a>
  790. <h2 class="memtitle"><span class="permalink"><a href="#a32c20dfa6a8cb8af95f25847b19bdbca">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[3/6]</span></h2>
  791. <div class="memitem">
  792. <div class="memproto">
  793. <table class="mlabels">
  794. <tr>
  795. <td class="mlabels-left">
  796. <table class="memname">
  797. <tr>
  798. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  799. <td>(</td>
  800. <td class="paramtype">char const *&#160;</td>
  801. <td class="paramname"><em>msg</em></td><td>)</td>
  802. <td></td>
  803. </tr>
  804. </table>
  805. </td>
  806. <td class="mlabels-right">
  807. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  808. </tr>
  809. </table>
  810. </div><div class="memdoc">
  811. <p>Print msg, any SD error code and halt.</p>
  812. <dl class="params"><dt>Parameters</dt><dd>
  813. <table class="params">
  814. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  815. </table>
  816. </dd>
  817. </dl>
  818. </div>
  819. </div>
  820. <a id="a27fb329d6aee79a63c20386218ce7e9e"></a>
  821. <h2 class="memtitle"><span class="permalink"><a href="#a27fb329d6aee79a63c20386218ce7e9e">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[4/6]</span></h2>
  822. <div class="memitem">
  823. <div class="memproto">
  824. <table class="mlabels">
  825. <tr>
  826. <td class="mlabels-left">
  827. <table class="memname">
  828. <tr>
  829. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  830. <td>(</td>
  831. <td class="paramtype">Print *&#160;</td>
  832. <td class="paramname"><em>pr</em>, </td>
  833. </tr>
  834. <tr>
  835. <td class="paramkey"></td>
  836. <td></td>
  837. <td class="paramtype">char const *&#160;</td>
  838. <td class="paramname"><em>msg</em>&#160;</td>
  839. </tr>
  840. <tr>
  841. <td></td>
  842. <td>)</td>
  843. <td></td><td></td>
  844. </tr>
  845. </table>
  846. </td>
  847. <td class="mlabels-right">
  848. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  849. </tr>
  850. </table>
  851. </div><div class="memdoc">
  852. <p>Print msg, any SD error code, and halt.</p>
  853. <dl class="params"><dt>Parameters</dt><dd>
  854. <table class="params">
  855. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  856. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  857. </table>
  858. </dd>
  859. </dl>
  860. </div>
  861. </div>
  862. <a id="af856494745a9842d9728dfeabf19c51e"></a>
  863. <h2 class="memtitle"><span class="permalink"><a href="#af856494745a9842d9728dfeabf19c51e">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[5/6]</span></h2>
  864. <div class="memitem">
  865. <div class="memproto">
  866. <table class="mlabels">
  867. <tr>
  868. <td class="mlabels-left">
  869. <table class="memname">
  870. <tr>
  871. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  872. <td>(</td>
  873. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  874. <td class="paramname"><em>msg</em></td><td>)</td>
  875. <td></td>
  876. </tr>
  877. </table>
  878. </td>
  879. <td class="mlabels-right">
  880. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  881. </tr>
  882. </table>
  883. </div><div class="memdoc">
  884. <p>Print msg, any SD error code, and halt.</p>
  885. <dl class="params"><dt>Parameters</dt><dd>
  886. <table class="params">
  887. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  888. </table>
  889. </dd>
  890. </dl>
  891. </div>
  892. </div>
  893. <a id="a746c80d048c30baf0b281e16932670a2"></a>
  894. <h2 class="memtitle"><span class="permalink"><a href="#a746c80d048c30baf0b281e16932670a2">&#9670;&nbsp;</a></span>errorHalt() <span class="overload">[6/6]</span></h2>
  895. <div class="memitem">
  896. <div class="memproto">
  897. <table class="mlabels">
  898. <tr>
  899. <td class="mlabels-left">
  900. <table class="memname">
  901. <tr>
  902. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorHalt </td>
  903. <td>(</td>
  904. <td class="paramtype">Print *&#160;</td>
  905. <td class="paramname"><em>pr</em>, </td>
  906. </tr>
  907. <tr>
  908. <td class="paramkey"></td>
  909. <td></td>
  910. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  911. <td class="paramname"><em>msg</em>&#160;</td>
  912. </tr>
  913. <tr>
  914. <td></td>
  915. <td>)</td>
  916. <td></td><td></td>
  917. </tr>
  918. </table>
  919. </td>
  920. <td class="mlabels-right">
  921. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  922. </tr>
  923. </table>
  924. </div><div class="memdoc">
  925. <p>Print msg, any SD error code, and halt.</p>
  926. <dl class="params"><dt>Parameters</dt><dd>
  927. <table class="params">
  928. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  929. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  930. </table>
  931. </dd>
  932. </dl>
  933. </div>
  934. </div>
  935. <a id="ab0b78154d6874c29279ba81f36ccb09c"></a>
  936. <h2 class="memtitle"><span class="permalink"><a href="#ab0b78154d6874c29279ba81f36ccb09c">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[1/6]</span></h2>
  937. <div class="memitem">
  938. <div class="memproto">
  939. <table class="mlabels">
  940. <tr>
  941. <td class="mlabels-left">
  942. <table class="memname">
  943. <tr>
  944. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  945. <td>(</td>
  946. <td class="paramname"></td><td>)</td>
  947. <td></td>
  948. </tr>
  949. </table>
  950. </td>
  951. <td class="mlabels-right">
  952. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  953. </tr>
  954. </table>
  955. </div><div class="memdoc">
  956. <p>Print any SD error code to Serial </p>
  957. </div>
  958. </div>
  959. <a id="a03736274debea71fef5e2ff34d7ec3dc"></a>
  960. <h2 class="memtitle"><span class="permalink"><a href="#a03736274debea71fef5e2ff34d7ec3dc">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[2/6]</span></h2>
  961. <div class="memitem">
  962. <div class="memproto">
  963. <table class="mlabels">
  964. <tr>
  965. <td class="mlabels-left">
  966. <table class="memname">
  967. <tr>
  968. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  969. <td>(</td>
  970. <td class="paramtype">Print *&#160;</td>
  971. <td class="paramname"><em>pr</em></td><td>)</td>
  972. <td></td>
  973. </tr>
  974. </table>
  975. </td>
  976. <td class="mlabels-right">
  977. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  978. </tr>
  979. </table>
  980. </div><div class="memdoc">
  981. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  982. <table class="params">
  983. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  984. </table>
  985. </dd>
  986. </dl>
  987. </div>
  988. </div>
  989. <a id="a2e2436b7b2666737cbaf4b22218bc69f"></a>
  990. <h2 class="memtitle"><span class="permalink"><a href="#a2e2436b7b2666737cbaf4b22218bc69f">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[3/6]</span></h2>
  991. <div class="memitem">
  992. <div class="memproto">
  993. <table class="mlabels">
  994. <tr>
  995. <td class="mlabels-left">
  996. <table class="memname">
  997. <tr>
  998. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  999. <td>(</td>
  1000. <td class="paramtype">const char *&#160;</td>
  1001. <td class="paramname"><em>msg</em></td><td>)</td>
  1002. <td></td>
  1003. </tr>
  1004. </table>
  1005. </td>
  1006. <td class="mlabels-right">
  1007. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1008. </tr>
  1009. </table>
  1010. </div><div class="memdoc">
  1011. <p>Print msg, any SD error code.</p>
  1012. <dl class="params"><dt>Parameters</dt><dd>
  1013. <table class="params">
  1014. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1015. </table>
  1016. </dd>
  1017. </dl>
  1018. </div>
  1019. </div>
  1020. <a id="a0eb6b92a0700ba932f6127962981d153"></a>
  1021. <h2 class="memtitle"><span class="permalink"><a href="#a0eb6b92a0700ba932f6127962981d153">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[4/6]</span></h2>
  1022. <div class="memitem">
  1023. <div class="memproto">
  1024. <table class="mlabels">
  1025. <tr>
  1026. <td class="mlabels-left">
  1027. <table class="memname">
  1028. <tr>
  1029. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  1030. <td>(</td>
  1031. <td class="paramtype">Print *&#160;</td>
  1032. <td class="paramname"><em>pr</em>, </td>
  1033. </tr>
  1034. <tr>
  1035. <td class="paramkey"></td>
  1036. <td></td>
  1037. <td class="paramtype">char const *&#160;</td>
  1038. <td class="paramname"><em>msg</em>&#160;</td>
  1039. </tr>
  1040. <tr>
  1041. <td></td>
  1042. <td>)</td>
  1043. <td></td><td></td>
  1044. </tr>
  1045. </table>
  1046. </td>
  1047. <td class="mlabels-right">
  1048. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1049. </tr>
  1050. </table>
  1051. </div><div class="memdoc">
  1052. <p>Print msg, any SD error code.</p>
  1053. <dl class="params"><dt>Parameters</dt><dd>
  1054. <table class="params">
  1055. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1056. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1057. </table>
  1058. </dd>
  1059. </dl>
  1060. </div>
  1061. </div>
  1062. <a id="a1ccb1f937f42e9c1331c942bc357f6da"></a>
  1063. <h2 class="memtitle"><span class="permalink"><a href="#a1ccb1f937f42e9c1331c942bc357f6da">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[5/6]</span></h2>
  1064. <div class="memitem">
  1065. <div class="memproto">
  1066. <table class="mlabels">
  1067. <tr>
  1068. <td class="mlabels-left">
  1069. <table class="memname">
  1070. <tr>
  1071. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  1072. <td>(</td>
  1073. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1074. <td class="paramname"><em>msg</em></td><td>)</td>
  1075. <td></td>
  1076. </tr>
  1077. </table>
  1078. </td>
  1079. <td class="mlabels-right">
  1080. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1081. </tr>
  1082. </table>
  1083. </div><div class="memdoc">
  1084. <p>Print msg, any SD error code.</p>
  1085. <dl class="params"><dt>Parameters</dt><dd>
  1086. <table class="params">
  1087. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1088. </table>
  1089. </dd>
  1090. </dl>
  1091. </div>
  1092. </div>
  1093. <a id="a43344a079d9af92ea4b550914d0512f6"></a>
  1094. <h2 class="memtitle"><span class="permalink"><a href="#a43344a079d9af92ea4b550914d0512f6">&#9670;&nbsp;</a></span>errorPrint() <span class="overload">[6/6]</span></h2>
  1095. <div class="memitem">
  1096. <div class="memproto">
  1097. <table class="mlabels">
  1098. <tr>
  1099. <td class="mlabels-left">
  1100. <table class="memname">
  1101. <tr>
  1102. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::errorPrint </td>
  1103. <td>(</td>
  1104. <td class="paramtype">Print *&#160;</td>
  1105. <td class="paramname"><em>pr</em>, </td>
  1106. </tr>
  1107. <tr>
  1108. <td class="paramkey"></td>
  1109. <td></td>
  1110. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1111. <td class="paramname"><em>msg</em>&#160;</td>
  1112. </tr>
  1113. <tr>
  1114. <td></td>
  1115. <td>)</td>
  1116. <td></td><td></td>
  1117. </tr>
  1118. </table>
  1119. </td>
  1120. <td class="mlabels-right">
  1121. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1122. </tr>
  1123. </table>
  1124. </div><div class="memdoc">
  1125. <p>Print msg, any SD error code.</p>
  1126. <dl class="params"><dt>Parameters</dt><dd>
  1127. <table class="params">
  1128. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1129. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1130. </table>
  1131. </dd>
  1132. </dl>
  1133. </div>
  1134. </div>
  1135. <a id="aee58c6352652f216577196e32a594b67"></a>
  1136. <h2 class="memtitle"><span class="permalink"><a href="#aee58c6352652f216577196e32a594b67">&#9670;&nbsp;</a></span>exists()</h2>
  1137. <div class="memitem">
  1138. <div class="memproto">
  1139. <table class="mlabels">
  1140. <tr>
  1141. <td class="mlabels-left">
  1142. <table class="memname">
  1143. <tr>
  1144. <td class="memname">bool FatFileSystem::exists </td>
  1145. <td>(</td>
  1146. <td class="paramtype">const char *&#160;</td>
  1147. <td class="paramname"><em>path</em></td><td>)</td>
  1148. <td></td>
  1149. </tr>
  1150. </table>
  1151. </td>
  1152. <td class="mlabels-right">
  1153. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1154. </tr>
  1155. </table>
  1156. </div><div class="memdoc">
  1157. <p>Test for the existence of a file.</p>
  1158. <dl class="params"><dt>Parameters</dt><dd>
  1159. <table class="params">
  1160. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  1161. </table>
  1162. </dd>
  1163. </dl>
  1164. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  1165. </div>
  1166. </div>
  1167. <a id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  1168. <h2 class="memtitle"><span class="permalink"><a href="#acdedc6a200b01e401c9cd9b511eae6ec">&#9670;&nbsp;</a></span>fatCount()</h2>
  1169. <div class="memitem">
  1170. <div class="memproto">
  1171. <table class="mlabels">
  1172. <tr>
  1173. <td class="mlabels-left">
  1174. <table class="memname">
  1175. <tr>
  1176. <td class="memname">uint8_t FatVolume::fatCount </td>
  1177. <td>(</td>
  1178. <td class="paramname"></td><td>)</td>
  1179. <td></td>
  1180. </tr>
  1181. </table>
  1182. </td>
  1183. <td class="mlabels-right">
  1184. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1185. </tr>
  1186. </table>
  1187. </div><div class="memdoc">
  1188. <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Allocation Tables. </dd></dl>
  1189. </div>
  1190. </div>
  1191. <a id="a260bc030ab188a481dd34d6062f7b9d2"></a>
  1192. <h2 class="memtitle"><span class="permalink"><a href="#a260bc030ab188a481dd34d6062f7b9d2">&#9670;&nbsp;</a></span>fatStartBlock()</h2>
  1193. <div class="memitem">
  1194. <div class="memproto">
  1195. <table class="mlabels">
  1196. <tr>
  1197. <td class="mlabels-left">
  1198. <table class="memname">
  1199. <tr>
  1200. <td class="memname">uint32_t FatVolume::fatStartBlock </td>
  1201. <td>(</td>
  1202. <td class="paramname"></td><td>)</td>
  1203. <td> const</td>
  1204. </tr>
  1205. </table>
  1206. </td>
  1207. <td class="mlabels-right">
  1208. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1209. </tr>
  1210. </table>
  1211. </div><div class="memdoc">
  1212. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  1213. </div>
  1214. </div>
  1215. <a id="a0d736f0e8f03476b896307fbe5427376"></a>
  1216. <h2 class="memtitle"><span class="permalink"><a href="#a0d736f0e8f03476b896307fbe5427376">&#9670;&nbsp;</a></span>fatType()</h2>
  1217. <div class="memitem">
  1218. <div class="memproto">
  1219. <table class="mlabels">
  1220. <tr>
  1221. <td class="mlabels-left">
  1222. <table class="memname">
  1223. <tr>
  1224. <td class="memname">uint8_t FatVolume::fatType </td>
  1225. <td>(</td>
  1226. <td class="paramname"></td><td>)</td>
  1227. <td> const</td>
  1228. </tr>
  1229. </table>
  1230. </td>
  1231. <td class="mlabels-right">
  1232. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1233. </tr>
  1234. </table>
  1235. </div><div class="memdoc">
  1236. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  1237. </div>
  1238. </div>
  1239. <a id="a1683b063fc6202ab85470b9610f16f93"></a>
  1240. <h2 class="memtitle"><span class="permalink"><a href="#a1683b063fc6202ab85470b9610f16f93">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  1241. <div class="memitem">
  1242. <div class="memproto">
  1243. <table class="mlabels">
  1244. <tr>
  1245. <td class="mlabels-left">
  1246. <table class="memname">
  1247. <tr>
  1248. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  1249. <td>(</td>
  1250. <td class="paramname"></td><td>)</td>
  1251. <td></td>
  1252. </tr>
  1253. </table>
  1254. </td>
  1255. <td class="mlabels-right">
  1256. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1257. </tr>
  1258. </table>
  1259. </div><div class="memdoc">
  1260. <p>Volume free space in clusters.</p>
  1261. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  1262. </div>
  1263. </div>
  1264. <a id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  1265. <h2 class="memtitle"><span class="permalink"><a href="#acab819fa25a91dad1cc698a7e1e0eb32">&#9670;&nbsp;</a></span>init() <span class="overload">[1/2]</span></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 FatVolume::init </td>
  1274. <td>(</td>
  1275. <td class="paramname"></td><td>)</td>
  1276. <td></td>
  1277. </tr>
  1278. </table>
  1279. </td>
  1280. <td class="mlabels-right">
  1281. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1282. </tr>
  1283. </table>
  1284. </div><div class="memdoc">
  1285. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  1286. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1287. </div>
  1288. </div>
  1289. <a id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  1290. <h2 class="memtitle"><span class="permalink"><a href="#a034d997a1e7a0b2b664a4357bcccd256">&#9670;&nbsp;</a></span>init() <span class="overload">[2/2]</span></h2>
  1291. <div class="memitem">
  1292. <div class="memproto">
  1293. <table class="mlabels">
  1294. <tr>
  1295. <td class="mlabels-left">
  1296. <table class="memname">
  1297. <tr>
  1298. <td class="memname">bool FatVolume::init </td>
  1299. <td>(</td>
  1300. <td class="paramtype">uint8_t&#160;</td>
  1301. <td class="paramname"><em>part</em></td><td>)</td>
  1302. <td></td>
  1303. </tr>
  1304. </table>
  1305. </td>
  1306. <td class="mlabels-right">
  1307. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1308. </tr>
  1309. </table>
  1310. </div><div class="memdoc">
  1311. <p>Initialize a FAT volume.</p>
  1312. <dl class="params"><dt>Parameters</dt><dd>
  1313. <table class="params">
  1314. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in block zero.</td></tr>
  1315. </table>
  1316. </dd>
  1317. </dl>
  1318. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1319. </div>
  1320. </div>
  1321. <a id="a8e1f26486bb878a24fa9868e59dbbbc2"></a>
  1322. <h2 class="memtitle"><span class="permalink"><a href="#a8e1f26486bb878a24fa9868e59dbbbc2">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[1/6]</span></h2>
  1323. <div class="memitem">
  1324. <div class="memproto">
  1325. <table class="mlabels">
  1326. <tr>
  1327. <td class="mlabels-left">
  1328. <table class="memname">
  1329. <tr>
  1330. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1331. <td>(</td>
  1332. <td class="paramname"></td><td>)</td>
  1333. <td></td>
  1334. </tr>
  1335. </table>
  1336. </td>
  1337. <td class="mlabels-right">
  1338. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1339. </tr>
  1340. </table>
  1341. </div><div class="memdoc">
  1342. <p>Print any SD error code and halt. </p>
  1343. </div>
  1344. </div>
  1345. <a id="a24bd0f699cf0fe11fd2148b15c49251a"></a>
  1346. <h2 class="memtitle"><span class="permalink"><a href="#a24bd0f699cf0fe11fd2148b15c49251a">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[2/6]</span></h2>
  1347. <div class="memitem">
  1348. <div class="memproto">
  1349. <table class="mlabels">
  1350. <tr>
  1351. <td class="mlabels-left">
  1352. <table class="memname">
  1353. <tr>
  1354. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1355. <td>(</td>
  1356. <td class="paramtype">Print *&#160;</td>
  1357. <td class="paramname"><em>pr</em></td><td>)</td>
  1358. <td></td>
  1359. </tr>
  1360. </table>
  1361. </td>
  1362. <td class="mlabels-right">
  1363. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1364. </tr>
  1365. </table>
  1366. </div><div class="memdoc">
  1367. <p>Print error details and halt after begin fails.</p>
  1368. <dl class="params"><dt>Parameters</dt><dd>
  1369. <table class="params">
  1370. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1371. </table>
  1372. </dd>
  1373. </dl>
  1374. </div>
  1375. </div>
  1376. <a id="a893833a880e2a83757480ba4c1351041"></a>
  1377. <h2 class="memtitle"><span class="permalink"><a href="#a893833a880e2a83757480ba4c1351041">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[3/6]</span></h2>
  1378. <div class="memitem">
  1379. <div class="memproto">
  1380. <table class="mlabels">
  1381. <tr>
  1382. <td class="mlabels-left">
  1383. <table class="memname">
  1384. <tr>
  1385. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1386. <td>(</td>
  1387. <td class="paramtype">char const *&#160;</td>
  1388. <td class="paramname"><em>msg</em></td><td>)</td>
  1389. <td></td>
  1390. </tr>
  1391. </table>
  1392. </td>
  1393. <td class="mlabels-right">
  1394. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1395. </tr>
  1396. </table>
  1397. </div><div class="memdoc">
  1398. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1399. <dl class="params"><dt>Parameters</dt><dd>
  1400. <table class="params">
  1401. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1402. </table>
  1403. </dd>
  1404. </dl>
  1405. </div>
  1406. </div>
  1407. <a id="a3077b1a53d789d0401b707963cb28f46"></a>
  1408. <h2 class="memtitle"><span class="permalink"><a href="#a3077b1a53d789d0401b707963cb28f46">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[4/6]</span></h2>
  1409. <div class="memitem">
  1410. <div class="memproto">
  1411. <table class="mlabels">
  1412. <tr>
  1413. <td class="mlabels-left">
  1414. <table class="memname">
  1415. <tr>
  1416. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1417. <td>(</td>
  1418. <td class="paramtype">Print *&#160;</td>
  1419. <td class="paramname"><em>pr</em>, </td>
  1420. </tr>
  1421. <tr>
  1422. <td class="paramkey"></td>
  1423. <td></td>
  1424. <td class="paramtype">char const *&#160;</td>
  1425. <td class="paramname"><em>msg</em>&#160;</td>
  1426. </tr>
  1427. <tr>
  1428. <td></td>
  1429. <td>)</td>
  1430. <td></td><td></td>
  1431. </tr>
  1432. </table>
  1433. </td>
  1434. <td class="mlabels-right">
  1435. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1436. </tr>
  1437. </table>
  1438. </div><div class="memdoc">
  1439. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1440. <table class="params">
  1441. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  1442. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1443. </table>
  1444. </dd>
  1445. </dl>
  1446. </div>
  1447. </div>
  1448. <a id="a2a1e4cc8056ba23b55dfa2c6486b8798"></a>
  1449. <h2 class="memtitle"><span class="permalink"><a href="#a2a1e4cc8056ba23b55dfa2c6486b8798">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[5/6]</span></h2>
  1450. <div class="memitem">
  1451. <div class="memproto">
  1452. <table class="mlabels">
  1453. <tr>
  1454. <td class="mlabels-left">
  1455. <table class="memname">
  1456. <tr>
  1457. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1458. <td>(</td>
  1459. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1460. <td class="paramname"><em>msg</em></td><td>)</td>
  1461. <td></td>
  1462. </tr>
  1463. </table>
  1464. </td>
  1465. <td class="mlabels-right">
  1466. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1467. </tr>
  1468. </table>
  1469. </div><div class="memdoc">
  1470. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1471. <dl class="params"><dt>Parameters</dt><dd>
  1472. <table class="params">
  1473. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1474. </table>
  1475. </dd>
  1476. </dl>
  1477. </div>
  1478. </div>
  1479. <a id="ab03d98012dea18733c3252f27832de69"></a>
  1480. <h2 class="memtitle"><span class="permalink"><a href="#ab03d98012dea18733c3252f27832de69">&#9670;&nbsp;</a></span>initErrorHalt() <span class="overload">[6/6]</span></h2>
  1481. <div class="memitem">
  1482. <div class="memproto">
  1483. <table class="mlabels">
  1484. <tr>
  1485. <td class="mlabels-left">
  1486. <table class="memname">
  1487. <tr>
  1488. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorHalt </td>
  1489. <td>(</td>
  1490. <td class="paramtype">Print *&#160;</td>
  1491. <td class="paramname"><em>pr</em>, </td>
  1492. </tr>
  1493. <tr>
  1494. <td class="paramkey"></td>
  1495. <td></td>
  1496. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1497. <td class="paramname"><em>msg</em>&#160;</td>
  1498. </tr>
  1499. <tr>
  1500. <td></td>
  1501. <td>)</td>
  1502. <td></td><td></td>
  1503. </tr>
  1504. </table>
  1505. </td>
  1506. <td class="mlabels-right">
  1507. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1508. </tr>
  1509. </table>
  1510. </div><div class="memdoc">
  1511. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1512. <table class="params">
  1513. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>
  1514. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1515. </table>
  1516. </dd>
  1517. </dl>
  1518. </div>
  1519. </div>
  1520. <a id="ae31c9cbd7e1c03129d6c99b25f73cd50"></a>
  1521. <h2 class="memtitle"><span class="permalink"><a href="#ae31c9cbd7e1c03129d6c99b25f73cd50">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[1/6]</span></h2>
  1522. <div class="memitem">
  1523. <div class="memproto">
  1524. <table class="mlabels">
  1525. <tr>
  1526. <td class="mlabels-left">
  1527. <table class="memname">
  1528. <tr>
  1529. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1530. <td>(</td>
  1531. <td class="paramname"></td><td>)</td>
  1532. <td></td>
  1533. </tr>
  1534. </table>
  1535. </td>
  1536. <td class="mlabels-right">
  1537. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1538. </tr>
  1539. </table>
  1540. </div><div class="memdoc">
  1541. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p>
  1542. </div>
  1543. </div>
  1544. <a id="a066707dce0667213b5f083d59f67448d"></a>
  1545. <h2 class="memtitle"><span class="permalink"><a href="#a066707dce0667213b5f083d59f67448d">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[2/6]</span></h2>
  1546. <div class="memitem">
  1547. <div class="memproto">
  1548. <table class="mlabels">
  1549. <tr>
  1550. <td class="mlabels-left">
  1551. <table class="memname">
  1552. <tr>
  1553. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1554. <td>(</td>
  1555. <td class="paramtype">Print *&#160;</td>
  1556. <td class="paramname"><em>pr</em></td><td>)</td>
  1557. <td></td>
  1558. </tr>
  1559. </table>
  1560. </td>
  1561. <td class="mlabels-right">
  1562. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1563. </tr>
  1564. </table>
  1565. </div><div class="memdoc">
  1566. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1567. <dl class="params"><dt>Parameters</dt><dd>
  1568. <table class="params">
  1569. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1570. </table>
  1571. </dd>
  1572. </dl>
  1573. </div>
  1574. </div>
  1575. <a id="a538796f79fd9db9c5bbeefd9defe639a"></a>
  1576. <h2 class="memtitle"><span class="permalink"><a href="#a538796f79fd9db9c5bbeefd9defe639a">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[3/6]</span></h2>
  1577. <div class="memitem">
  1578. <div class="memproto">
  1579. <table class="mlabels">
  1580. <tr>
  1581. <td class="mlabels-left">
  1582. <table class="memname">
  1583. <tr>
  1584. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1585. <td>(</td>
  1586. <td class="paramtype">char const *&#160;</td>
  1587. <td class="paramname"><em>msg</em></td><td>)</td>
  1588. <td></td>
  1589. </tr>
  1590. </table>
  1591. </td>
  1592. <td class="mlabels-right">
  1593. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1594. </tr>
  1595. </table>
  1596. </div><div class="memdoc">
  1597. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1598. <dl class="params"><dt>Parameters</dt><dd>
  1599. <table class="params">
  1600. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1601. </table>
  1602. </dd>
  1603. </dl>
  1604. </div>
  1605. </div>
  1606. <a id="ad9855d33ebd465715b706d0926291b13"></a>
  1607. <h2 class="memtitle"><span class="permalink"><a href="#ad9855d33ebd465715b706d0926291b13">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[4/6]</span></h2>
  1608. <div class="memitem">
  1609. <div class="memproto">
  1610. <table class="mlabels">
  1611. <tr>
  1612. <td class="mlabels-left">
  1613. <table class="memname">
  1614. <tr>
  1615. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1616. <td>(</td>
  1617. <td class="paramtype">Print *&#160;</td>
  1618. <td class="paramname"><em>pr</em>, </td>
  1619. </tr>
  1620. <tr>
  1621. <td class="paramkey"></td>
  1622. <td></td>
  1623. <td class="paramtype">char const *&#160;</td>
  1624. <td class="paramname"><em>msg</em>&#160;</td>
  1625. </tr>
  1626. <tr>
  1627. <td></td>
  1628. <td>)</td>
  1629. <td></td><td></td>
  1630. </tr>
  1631. </table>
  1632. </td>
  1633. <td class="mlabels-right">
  1634. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1635. </tr>
  1636. </table>
  1637. </div><div class="memdoc">
  1638. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1639. <dl class="params"><dt>Parameters</dt><dd>
  1640. <table class="params">
  1641. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1642. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1643. </table>
  1644. </dd>
  1645. </dl>
  1646. </div>
  1647. </div>
  1648. <a id="ad6ffec5a7d82be46d46b8a4f82d0803b"></a>
  1649. <h2 class="memtitle"><span class="permalink"><a href="#ad6ffec5a7d82be46d46b8a4f82d0803b">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[5/6]</span></h2>
  1650. <div class="memitem">
  1651. <div class="memproto">
  1652. <table class="mlabels">
  1653. <tr>
  1654. <td class="mlabels-left">
  1655. <table class="memname">
  1656. <tr>
  1657. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1658. <td>(</td>
  1659. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1660. <td class="paramname"><em>msg</em></td><td>)</td>
  1661. <td></td>
  1662. </tr>
  1663. </table>
  1664. </td>
  1665. <td class="mlabels-right">
  1666. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1667. </tr>
  1668. </table>
  1669. </div><div class="memdoc">
  1670. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1671. <dl class="params"><dt>Parameters</dt><dd>
  1672. <table class="params">
  1673. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1674. </table>
  1675. </dd>
  1676. </dl>
  1677. </div>
  1678. </div>
  1679. <a id="a8a2018b6366145a9843d3d29a47d6560"></a>
  1680. <h2 class="memtitle"><span class="permalink"><a href="#a8a2018b6366145a9843d3d29a47d6560">&#9670;&nbsp;</a></span>initErrorPrint() <span class="overload">[6/6]</span></h2>
  1681. <div class="memitem">
  1682. <div class="memproto">
  1683. <table class="mlabels">
  1684. <tr>
  1685. <td class="mlabels-left">
  1686. <table class="memname">
  1687. <tr>
  1688. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card_e_x.html">SdSpiCardEX</a> &gt;::initErrorPrint </td>
  1689. <td>(</td>
  1690. <td class="paramtype">Print *&#160;</td>
  1691. <td class="paramname"><em>pr</em>, </td>
  1692. </tr>
  1693. <tr>
  1694. <td class="paramkey"></td>
  1695. <td></td>
  1696. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1697. <td class="paramname"><em>msg</em>&#160;</td>
  1698. </tr>
  1699. <tr>
  1700. <td></td>
  1701. <td>)</td>
  1702. <td></td><td></td>
  1703. </tr>
  1704. </table>
  1705. </td>
  1706. <td class="mlabels-right">
  1707. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1708. </tr>
  1709. </table>
  1710. </div><div class="memdoc">
  1711. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1712. <dl class="params"><dt>Parameters</dt><dd>
  1713. <table class="params">
  1714. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1715. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1716. </table>
  1717. </dd>
  1718. </dl>
  1719. </div>
  1720. </div>
  1721. <a id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>
  1722. <h2 class="memtitle"><span class="permalink"><a href="#a2398fb37a7a9d5e0dc0ffde6a44a993d">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/4]</span></h2>
  1723. <div class="memitem">
  1724. <div class="memproto">
  1725. <table class="mlabels">
  1726. <tr>
  1727. <td class="mlabels-left">
  1728. <table class="memname">
  1729. <tr>
  1730. <td class="memname">void FatFileSystem::ls </td>
  1731. <td>(</td>
  1732. <td class="paramtype">uint8_t&#160;</td>
  1733. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1734. <td></td>
  1735. </tr>
  1736. </table>
  1737. </td>
  1738. <td class="mlabels-right">
  1739. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1740. </tr>
  1741. </table>
  1742. </div><div class="memdoc">
  1743. <p>List the directory contents of the volume working directory to Serial.</p>
  1744. <dl class="params"><dt>Parameters</dt><dd>
  1745. <table class="params">
  1746. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1747. </table>
  1748. </dd>
  1749. </dl>
  1750. <p>LS_DATE - Print file modification date</p>
  1751. <p>LS_SIZE - Print file size.</p>
  1752. <p>LS_R - Recursive list of subdirectories. </p>
  1753. </div>
  1754. </div>
  1755. <a id="a122b61dbec5051304bcc81bc08b1b99d"></a>
  1756. <h2 class="memtitle"><span class="permalink"><a href="#a122b61dbec5051304bcc81bc08b1b99d">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/4]</span></h2>
  1757. <div class="memitem">
  1758. <div class="memproto">
  1759. <table class="mlabels">
  1760. <tr>
  1761. <td class="mlabels-left">
  1762. <table class="memname">
  1763. <tr>
  1764. <td class="memname">void FatFileSystem::ls </td>
  1765. <td>(</td>
  1766. <td class="paramtype">const char *&#160;</td>
  1767. <td class="paramname"><em>path</em>, </td>
  1768. </tr>
  1769. <tr>
  1770. <td class="paramkey"></td>
  1771. <td></td>
  1772. <td class="paramtype">uint8_t&#160;</td>
  1773. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1774. </tr>
  1775. <tr>
  1776. <td></td>
  1777. <td>)</td>
  1778. <td></td><td></td>
  1779. </tr>
  1780. </table>
  1781. </td>
  1782. <td class="mlabels-right">
  1783. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1784. </tr>
  1785. </table>
  1786. </div><div class="memdoc">
  1787. <p>List the directory contents of a directory to Serial.</p>
  1788. <dl class="params"><dt>Parameters</dt><dd>
  1789. <table class="params">
  1790. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1791. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1792. </table>
  1793. </dd>
  1794. </dl>
  1795. <p>LS_DATE - Print file modification date</p>
  1796. <p>LS_SIZE - Print file size.</p>
  1797. <p>LS_R - Recursive list of subdirectories. </p>
  1798. </div>
  1799. </div>
  1800. <a id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>
  1801. <h2 class="memtitle"><span class="permalink"><a href="#ae12fb8bfad5c4a8e052dda70a5a0ed93">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/4]</span></h2>
  1802. <div class="memitem">
  1803. <div class="memproto">
  1804. <table class="mlabels">
  1805. <tr>
  1806. <td class="mlabels-left">
  1807. <table class="memname">
  1808. <tr>
  1809. <td class="memname">void FatFileSystem::ls </td>
  1810. <td>(</td>
  1811. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1812. <td class="paramname"><em>pr</em>, </td>
  1813. </tr>
  1814. <tr>
  1815. <td class="paramkey"></td>
  1816. <td></td>
  1817. <td class="paramtype">uint8_t&#160;</td>
  1818. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1819. </tr>
  1820. <tr>
  1821. <td></td>
  1822. <td>)</td>
  1823. <td></td><td></td>
  1824. </tr>
  1825. </table>
  1826. </td>
  1827. <td class="mlabels-right">
  1828. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1829. </tr>
  1830. </table>
  1831. </div><div class="memdoc">
  1832. <p>List the directory contents of the volume working directory.</p>
  1833. <dl class="params"><dt>Parameters</dt><dd>
  1834. <table class="params">
  1835. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1836. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1837. </table>
  1838. </dd>
  1839. </dl>
  1840. <p>LS_DATE - Print file modification date</p>
  1841. <p>LS_SIZE - Print file size.</p>
  1842. <p>LS_R - Recursive list of subdirectories. </p>
  1843. </div>
  1844. </div>
  1845. <a id="aa79695db8e910300507210b3067d39fd"></a>
  1846. <h2 class="memtitle"><span class="permalink"><a href="#aa79695db8e910300507210b3067d39fd">&#9670;&nbsp;</a></span>ls() <span class="overload">[4/4]</span></h2>
  1847. <div class="memitem">
  1848. <div class="memproto">
  1849. <table class="mlabels">
  1850. <tr>
  1851. <td class="mlabels-left">
  1852. <table class="memname">
  1853. <tr>
  1854. <td class="memname">void FatFileSystem::ls </td>
  1855. <td>(</td>
  1856. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1857. <td class="paramname"><em>pr</em>, </td>
  1858. </tr>
  1859. <tr>
  1860. <td class="paramkey"></td>
  1861. <td></td>
  1862. <td class="paramtype">const char *&#160;</td>
  1863. <td class="paramname"><em>path</em>, </td>
  1864. </tr>
  1865. <tr>
  1866. <td class="paramkey"></td>
  1867. <td></td>
  1868. <td class="paramtype">uint8_t&#160;</td>
  1869. <td class="paramname"><em>flags</em>&#160;</td>
  1870. </tr>
  1871. <tr>
  1872. <td></td>
  1873. <td>)</td>
  1874. <td></td><td></td>
  1875. </tr>
  1876. </table>
  1877. </td>
  1878. <td class="mlabels-right">
  1879. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1880. </tr>
  1881. </table>
  1882. </div><div class="memdoc">
  1883. <p>List the directory contents of 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">pr</td><td>Print stream for list.</td></tr>
  1887. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1888. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1889. </table>
  1890. </dd>
  1891. </dl>
  1892. <p>LS_DATE - Print file modification date</p>
  1893. <p>LS_SIZE - Print file size.</p>
  1894. <p>LS_R - Recursive list of subdirectories. </p>
  1895. </div>
  1896. </div>
  1897. <a id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  1898. <h2 class="memtitle"><span class="permalink"><a href="#a231c62c98ba8ac3c2624dc5ad2053ebf">&#9670;&nbsp;</a></span>mkdir()</h2>
  1899. <div class="memitem">
  1900. <div class="memproto">
  1901. <table class="mlabels">
  1902. <tr>
  1903. <td class="mlabels-left">
  1904. <table class="memname">
  1905. <tr>
  1906. <td class="memname">bool FatFileSystem::mkdir </td>
  1907. <td>(</td>
  1908. <td class="paramtype">const char *&#160;</td>
  1909. <td class="paramname"><em>path</em>, </td>
  1910. </tr>
  1911. <tr>
  1912. <td class="paramkey"></td>
  1913. <td></td>
  1914. <td class="paramtype">bool&#160;</td>
  1915. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1916. </tr>
  1917. <tr>
  1918. <td></td>
  1919. <td>)</td>
  1920. <td></td><td></td>
  1921. </tr>
  1922. </table>
  1923. </td>
  1924. <td class="mlabels-right">
  1925. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1926. </tr>
  1927. </table>
  1928. </div><div class="memdoc">
  1929. <p>Make a subdirectory in the volume working directory.</p>
  1930. <dl class="params"><dt>Parameters</dt><dd>
  1931. <table class="params">
  1932. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  1933. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1934. </table>
  1935. </dd>
  1936. </dl>
  1937. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1938. </div>
  1939. </div>
  1940. <a id="a1590dbde58cf1622a18d1350058a6e18"></a>
  1941. <h2 class="memtitle"><span class="permalink"><a href="#a1590dbde58cf1622a18d1350058a6e18">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>
  1942. <div class="memitem">
  1943. <div class="memproto">
  1944. <table class="mlabels">
  1945. <tr>
  1946. <td class="mlabels-left">
  1947. <table class="memname">
  1948. <tr>
  1949. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1950. <td>(</td>
  1951. <td class="paramtype">const char *&#160;</td>
  1952. <td class="paramname"><em>path</em>, </td>
  1953. </tr>
  1954. <tr>
  1955. <td class="paramkey"></td>
  1956. <td></td>
  1957. <td class="paramtype">oflag_t&#160;</td>
  1958. <td class="paramname"><em>oflag</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1959. </tr>
  1960. <tr>
  1961. <td></td>
  1962. <td>)</td>
  1963. <td></td><td></td>
  1964. </tr>
  1965. </table>
  1966. </td>
  1967. <td class="mlabels-right">
  1968. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1969. </tr>
  1970. </table>
  1971. </div><div class="memdoc">
  1972. <p>open a file</p>
  1973. <dl class="params"><dt>Parameters</dt><dd>
  1974. <table class="params">
  1975. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1976. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1977. </table>
  1978. </dd>
  1979. </dl>
  1980. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  1981. </div>
  1982. </div>
  1983. <a id="a7c44842544967e0083bec1a6089e5061"></a>
  1984. <h2 class="memtitle"><span class="permalink"><a href="#a7c44842544967e0083bec1a6089e5061">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>
  1985. <div class="memitem">
  1986. <div class="memproto">
  1987. <table class="mlabels">
  1988. <tr>
  1989. <td class="mlabels-left">
  1990. <table class="memname">
  1991. <tr>
  1992. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1993. <td>(</td>
  1994. <td class="paramtype">const String &amp;&#160;</td>
  1995. <td class="paramname"><em>path</em>, </td>
  1996. </tr>
  1997. <tr>
  1998. <td class="paramkey"></td>
  1999. <td></td>
  2000. <td class="paramtype">oflag_t&#160;</td>
  2001. <td class="paramname"><em>oflag</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  2002. </tr>
  2003. <tr>
  2004. <td></td>
  2005. <td>)</td>
  2006. <td></td><td></td>
  2007. </tr>
  2008. </table>
  2009. </td>
  2010. <td class="mlabels-right">
  2011. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2012. </tr>
  2013. </table>
  2014. </div><div class="memdoc">
  2015. <p>open a file</p>
  2016. <dl class="params"><dt>Parameters</dt><dd>
  2017. <table class="params">
  2018. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  2019. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  2020. </table>
  2021. </dd>
  2022. </dl>
  2023. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  2024. </div>
  2025. </div>
  2026. <a id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  2027. <h2 class="memtitle"><span class="permalink"><a href="#abf7d7d0dab43083d5be10d70ff4669e4">&#9670;&nbsp;</a></span>remove()</h2>
  2028. <div class="memitem">
  2029. <div class="memproto">
  2030. <table class="mlabels">
  2031. <tr>
  2032. <td class="mlabels-left">
  2033. <table class="memname">
  2034. <tr>
  2035. <td class="memname">bool FatFileSystem::remove </td>
  2036. <td>(</td>
  2037. <td class="paramtype">const char *&#160;</td>
  2038. <td class="paramname"><em>path</em></td><td>)</td>
  2039. <td></td>
  2040. </tr>
  2041. </table>
  2042. </td>
  2043. <td class="mlabels-right">
  2044. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2045. </tr>
  2046. </table>
  2047. </div><div class="memdoc">
  2048. <p>Remove a file from the volume working directory.</p>
  2049. <dl class="params"><dt>Parameters</dt><dd>
  2050. <table class="params">
  2051. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file.</td></tr>
  2052. </table>
  2053. </dd>
  2054. </dl>
  2055. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2056. </div>
  2057. </div>
  2058. <a id="a0187891a24017b41bd7c5ba63e659e65"></a>
  2059. <h2 class="memtitle"><span class="permalink"><a href="#a0187891a24017b41bd7c5ba63e659e65">&#9670;&nbsp;</a></span>rename()</h2>
  2060. <div class="memitem">
  2061. <div class="memproto">
  2062. <table class="mlabels">
  2063. <tr>
  2064. <td class="mlabels-left">
  2065. <table class="memname">
  2066. <tr>
  2067. <td class="memname">bool FatFileSystem::rename </td>
  2068. <td>(</td>
  2069. <td class="paramtype">const char *&#160;</td>
  2070. <td class="paramname"><em>oldPath</em>, </td>
  2071. </tr>
  2072. <tr>
  2073. <td class="paramkey"></td>
  2074. <td></td>
  2075. <td class="paramtype">const char *&#160;</td>
  2076. <td class="paramname"><em>newPath</em>&#160;</td>
  2077. </tr>
  2078. <tr>
  2079. <td></td>
  2080. <td>)</td>
  2081. <td></td><td></td>
  2082. </tr>
  2083. </table>
  2084. </td>
  2085. <td class="mlabels-right">
  2086. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2087. </tr>
  2088. </table>
  2089. </div><div class="memdoc">
  2090. <p>Rename a file or subdirectory.</p>
  2091. <dl class="params"><dt>Parameters</dt><dd>
  2092. <table class="params">
  2093. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  2094. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  2095. </table>
  2096. </dd>
  2097. </dl>
  2098. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  2099. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename()</a> call.</p>
  2100. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2101. </div>
  2102. </div>
  2103. <a id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  2104. <h2 class="memtitle"><span class="permalink"><a href="#aaed2edc7ff7fedb163458c870bb41b33">&#9670;&nbsp;</a></span>rmdir()</h2>
  2105. <div class="memitem">
  2106. <div class="memproto">
  2107. <table class="mlabels">
  2108. <tr>
  2109. <td class="mlabels-left">
  2110. <table class="memname">
  2111. <tr>
  2112. <td class="memname">bool FatFileSystem::rmdir </td>
  2113. <td>(</td>
  2114. <td class="paramtype">const char *&#160;</td>
  2115. <td class="paramname"><em>path</em></td><td>)</td>
  2116. <td></td>
  2117. </tr>
  2118. </table>
  2119. </td>
  2120. <td class="mlabels-right">
  2121. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2122. </tr>
  2123. </table>
  2124. </div><div class="memdoc">
  2125. <p>Remove a subdirectory from the volume's working directory.</p>
  2126. <dl class="params"><dt>Parameters</dt><dd>
  2127. <table class="params">
  2128. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  2129. </table>
  2130. </dd>
  2131. </dl>
  2132. <p>The subdirectory file will be removed only if it is empty.</p>
  2133. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2134. </div>
  2135. </div>
  2136. <a id="a31d0efaf3e47c9342da0dfb3735eecf1"></a>
  2137. <h2 class="memtitle"><span class="permalink"><a href="#a31d0efaf3e47c9342da0dfb3735eecf1">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>
  2138. <div class="memitem">
  2139. <div class="memproto">
  2140. <table class="mlabels">
  2141. <tr>
  2142. <td class="mlabels-left">
  2143. <table class="memname">
  2144. <tr>
  2145. <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>
  2146. <td>(</td>
  2147. <td class="paramname"></td><td>)</td>
  2148. <td> const</td>
  2149. </tr>
  2150. </table>
  2151. </td>
  2152. <td class="mlabels-right">
  2153. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2154. </tr>
  2155. </table>
  2156. </div><div class="memdoc">
  2157. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  2158. </div>
  2159. </div>
  2160. <a id="a372f1f1fab71f5744eaf538156abe64d"></a>
  2161. <h2 class="memtitle"><span class="permalink"><a href="#a372f1f1fab71f5744eaf538156abe64d">&#9670;&nbsp;</a></span>rootDirStart()</h2>
  2162. <div class="memitem">
  2163. <div class="memproto">
  2164. <table class="mlabels">
  2165. <tr>
  2166. <td class="mlabels-left">
  2167. <table class="memname">
  2168. <tr>
  2169. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  2170. <td>(</td>
  2171. <td class="paramname"></td><td>)</td>
  2172. <td> const</td>
  2173. </tr>
  2174. </table>
  2175. </td>
  2176. <td class="mlabels-right">
  2177. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2178. </tr>
  2179. </table>
  2180. </div><div class="memdoc">
  2181. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  2182. </div>
  2183. </div>
  2184. <a id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  2185. <h2 class="memtitle"><span class="permalink"><a href="#ad60cb13557f35578f868e03e9ccb8be1">&#9670;&nbsp;</a></span>truncate()</h2>
  2186. <div class="memitem">
  2187. <div class="memproto">
  2188. <table class="mlabels">
  2189. <tr>
  2190. <td class="mlabels-left">
  2191. <table class="memname">
  2192. <tr>
  2193. <td class="memname">bool FatFileSystem::truncate </td>
  2194. <td>(</td>
  2195. <td class="paramtype">const char *&#160;</td>
  2196. <td class="paramname"><em>path</em>, </td>
  2197. </tr>
  2198. <tr>
  2199. <td class="paramkey"></td>
  2200. <td></td>
  2201. <td class="paramtype">uint32_t&#160;</td>
  2202. <td class="paramname"><em>length</em>&#160;</td>
  2203. </tr>
  2204. <tr>
  2205. <td></td>
  2206. <td>)</td>
  2207. <td></td><td></td>
  2208. </tr>
  2209. </table>
  2210. </td>
  2211. <td class="mlabels-right">
  2212. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2213. </tr>
  2214. </table>
  2215. </div><div class="memdoc">
  2216. <p>Truncate a file to a specified length. 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>
  2217. <dl class="params"><dt>Parameters</dt><dd>
  2218. <table class="params">
  2219. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file. </td></tr>
  2220. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2221. </table>
  2222. </dd>
  2223. </dl>
  2224. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2225. </div>
  2226. </div>
  2227. <a id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  2228. <h2 class="memtitle"><span class="permalink"><a href="#a4ca68fe47bb675df0a80df1ed7a53698">&#9670;&nbsp;</a></span>vol()</h2>
  2229. <div class="memitem">
  2230. <div class="memproto">
  2231. <table class="mlabels">
  2232. <tr>
  2233. <td class="mlabels-left">
  2234. <table class="memname">
  2235. <tr>
  2236. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  2237. <td>(</td>
  2238. <td class="paramname"></td><td>)</td>
  2239. <td></td>
  2240. </tr>
  2241. </table>
  2242. </td>
  2243. <td class="mlabels-right">
  2244. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2245. </tr>
  2246. </table>
  2247. </div><div class="memdoc">
  2248. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> object. </dd></dl>
  2249. </div>
  2250. </div>
  2251. <a id="ada9f893c796559c132ef9da061f04a39"></a>
  2252. <h2 class="memtitle"><span class="permalink"><a href="#ada9f893c796559c132ef9da061f04a39">&#9670;&nbsp;</a></span>volumeBlockCount()</h2>
  2253. <div class="memitem">
  2254. <div class="memproto">
  2255. <table class="mlabels">
  2256. <tr>
  2257. <td class="mlabels-left">
  2258. <table class="memname">
  2259. <tr>
  2260. <td class="memname">uint32_t FatVolume::volumeBlockCount </td>
  2261. <td>(</td>
  2262. <td class="paramname"></td><td>)</td>
  2263. <td> const</td>
  2264. </tr>
  2265. </table>
  2266. </td>
  2267. <td class="mlabels-right">
  2268. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2269. </tr>
  2270. </table>
  2271. </div><div class="memdoc">
  2272. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>
  2273. </div>
  2274. </div>
  2275. <a id="acf257d02b7166683bda2abc5058004bf"></a>
  2276. <h2 class="memtitle"><span class="permalink"><a href="#acf257d02b7166683bda2abc5058004bf">&#9670;&nbsp;</a></span>vwd()</h2>
  2277. <div class="memitem">
  2278. <div class="memproto">
  2279. <table class="mlabels">
  2280. <tr>
  2281. <td class="mlabels-left">
  2282. <table class="memname">
  2283. <tr>
  2284. <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>
  2285. <td>(</td>
  2286. <td class="paramname"></td><td>)</td>
  2287. <td></td>
  2288. </tr>
  2289. </table>
  2290. </td>
  2291. <td class="mlabels-right">
  2292. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2293. </tr>
  2294. </table>
  2295. </div><div class="memdoc">
  2296. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  2297. </div>
  2298. </div>
  2299. <a id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>
  2300. <h2 class="memtitle"><span class="permalink"><a href="#a36d7831f92acfbfef1c4a24dd7103dc4">&#9670;&nbsp;</a></span>wipe()</h2>
  2301. <div class="memitem">
  2302. <div class="memproto">
  2303. <table class="mlabels">
  2304. <tr>
  2305. <td class="mlabels-left">
  2306. <table class="memname">
  2307. <tr>
  2308. <td class="memname">bool FatFileSystem::wipe </td>
  2309. <td>(</td>
  2310. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2311. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  2312. <td></td>
  2313. </tr>
  2314. </table>
  2315. </td>
  2316. <td class="mlabels-right">
  2317. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2318. </tr>
  2319. </table>
  2320. </div><div class="memdoc">
  2321. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>
  2322. <table class="params">
  2323. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  2324. </table>
  2325. </dd>
  2326. </dl>
  2327. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  2328. </div>
  2329. </div>
  2330. <hr/>The documentation for this class was generated from the following file:<ul>
  2331. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  2332. </ul>
  2333. </div><!-- contents -->
  2334. <!-- start footer part -->
  2335. <hr class="footer"/><address class="footer"><small>
  2336. Generated on Fri Dec 28 2018 06:38:31 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  2337. <img class="footer" src="doxygen.png" alt="doxygen"/>
  2338. </a> 1.8.14
  2339. </small></address>
  2340. </body>
  2341. </html>