You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

class_sd_fat.html 44KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976
  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.6"/>
  7. <title>SdFat: SdFat Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">SdFat
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.6 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  33. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  40. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  41. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42. </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-methods">Public Member Functions</a> &#124;
  48. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  49. <a href="class_sd_fat-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">SdFat Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Integration class for the SdFat library.
  55. <a href="class_sd_fat.html#details">More...</a></p>
  56. <p><code>#include &lt;SdFat.h&gt;</code></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:ac2257f7c12a1f2eb6ad5da9947c7bac3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ac2257f7c12a1f2eb6ad5da9947c7bac3">begin</a> (uint8_t chipSelectPin=<a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a>, uint8_t sckDivisor=SPI_FULL_SPEED)</td></tr>
  61. <tr class="separator:ac2257f7c12a1f2eb6ad5da9947c7bac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a9a4deb665fb0140daf22c62de3ae497d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a9a4deb665fb0140daf22c62de3ae497d">card</a> ()</td></tr>
  63. <tr class="separator:a9a4deb665fb0140daf22c62de3ae497d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:aba234d73505354cbb105b4ad7d3524b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#aba234d73505354cbb105b4ad7d3524b0">chdir</a> (bool set_cwd=false)</td></tr>
  65. <tr class="separator:aba234d73505354cbb105b4ad7d3524b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:aa17f9efe90fb42543395c43804b120f0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#aa17f9efe90fb42543395c43804b120f0">chdir</a> (const char *path, bool set_cwd=false)</td></tr>
  67. <tr class="separator:aa17f9efe90fb42543395c43804b120f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a1c61e5433f4734f9fb3e1426fd804494"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a1c61e5433f4734f9fb3e1426fd804494">chvol</a> ()</td></tr>
  69. <tr class="separator:a1c61e5433f4734f9fb3e1426fd804494"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:aaba28b5be802f623969022226e6dfd21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#aaba28b5be802f623969022226e6dfd21">errorHalt</a> ()</td></tr>
  71. <tr class="separator:aaba28b5be802f623969022226e6dfd21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a8240ad752998c4788a9aa8fea4f6f075"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a8240ad752998c4788a9aa8fea4f6f075">errorHalt</a> (char const *msg)</td></tr>
  73. <tr class="separator:a8240ad752998c4788a9aa8fea4f6f075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a1ddef63d71c00f49a521e8a81472fd60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a1ddef63d71c00f49a521e8a81472fd60">errorHalt_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> msg)</td></tr>
  75. <tr class="separator:a1ddef63d71c00f49a521e8a81472fd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a1ff9f2027978d6ea5fcbd81d53378a7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a1ff9f2027978d6ea5fcbd81d53378a7f">errorPrint</a> ()</td></tr>
  77. <tr class="separator:a1ff9f2027978d6ea5fcbd81d53378a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a47256ec22b421d76bbf86901d47226fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a47256ec22b421d76bbf86901d47226fa">errorPrint</a> (char const *msg)</td></tr>
  79. <tr class="separator:a47256ec22b421d76bbf86901d47226fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ab432c14265f396c3559e575fe3cd512b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ab432c14265f396c3559e575fe3cd512b">errorPrint_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> msg)</td></tr>
  81. <tr class="separator:ab432c14265f396c3559e575fe3cd512b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a15e97702e6a8654a86a745dc20c9ae8a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a15e97702e6a8654a86a745dc20c9ae8a">exists</a> (const char *name)</td></tr>
  83. <tr class="separator:a15e97702e6a8654a86a745dc20c9ae8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a6294adccc03e23e35db6488bf9ace69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a6294adccc03e23e35db6488bf9ace69f">initErrorHalt</a> ()</td></tr>
  85. <tr class="separator:a6294adccc03e23e35db6488bf9ace69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a28e8e4d72848a1024056c4b59a18fb78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a28e8e4d72848a1024056c4b59a18fb78">initErrorHalt</a> (char const *msg)</td></tr>
  87. <tr class="separator:a28e8e4d72848a1024056c4b59a18fb78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a23599f8e6bea81f22b167b50733c5f47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a23599f8e6bea81f22b167b50733c5f47">initErrorHalt_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> msg)</td></tr>
  89. <tr class="separator:a23599f8e6bea81f22b167b50733c5f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ae2210d3d663bd54740eddfb83bcf4473"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ae2210d3d663bd54740eddfb83bcf4473">initErrorPrint</a> ()</td></tr>
  91. <tr class="separator:ae2210d3d663bd54740eddfb83bcf4473"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a6ea82316a10297b53393c39034d560fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a6ea82316a10297b53393c39034d560fb">initErrorPrint</a> (char const *msg)</td></tr>
  93. <tr class="separator:a6ea82316a10297b53393c39034d560fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:adc8cd692cbba16fae572207e329e48c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#adc8cd692cbba16fae572207e329e48c3">initErrorPrint_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> msg)</td></tr>
  95. <tr class="separator:adc8cd692cbba16fae572207e329e48c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a74846855ee6cd53b1716adeaf630b12c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a74846855ee6cd53b1716adeaf630b12c">ls</a> (uint8_t flags=0)</td></tr>
  97. <tr class="separator:a74846855ee6cd53b1716adeaf630b12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a89c679ba5603b771a0ac71bc79d487f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a89c679ba5603b771a0ac71bc79d487f3">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  99. <tr class="separator:a89c679ba5603b771a0ac71bc79d487f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a039202434f459b1ec558897d32cb928c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a039202434f459b1ec558897d32cb928c">ls</a> (Print *pr, uint8_t flags=0)</td></tr>
  101. <tr class="separator:a039202434f459b1ec558897d32cb928c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a0a0244b881cc1a24e7c94886ac6eb9f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a0a0244b881cc1a24e7c94886ac6eb9f5">ls</a> (Print *pr, const char *path, uint8_t flags=0)</td></tr>
  103. <tr class="separator:a0a0244b881cc1a24e7c94886ac6eb9f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a1fe08676296e10b4c1e30311ce35b4de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a1fe08676296e10b4c1e30311ce35b4de">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  105. <tr class="separator:a1fe08676296e10b4c1e30311ce35b4de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:affdaad4aeac6fc6d678b21c2a271d09d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#affdaad4aeac6fc6d678b21c2a271d09d">remove</a> (const char *path)</td></tr>
  107. <tr class="separator:affdaad4aeac6fc6d678b21c2a271d09d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a39afa05b07c30872b27c3d2b53b56911"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a39afa05b07c30872b27c3d2b53b56911">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  109. <tr class="separator:a39afa05b07c30872b27c3d2b53b56911"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a9ece030794f3fb78018cfc9803a62c69"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a9ece030794f3fb78018cfc9803a62c69">rmdir</a> (const char *path)</td></tr>
  111. <tr class="separator:a9ece030794f3fb78018cfc9803a62c69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a46857a04e227af73e0114c750ac35833"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a46857a04e227af73e0114c750ac35833">SdFat</a> ()</td></tr>
  113. <tr class="separator:a46857a04e227af73e0114c750ac35833"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ac0c2ed27d37bdb1b50f4543253871c1e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ac0c2ed27d37bdb1b50f4543253871c1e">truncate</a> (const char *path, uint32_t length)</td></tr>
  115. <tr class="separator:ac0c2ed27d37bdb1b50f4543253871c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a9fca7480532e54b828a3a31015f7c905"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_volume.html">SdVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a9fca7480532e54b828a3a31015f7c905">vol</a> ()</td></tr>
  117. <tr class="separator:a9fca7480532e54b828a3a31015f7c905"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a7027f78e1febb655009b62d7f6c10bbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_base_file.html">SdBaseFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a7027f78e1febb655009b62d7f6c10bbb">vwd</a> ()</td></tr>
  119. <tr class="separator:a7027f78e1febb655009b62d7f6c10bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  122. Static Public Member Functions</h2></td></tr>
  123. <tr class="memitem:a87c53828b0ccd33c77d2a8175c4cdf82"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a87c53828b0ccd33c77d2a8175c4cdf82">setStdOut</a> (Print *stream)</td></tr>
  124. <tr class="separator:a87c53828b0ccd33c77d2a8175c4cdf82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ae5f0467524c70b7a85840c291710d7ca"><td class="memItemLeft" align="right" valign="top">static Print *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ae5f0467524c70b7a85840c291710d7ca">stdOut</a> ()</td></tr>
  126. <tr class="separator:ae5f0467524c70b7a85840c291710d7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><p>Integration class for the SdFat library. </p>
  130. <p>error if old IDE </p>
  131. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  132. <a class="anchor" id="a46857a04e227af73e0114c750ac35833"></a>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="mlabels">
  136. <tr>
  137. <td class="mlabels-left">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">SdFat::SdFat </td>
  141. <td>(</td>
  142. <td class="paramname"></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. </div>
  153. </div>
  154. <h2 class="groupheader">Member Function Documentation</h2>
  155. <a class="anchor" id="ac2257f7c12a1f2eb6ad5da9947c7bac3"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">bool SdFat::begin </td>
  161. <td>(</td>
  162. <td class="paramtype">uint8_t&#160;</td>
  163. <td class="paramname"><em>chipSelectPin</em> = <code><a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a></code>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">uint8_t&#160;</td>
  169. <td class="paramname"><em>sckDivisor</em> = <code>SPI_FULL_SPEED</code>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Initialize an <a class="el" href="class_sd_fat.html" title="Integration class for the SdFat library. ">SdFat</a> object.</p>
  179. <p>Initializes the SD card, SD volume, and root directory.</p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramdir">[in]</td><td class="paramname">chipSelectPin</td><td>SD chip select pin. See <a class="el" href="class_sd2_card.html#a71523097165fce957c7f65b033471fc7">Sd2Card::init()</a>. </td></tr>
  183. <tr><td class="paramdir">[in]</td><td class="paramname">sckDivisor</td><td>value for SPI SCK divisor. See <a class="el" href="class_sd2_card.html#a71523097165fce957c7f65b033471fc7">Sd2Card::init()</a>.</td></tr>
  184. </table>
  185. </dd>
  186. </dl>
  187. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  188. </div>
  189. </div>
  190. <a class="anchor" id="a9a4deb665fb0140daf22c62de3ae497d"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="class_sd2_card.html">Sd2Card</a>* SdFat::card </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> object. </dd></dl>
  211. </div>
  212. </div>
  213. <a class="anchor" id="aba234d73505354cbb105b4ad7d3524b0"></a>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">bool SdFat::chdir </td>
  219. <td>(</td>
  220. <td class="paramtype">bool&#160;</td>
  221. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Change a volume's working directory to root</p>
  227. <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>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <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>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="aa17f9efe90fb42543395c43804b120f0"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">bool SdFat::chdir </td>
  243. <td>(</td>
  244. <td class="paramtype">const char *&#160;</td>
  245. <td class="paramname"><em>path</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">bool&#160;</td>
  251. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Change a volume's working directory</p>
  261. <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>
  262. <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>
  263. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  267. <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>
  268. </table>
  269. </dd>
  270. </dl>
  271. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  272. </div>
  273. </div>
  274. <a class="anchor" id="a1c61e5433f4734f9fb3e1426fd804494"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">void SdFat::chvol </td>
  280. <td>(</td>
  281. <td class="paramname"></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Set the current working directory to a volume's working directory.</p>
  287. <p>This is useful with multiple SD cards.</p>
  288. <p>The current working directory is changed to this volume's working directory.</p>
  289. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="aaba28b5be802f623969022226e6dfd21"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void SdFat::errorHalt </td>
  298. <td>(</td>
  299. <td class="paramname"></td><td>)</td>
  300. <td></td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Print any SD error code and halt. </p>
  305. </div>
  306. </div>
  307. <a class="anchor" id="a8240ad752998c4788a9aa8fea4f6f075"></a>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">void SdFat::errorHalt </td>
  313. <td>(</td>
  314. <td class="paramtype">char const *&#160;</td>
  315. <td class="paramname"><em>msg</em></td><td>)</td>
  316. <td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Print msg, any SD error code, and halt.</p>
  321. <dl class="params"><dt>Parameters</dt><dd>
  322. <table class="params">
  323. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  324. </table>
  325. </dd>
  326. </dl>
  327. </div>
  328. </div>
  329. <a class="anchor" id="a1ddef63d71c00f49a521e8a81472fd60"></a>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">void SdFat::errorHalt_P </td>
  335. <td>(</td>
  336. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  337. <td class="paramname"><em>msg</em></td><td>)</td>
  338. <td></td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Print msg, any SD error code, and halt.</p>
  343. <dl class="params"><dt>Parameters</dt><dd>
  344. <table class="params">
  345. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>
  346. </table>
  347. </dd>
  348. </dl>
  349. </div>
  350. </div>
  351. <a class="anchor" id="a1ff9f2027978d6ea5fcbd81d53378a7f"></a>
  352. <div class="memitem">
  353. <div class="memproto">
  354. <table class="memname">
  355. <tr>
  356. <td class="memname">void SdFat::errorPrint </td>
  357. <td>(</td>
  358. <td class="paramname"></td><td>)</td>
  359. <td></td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Print any SD error code. </p>
  364. </div>
  365. </div>
  366. <a class="anchor" id="a47256ec22b421d76bbf86901d47226fa"></a>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">void SdFat::errorPrint </td>
  372. <td>(</td>
  373. <td class="paramtype">char const *&#160;</td>
  374. <td class="paramname"><em>msg</em></td><td>)</td>
  375. <td></td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <p>Print msg, any SD error code.</p>
  380. <dl class="params"><dt>Parameters</dt><dd>
  381. <table class="params">
  382. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  383. </table>
  384. </dd>
  385. </dl>
  386. </div>
  387. </div>
  388. <a class="anchor" id="ab432c14265f396c3559e575fe3cd512b"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname">void SdFat::errorPrint_P </td>
  394. <td>(</td>
  395. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  396. <td class="paramname"><em>msg</em></td><td>)</td>
  397. <td></td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p>Print msg, any SD error code.</p>
  402. <dl class="params"><dt>Parameters</dt><dd>
  403. <table class="params">
  404. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>
  405. </table>
  406. </dd>
  407. </dl>
  408. </div>
  409. </div>
  410. <a class="anchor" id="a15e97702e6a8654a86a745dc20c9ae8a"></a>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">bool SdFat::exists </td>
  416. <td>(</td>
  417. <td class="paramtype">const char *&#160;</td>
  418. <td class="paramname"><em>name</em></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Test for the existence of a file.</p>
  424. <dl class="params"><dt>Parameters</dt><dd>
  425. <table class="params">
  426. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the file to be tested for.</td></tr>
  427. </table>
  428. </dd>
  429. </dl>
  430. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  431. </div>
  432. </div>
  433. <a class="anchor" id="a6294adccc03e23e35db6488bf9ace69f"></a>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">void SdFat::initErrorHalt </td>
  439. <td>(</td>
  440. <td class="paramname"></td><td>)</td>
  441. <td></td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <p>Print error details and halt after SdFat::init() fails. </p>
  446. </div>
  447. </div>
  448. <a class="anchor" id="a28e8e4d72848a1024056c4b59a18fb78"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">void SdFat::initErrorHalt </td>
  454. <td>(</td>
  455. <td class="paramtype">char const *&#160;</td>
  456. <td class="paramname"><em>msg</em></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Print message, error details, and halt after SdFat::init() fails.</p>
  462. <dl class="params"><dt>Parameters</dt><dd>
  463. <table class="params">
  464. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. </div>
  469. </div>
  470. <a class="anchor" id="a23599f8e6bea81f22b167b50733c5f47"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">void SdFat::initErrorHalt_P </td>
  476. <td>(</td>
  477. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  478. <td class="paramname"><em>msg</em></td><td>)</td>
  479. <td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Print message, error details, and halt after SdFat::init() fails.</p>
  484. <dl class="params"><dt>Parameters</dt><dd>
  485. <table class="params">
  486. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>
  487. </table>
  488. </dd>
  489. </dl>
  490. </div>
  491. </div>
  492. <a class="anchor" id="ae2210d3d663bd54740eddfb83bcf4473"></a>
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">void SdFat::initErrorPrint </td>
  498. <td>(</td>
  499. <td class="paramname"></td><td>)</td>
  500. <td></td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. <p>Print error details after SdFat::init() fails. </p>
  505. </div>
  506. </div>
  507. <a class="anchor" id="a6ea82316a10297b53393c39034d560fb"></a>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname">void SdFat::initErrorPrint </td>
  513. <td>(</td>
  514. <td class="paramtype">char const *&#160;</td>
  515. <td class="paramname"><em>msg</em></td><td>)</td>
  516. <td></td>
  517. </tr>
  518. </table>
  519. </div><div class="memdoc">
  520. <p>Print message and error details and halt after SdFat::init() fails.</p>
  521. <dl class="params"><dt>Parameters</dt><dd>
  522. <table class="params">
  523. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  524. </table>
  525. </dd>
  526. </dl>
  527. </div>
  528. </div>
  529. <a class="anchor" id="adc8cd692cbba16fae572207e329e48c3"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">void SdFat::initErrorPrint_P </td>
  535. <td>(</td>
  536. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  537. <td class="paramname"><em>msg</em></td><td>)</td>
  538. <td></td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <p>Print message and error details after SdFat::init() fails.</p>
  543. <dl class="params"><dt>Parameters</dt><dd>
  544. <table class="params">
  545. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>
  546. </table>
  547. </dd>
  548. </dl>
  549. </div>
  550. </div>
  551. <a class="anchor" id="a74846855ee6cd53b1716adeaf630b12c"></a>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <table class="memname">
  555. <tr>
  556. <td class="memname">void SdFat::ls </td>
  557. <td>(</td>
  558. <td class="paramtype">uint8_t&#160;</td>
  559. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  560. <td></td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <p>List the directory contents of the volume working directory to stdOut.</p>
  565. <dl class="params"><dt>Parameters</dt><dd>
  566. <table class="params">
  567. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  568. </table>
  569. </dd>
  570. </dl>
  571. <p>LS_DATE - Print file modification date</p>
  572. <p>LS_SIZE - Print file size.</p>
  573. <p>LS_R - Recursive list of subdirectories. </p>
  574. </div>
  575. </div>
  576. <a class="anchor" id="a89c679ba5603b771a0ac71bc79d487f3"></a>
  577. <div class="memitem">
  578. <div class="memproto">
  579. <table class="memname">
  580. <tr>
  581. <td class="memname">void SdFat::ls </td>
  582. <td>(</td>
  583. <td class="paramtype">const char *&#160;</td>
  584. <td class="paramname"><em>path</em>, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype">uint8_t&#160;</td>
  590. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  591. </tr>
  592. <tr>
  593. <td></td>
  594. <td>)</td>
  595. <td></td><td></td>
  596. </tr>
  597. </table>
  598. </div><div class="memdoc">
  599. <p>List the directory contents of the volume working directory to stdOut.</p>
  600. <dl class="params"><dt>Parameters</dt><dd>
  601. <table class="params">
  602. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  603. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  604. </table>
  605. </dd>
  606. </dl>
  607. <p>LS_DATE - Print file modification date</p>
  608. <p>LS_SIZE - Print file size.</p>
  609. <p>LS_R - Recursive list of subdirectories. </p>
  610. </div>
  611. </div>
  612. <a class="anchor" id="a039202434f459b1ec558897d32cb928c"></a>
  613. <div class="memitem">
  614. <div class="memproto">
  615. <table class="memname">
  616. <tr>
  617. <td class="memname">void SdFat::ls </td>
  618. <td>(</td>
  619. <td class="paramtype">Print *&#160;</td>
  620. <td class="paramname"><em>pr</em>, </td>
  621. </tr>
  622. <tr>
  623. <td class="paramkey"></td>
  624. <td></td>
  625. <td class="paramtype">uint8_t&#160;</td>
  626. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  627. </tr>
  628. <tr>
  629. <td></td>
  630. <td>)</td>
  631. <td></td><td></td>
  632. </tr>
  633. </table>
  634. </div><div class="memdoc">
  635. <p>List the directory contents of the volume working directory.</p>
  636. <dl class="params"><dt>Parameters</dt><dd>
  637. <table class="params">
  638. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  639. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  640. </table>
  641. </dd>
  642. </dl>
  643. <p>LS_DATE - Print file modification date</p>
  644. <p>LS_SIZE - Print file size.</p>
  645. <p>LS_R - Recursive list of subdirectories. </p>
  646. </div>
  647. </div>
  648. <a class="anchor" id="a0a0244b881cc1a24e7c94886ac6eb9f5"></a>
  649. <div class="memitem">
  650. <div class="memproto">
  651. <table class="memname">
  652. <tr>
  653. <td class="memname">void SdFat::ls </td>
  654. <td>(</td>
  655. <td class="paramtype">Print *&#160;</td>
  656. <td class="paramname"><em>pr</em>, </td>
  657. </tr>
  658. <tr>
  659. <td class="paramkey"></td>
  660. <td></td>
  661. <td class="paramtype">const char *&#160;</td>
  662. <td class="paramname"><em>path</em>, </td>
  663. </tr>
  664. <tr>
  665. <td class="paramkey"></td>
  666. <td></td>
  667. <td class="paramtype">uint8_t&#160;</td>
  668. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  669. </tr>
  670. <tr>
  671. <td></td>
  672. <td>)</td>
  673. <td></td><td></td>
  674. </tr>
  675. </table>
  676. </div><div class="memdoc">
  677. </div>
  678. </div>
  679. <a class="anchor" id="a1fe08676296e10b4c1e30311ce35b4de"></a>
  680. <div class="memitem">
  681. <div class="memproto">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname">bool SdFat::mkdir </td>
  685. <td>(</td>
  686. <td class="paramtype">const char *&#160;</td>
  687. <td class="paramname"><em>path</em>, </td>
  688. </tr>
  689. <tr>
  690. <td class="paramkey"></td>
  691. <td></td>
  692. <td class="paramtype">bool&#160;</td>
  693. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  694. </tr>
  695. <tr>
  696. <td></td>
  697. <td>)</td>
  698. <td></td><td></td>
  699. </tr>
  700. </table>
  701. </div><div class="memdoc">
  702. <p>Make a subdirectory in the volume working directory.</p>
  703. <dl class="params"><dt>Parameters</dt><dd>
  704. <table class="params">
  705. <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>
  706. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  707. </table>
  708. </dd>
  709. </dl>
  710. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  711. </div>
  712. </div>
  713. <a class="anchor" id="affdaad4aeac6fc6d678b21c2a271d09d"></a>
  714. <div class="memitem">
  715. <div class="memproto">
  716. <table class="memname">
  717. <tr>
  718. <td class="memname">bool SdFat::remove </td>
  719. <td>(</td>
  720. <td class="paramtype">const char *&#160;</td>
  721. <td class="paramname"><em>path</em></td><td>)</td>
  722. <td></td>
  723. </tr>
  724. </table>
  725. </div><div class="memdoc">
  726. <p>Remove a file from the volume working directory.</p>
  727. <dl class="params"><dt>Parameters</dt><dd>
  728. <table class="params">
  729. <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>
  730. </table>
  731. </dd>
  732. </dl>
  733. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  734. </div>
  735. </div>
  736. <a class="anchor" id="a39afa05b07c30872b27c3d2b53b56911"></a>
  737. <div class="memitem">
  738. <div class="memproto">
  739. <table class="memname">
  740. <tr>
  741. <td class="memname">bool SdFat::rename </td>
  742. <td>(</td>
  743. <td class="paramtype">const char *&#160;</td>
  744. <td class="paramname"><em>oldPath</em>, </td>
  745. </tr>
  746. <tr>
  747. <td class="paramkey"></td>
  748. <td></td>
  749. <td class="paramtype">const char *&#160;</td>
  750. <td class="paramname"><em>newPath</em>&#160;</td>
  751. </tr>
  752. <tr>
  753. <td></td>
  754. <td>)</td>
  755. <td></td><td></td>
  756. </tr>
  757. </table>
  758. </div><div class="memdoc">
  759. <p>Rename a file or subdirectory.</p>
  760. <dl class="params"><dt>Parameters</dt><dd>
  761. <table class="params">
  762. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  763. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  764. </table>
  765. </dd>
  766. </dl>
  767. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  768. <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_sd_fat.html#a39afa05b07c30872b27c3d2b53b56911">rename()</a> call.</p>
  769. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  770. </div>
  771. </div>
  772. <a class="anchor" id="a9ece030794f3fb78018cfc9803a62c69"></a>
  773. <div class="memitem">
  774. <div class="memproto">
  775. <table class="memname">
  776. <tr>
  777. <td class="memname">bool SdFat::rmdir </td>
  778. <td>(</td>
  779. <td class="paramtype">const char *&#160;</td>
  780. <td class="paramname"><em>path</em></td><td>)</td>
  781. <td></td>
  782. </tr>
  783. </table>
  784. </div><div class="memdoc">
  785. <p>Remove a subdirectory from the volume's working directory.</p>
  786. <dl class="params"><dt>Parameters</dt><dd>
  787. <table class="params">
  788. <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>
  789. </table>
  790. </dd>
  791. </dl>
  792. <p>The subdirectory file will be removed only if it is empty.</p>
  793. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. </dd></dl>
  794. </div>
  795. </div>
  796. <a class="anchor" id="a87c53828b0ccd33c77d2a8175c4cdf82"></a>
  797. <div class="memitem">
  798. <div class="memproto">
  799. <table class="mlabels">
  800. <tr>
  801. <td class="mlabels-left">
  802. <table class="memname">
  803. <tr>
  804. <td class="memname">static void SdFat::setStdOut </td>
  805. <td>(</td>
  806. <td class="paramtype">Print *&#160;</td>
  807. <td class="paramname"><em>stream</em></td><td>)</td>
  808. <td></td>
  809. </tr>
  810. </table>
  811. </td>
  812. <td class="mlabels-right">
  813. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. <p>Set stdOut Print stream for messages. </p>
  818. <dl class="params"><dt>Parameters</dt><dd>
  819. <table class="params">
  820. <tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>The new Print stream. </td></tr>
  821. </table>
  822. </dd>
  823. </dl>
  824. </div>
  825. </div>
  826. <a class="anchor" id="ae5f0467524c70b7a85840c291710d7ca"></a>
  827. <div class="memitem">
  828. <div class="memproto">
  829. <table class="mlabels">
  830. <tr>
  831. <td class="mlabels-left">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname">static Print* SdFat::stdOut </td>
  835. <td>(</td>
  836. <td class="paramname"></td><td>)</td>
  837. <td></td>
  838. </tr>
  839. </table>
  840. </td>
  841. <td class="mlabels-right">
  842. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  843. </tr>
  844. </table>
  845. </div><div class="memdoc">
  846. <dl class="section return"><dt>Returns</dt><dd>Print stream for messages. </dd></dl>
  847. </div>
  848. </div>
  849. <a class="anchor" id="ac0c2ed27d37bdb1b50f4543253871c1e"></a>
  850. <div class="memitem">
  851. <div class="memproto">
  852. <table class="memname">
  853. <tr>
  854. <td class="memname">bool SdFat::truncate </td>
  855. <td>(</td>
  856. <td class="paramtype">const char *&#160;</td>
  857. <td class="paramname"><em>path</em>, </td>
  858. </tr>
  859. <tr>
  860. <td class="paramkey"></td>
  861. <td></td>
  862. <td class="paramtype">uint32_t&#160;</td>
  863. <td class="paramname"><em>length</em>&#160;</td>
  864. </tr>
  865. <tr>
  866. <td></td>
  867. <td>)</td>
  868. <td></td><td></td>
  869. </tr>
  870. </table>
  871. </div><div class="memdoc">
  872. <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>
  873. <dl class="params"><dt>Parameters</dt><dd>
  874. <table class="params">
  875. <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>
  876. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  877. </table>
  878. </dd>
  879. </dl>
  880. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include file is read only, file is a directory, <em>length</em> is greater than the current file size or an I/O error occurs. </dd></dl>
  881. </div>
  882. </div>
  883. <a class="anchor" id="a9fca7480532e54b828a3a31015f7c905"></a>
  884. <div class="memitem">
  885. <div class="memproto">
  886. <table class="mlabels">
  887. <tr>
  888. <td class="mlabels-left">
  889. <table class="memname">
  890. <tr>
  891. <td class="memname"><a class="el" href="class_sd_volume.html">SdVolume</a>* SdFat::vol </td>
  892. <td>(</td>
  893. <td class="paramname"></td><td>)</td>
  894. <td></td>
  895. </tr>
  896. </table>
  897. </td>
  898. <td class="mlabels-right">
  899. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  900. </tr>
  901. </table>
  902. </div><div class="memdoc">
  903. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_sd_volume.html" title="Access FAT16 and FAT32 volumes on SD and SDHC cards. ">SdVolume</a> object. </dd></dl>
  904. </div>
  905. </div>
  906. <a class="anchor" id="a7027f78e1febb655009b62d7f6c10bbb"></a>
  907. <div class="memitem">
  908. <div class="memproto">
  909. <table class="mlabels">
  910. <tr>
  911. <td class="mlabels-left">
  912. <table class="memname">
  913. <tr>
  914. <td class="memname"><a class="el" href="class_sd_base_file.html">SdBaseFile</a>* SdFat::vwd </td>
  915. <td>(</td>
  916. <td class="paramname"></td><td>)</td>
  917. <td></td>
  918. </tr>
  919. </table>
  920. </td>
  921. <td class="mlabels-right">
  922. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  923. </tr>
  924. </table>
  925. </div><div class="memdoc">
  926. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  927. </div>
  928. </div>
  929. <hr/>The documentation for this class was generated from the following files:<ul>
  930. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  931. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8cpp.html">SdFat.cpp</a></li>
  932. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_error_print_8cpp.html">SdFatErrorPrint.cpp</a></li>
  933. </ul>
  934. </div><!-- contents -->
  935. <!-- start footer part -->
  936. <hr class="footer"/><address class="footer"><small>
  937. Generated on Sun Aug 24 2014 09:37:38 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  938. <img class="footer" src="doxygen.png" alt="doxygen"/>
  939. </a> 1.8.6
  940. </small></address>
  941. </body>
  942. </html>