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.

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