class_sd_fat.html 113 KB

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