visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
9 Commits
1 Branch
Tree: 940b09a7dd
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '940b09a7dd'
${ noResults }
teensy-sdfat/html/class_sd_fat.html

1006 lines
45KB
Raw Blame History 

  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. 

  54. <p>Integration class for the SdFat library.  

  55.  <a href="class_sd_fat.html#details">More...</a></p>

  56. 

  57. <p><code>#include &lt;SdFat.h&gt;</code></p>

  58. <table class="memberdecls">

  59. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  60. Public Member Functions</h2></td></tr>

  61. <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>

  62. <tr class="separator:ac2257f7c12a1f2eb6ad5da9947c7bac3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  63. <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>

  64. <tr class="separator:a9a4deb665fb0140daf22c62de3ae497d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  65. <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>

  66. <tr class="separator:aba234d73505354cbb105b4ad7d3524b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  67. <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>

  68. <tr class="separator:aa17f9efe90fb42543395c43804b120f0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  69. <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>

  70. <tr class="separator:a1c61e5433f4734f9fb3e1426fd804494"><td class="memSeparator" colspan="2">&#160;</td></tr>

  71. <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>

  72. <tr class="separator:aaba28b5be802f623969022226e6dfd21"><td class="memSeparator" colspan="2">&#160;</td></tr>

  73. <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>

  74. <tr class="separator:a8240ad752998c4788a9aa8fea4f6f075"><td class="memSeparator" colspan="2">&#160;</td></tr>

  75. <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>

  76. <tr class="separator:a1ddef63d71c00f49a521e8a81472fd60"><td class="memSeparator" colspan="2">&#160;</td></tr>

  77. <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>

  78. <tr class="separator:a1ff9f2027978d6ea5fcbd81d53378a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  79. <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>

  80. <tr class="separator:a47256ec22b421d76bbf86901d47226fa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  81. <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>

  82. <tr class="separator:ab432c14265f396c3559e575fe3cd512b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  83. <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>

  84. <tr class="separator:a15e97702e6a8654a86a745dc20c9ae8a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  85. <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>

  86. <tr class="separator:a6294adccc03e23e35db6488bf9ace69f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  87. <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>

  88. <tr class="separator:a28e8e4d72848a1024056c4b59a18fb78"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <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>

  90. <tr class="separator:a23599f8e6bea81f22b167b50733c5f47"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <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>

  92. <tr class="separator:ae2210d3d663bd54740eddfb83bcf4473"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <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>

  94. <tr class="separator:a6ea82316a10297b53393c39034d560fb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <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>

  96. <tr class="separator:adc8cd692cbba16fae572207e329e48c3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <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>

  98. <tr class="separator:a74846855ee6cd53b1716adeaf630b12c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <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>

  100. <tr class="separator:a89c679ba5603b771a0ac71bc79d487f3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <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>

  102. <tr class="separator:a039202434f459b1ec558897d32cb928c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <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>

  104. <tr class="separator:a0a0244b881cc1a24e7c94886ac6eb9f5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <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>

  106. <tr class="separator:a1fe08676296e10b4c1e30311ce35b4de"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <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>

  108. <tr class="separator:a08cf08d63ad0b439489808ea9cc95fb7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <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>

  110. <tr class="separator:affdaad4aeac6fc6d678b21c2a271d09d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <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>

  112. <tr class="separator:a39afa05b07c30872b27c3d2b53b56911"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <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>

  114. <tr class="separator:a9ece030794f3fb78018cfc9803a62c69"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <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>

  116. <tr class="separator:ac0c2ed27d37bdb1b50f4543253871c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <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>

  118. <tr class="separator:a9fca7480532e54b828a3a31015f7c905"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <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>

  120. <tr class="separator:a7027f78e1febb655009b62d7f6c10bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  121. </table><table class="memberdecls">

  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

  123. Static Public Member Functions</h2></td></tr>

  124. <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>

  125. <tr class="separator:a87c53828b0ccd33c77d2a8175c4cdf82"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <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>

  127. <tr class="separator:ae5f0467524c70b7a85840c291710d7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. </table>

  129. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  130. <div class="textblock"><p>Integration class for the SdFat library. </p>

  131. <p>error if old IDE </p>

  132. </div><h2 class="groupheader">Member Function Documentation</h2>

  133. <a class="anchor" id="ac2257f7c12a1f2eb6ad5da9947c7bac3"></a>

  134. <div class="memitem">

  135. <div class="memproto">

  136.       <table class="memname">

  137.         <tr>

  138.           <td class="memname">bool SdFat::begin </td>

  139.           <td>(</td>

  140.           <td class="paramtype">uint8_t&#160;</td>

  141.           <td class="paramname"><em>chipSelectPin</em> = <code><a class="el" href="_sd_spi_8h.html#ae6b17538c14ba6c91ccb513db2c4c29c">SD_CHIP_SELECT_PIN</a></code>, </td>

  142.         </tr>

  143.         <tr>

  144.           <td class="paramkey"></td>

  145.           <td></td>

  146.           <td class="paramtype">uint8_t&#160;</td>

  147.           <td class="paramname"><em>sckDivisor</em> = <code>SPI_FULL_SPEED</code>&#160;</td>

  148.         </tr>

  149.         <tr>

  150.           <td></td>

  151.           <td>)</td>

  152.           <td></td><td></td>

  153.         </tr>

  154.       </table>

  155. </div><div class="memdoc">

  156. <p>Initialize an <a class="el" href="class_sd_fat.html" title="Integration class for the SdFat library. ">SdFat</a> object.</p>

  157. <p>Initializes the SD card, SD volume, and root directory.</p>

  158. <dl class="params"><dt>Parameters</dt><dd>

  159.   <table class="params">

  160.     <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>

  161.     <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>

  162.   </table>

  163.   </dd>

  164. </dl>

  165. <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>

  166. 

  167. </div>

  168. </div>

  169. <a class="anchor" id="a9a4deb665fb0140daf22c62de3ae497d"></a>

  170. <div class="memitem">

  171. <div class="memproto">

  172. <table class="mlabels">

  173.   <tr>

  174.   <td class="mlabels-left">

  175.       <table class="memname">

  176.         <tr>

  177.           <td class="memname"><a class="el" href="class_sd2_card.html">Sd2Card</a>* SdFat::card </td>

  178.           <td>(</td>

  179.           <td class="paramname"></td><td>)</td>

  180.           <td></td>

  181.         </tr>

  182.       </table>

  183.   </td>

  184.   <td class="mlabels-right">

  185. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  186.   </tr>

  187. </table>

  188. </div><div class="memdoc">

  189. <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>

  190. 

  191. </div>

  192. </div>

  193. <a class="anchor" id="aba234d73505354cbb105b4ad7d3524b0"></a>

  194. <div class="memitem">

  195. <div class="memproto">

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">bool SdFat::chdir </td>

  199.           <td>(</td>

  200.           <td class="paramtype">bool&#160;</td>

  201.           <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>

  202.           <td></td>

  203.         </tr>

  204.       </table>

  205. </div><div class="memdoc">

  206. <p>Change a volume's working directory to root</p>

  207. <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>

  208. <dl class="params"><dt>Parameters</dt><dd>

  209.   <table class="params">

  210.     <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>

  211.   </table>

  212.   </dd>

  213. </dl>

  214. <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>

  215. 

  216. </div>

  217. </div>

  218. <a class="anchor" id="aa17f9efe90fb42543395c43804b120f0"></a>

  219. <div class="memitem">

  220. <div class="memproto">

  221.       <table class="memname">

  222.         <tr>

  223.           <td class="memname">bool SdFat::chdir </td>

  224.           <td>(</td>

  225.           <td class="paramtype">const char *&#160;</td>

  226.           <td class="paramname"><em>path</em>, </td>

  227.         </tr>

  228.         <tr>

  229.           <td class="paramkey"></td>

  230.           <td></td>

  231.           <td class="paramtype">bool&#160;</td>

  232.           <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>

  233.         </tr>

  234.         <tr>

  235.           <td></td>

  236.           <td>)</td>

  237.           <td></td><td></td>

  238.         </tr>

  239.       </table>

  240. </div><div class="memdoc">

  241. <p>Change a volume's working directory</p>

  242. <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>

  243. <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>

  244. <p>If path is "/", the volume's working directory will be changed to the root directory</p>

  245. <dl class="params"><dt>Parameters</dt><dd>

  246.   <table class="params">

  247.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>

  248.     <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>

  249.   </table>

  250.   </dd>

  251. </dl>

  252. <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>

  253. 

  254. </div>

  255. </div>

  256. <a class="anchor" id="a1c61e5433f4734f9fb3e1426fd804494"></a>

  257. <div class="memitem">

  258. <div class="memproto">

  259.       <table class="memname">

  260.         <tr>

  261.           <td class="memname">void SdFat::chvol </td>

  262.           <td>(</td>

  263.           <td class="paramname"></td><td>)</td>

  264.           <td></td>

  265.         </tr>

  266.       </table>

  267. </div><div class="memdoc">

  268. <p>Set the current working directory to a volume's working directory.</p>

  269. <p>This is useful with multiple SD cards.</p>

  270. <p>The current working directory is changed to this volume's working directory.</p>

  271. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>

  272. 

  273. </div>

  274. </div>

  275. <a class="anchor" id="aaba28b5be802f623969022226e6dfd21"></a>

  276. <div class="memitem">

  277. <div class="memproto">

  278.       <table class="memname">

  279.         <tr>

  280.           <td class="memname">void SdFat::errorHalt </td>

  281.           <td>(</td>

  282.           <td class="paramname"></td><td>)</td>

  283.           <td></td>

  284.         </tr>

  285.       </table>

  286. </div><div class="memdoc">

  287. <p>Print any SD error code and halt. </p>

  288. 

  289. </div>

  290. </div>

  291. <a class="anchor" id="a8240ad752998c4788a9aa8fea4f6f075"></a>

  292. <div class="memitem">

  293. <div class="memproto">

  294.       <table class="memname">

  295.         <tr>

  296.           <td class="memname">void SdFat::errorHalt </td>

  297.           <td>(</td>

  298.           <td class="paramtype">char const *&#160;</td>

  299.           <td class="paramname"><em>msg</em></td><td>)</td>

  300.           <td></td>

  301.         </tr>

  302.       </table>

  303. </div><div class="memdoc">

  304. <p>Print msg, any SD error code, and halt.</p>

  305. <dl class="params"><dt>Parameters</dt><dd>

  306.   <table class="params">

  307.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  308.   </table>

  309.   </dd>

  310. </dl>

  311. 

  312. </div>

  313. </div>

  314. <a class="anchor" id="a1ddef63d71c00f49a521e8a81472fd60"></a>

  315. <div class="memitem">

  316. <div class="memproto">

  317.       <table class="memname">

  318.         <tr>

  319.           <td class="memname">void SdFat::errorHalt_P </td>

  320.           <td>(</td>

  321.           <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>

  322.           <td class="paramname"><em>msg</em></td><td>)</td>

  323.           <td></td>

  324.         </tr>

  325.       </table>

  326. </div><div class="memdoc">

  327. <p>Print msg, any SD error code, and halt.</p>

  328. <dl class="params"><dt>Parameters</dt><dd>

  329.   <table class="params">

  330.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>

  331.   </table>

  332.   </dd>

  333. </dl>

  334. 

  335. </div>

  336. </div>

  337. <a class="anchor" id="a1ff9f2027978d6ea5fcbd81d53378a7f"></a>

  338. <div class="memitem">

  339. <div class="memproto">

  340.       <table class="memname">

  341.         <tr>

  342.           <td class="memname">void SdFat::errorPrint </td>

  343.           <td>(</td>

  344.           <td class="paramname"></td><td>)</td>

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348. </div><div class="memdoc">

  349. <p>Print any SD error code. </p>

  350. 

  351. </div>

  352. </div>

  353. <a class="anchor" id="a47256ec22b421d76bbf86901d47226fa"></a>

  354. <div class="memitem">

  355. <div class="memproto">

  356.       <table class="memname">

  357.         <tr>

  358.           <td class="memname">void SdFat::errorPrint </td>

  359.           <td>(</td>

  360.           <td class="paramtype">char const *&#160;</td>

  361.           <td class="paramname"><em>msg</em></td><td>)</td>

  362.           <td></td>

  363.         </tr>

  364.       </table>

  365. </div><div class="memdoc">

  366. <p>Print msg, any SD error code.</p>

  367. <dl class="params"><dt>Parameters</dt><dd>

  368.   <table class="params">

  369.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  370.   </table>

  371.   </dd>

  372. </dl>

  373. 

  374. </div>

  375. </div>

  376. <a class="anchor" id="ab432c14265f396c3559e575fe3cd512b"></a>

  377. <div class="memitem">

  378. <div class="memproto">

  379.       <table class="memname">

  380.         <tr>

  381.           <td class="memname">void SdFat::errorPrint_P </td>

  382.           <td>(</td>

  383.           <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>

  384.           <td class="paramname"><em>msg</em></td><td>)</td>

  385.           <td></td>

  386.         </tr>

  387.       </table>

  388. </div><div class="memdoc">

  389. <p>Print msg, any SD error code.</p>

  390. <dl class="params"><dt>Parameters</dt><dd>

  391.   <table class="params">

  392.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>

  393.   </table>

  394.   </dd>

  395. </dl>

  396. 

  397. </div>

  398. </div>

  399. <a class="anchor" id="a15e97702e6a8654a86a745dc20c9ae8a"></a>

  400. <div class="memitem">

  401. <div class="memproto">

  402.       <table class="memname">

  403.         <tr>

  404.           <td class="memname">bool SdFat::exists </td>

  405.           <td>(</td>

  406.           <td class="paramtype">const char *&#160;</td>

  407.           <td class="paramname"><em>name</em></td><td>)</td>

  408.           <td></td>

  409.         </tr>

  410.       </table>

  411. </div><div class="memdoc">

  412. <p>Test for the existence of a file.</p>

  413. <dl class="params"><dt>Parameters</dt><dd>

  414.   <table class="params">

  415.     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the file to be tested for.</td></tr>

  416.   </table>

  417.   </dd>

  418. </dl>

  419. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>

  420. 

  421. </div>

  422. </div>

  423. <a class="anchor" id="a6294adccc03e23e35db6488bf9ace69f"></a>

  424. <div class="memitem">

  425. <div class="memproto">

  426.       <table class="memname">

  427.         <tr>

  428.           <td class="memname">void SdFat::initErrorHalt </td>

  429.           <td>(</td>

  430.           <td class="paramname"></td><td>)</td>

  431.           <td></td>

  432.         </tr>

  433.       </table>

  434. </div><div class="memdoc">

  435. <p>Print error details and halt after SdFat::init() fails. </p>

  436. 

  437. </div>

  438. </div>

  439. <a class="anchor" id="a28e8e4d72848a1024056c4b59a18fb78"></a>

  440. <div class="memitem">

  441. <div class="memproto">

  442.       <table class="memname">

  443.         <tr>

  444.           <td class="memname">void SdFat::initErrorHalt </td>

  445.           <td>(</td>

  446.           <td class="paramtype">char const *&#160;</td>

  447.           <td class="paramname"><em>msg</em></td><td>)</td>

  448.           <td></td>

  449.         </tr>

  450.       </table>

  451. </div><div class="memdoc">

  452. <p>Print message, error details, and halt after SdFat::init() fails.</p>

  453. <dl class="params"><dt>Parameters</dt><dd>

  454.   <table class="params">

  455.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  456.   </table>

  457.   </dd>

  458. </dl>

  459. 

  460. </div>

  461. </div>

  462. <a class="anchor" id="a23599f8e6bea81f22b167b50733c5f47"></a>

  463. <div class="memitem">

  464. <div class="memproto">

  465.       <table class="memname">

  466.         <tr>

  467.           <td class="memname">void SdFat::initErrorHalt_P </td>

  468.           <td>(</td>

  469.           <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>

  470.           <td class="paramname"><em>msg</em></td><td>)</td>

  471.           <td></td>

  472.         </tr>

  473.       </table>

  474. </div><div class="memdoc">

  475. <p>Print message, error details, and halt after SdFat::init() fails.</p>

  476. <dl class="params"><dt>Parameters</dt><dd>

  477.   <table class="params">

  478.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>

  479.   </table>

  480.   </dd>

  481. </dl>

  482. 

  483. </div>

  484. </div>

  485. <a class="anchor" id="ae2210d3d663bd54740eddfb83bcf4473"></a>

  486. <div class="memitem">

  487. <div class="memproto">

  488.       <table class="memname">

  489.         <tr>

  490.           <td class="memname">void SdFat::initErrorPrint </td>

  491.           <td>(</td>

  492.           <td class="paramname"></td><td>)</td>

  493.           <td></td>

  494.         </tr>

  495.       </table>

  496. </div><div class="memdoc">

  497. <p>Print error details after SdFat::init() fails. </p>

  498. 

  499. </div>

  500. </div>

  501. <a class="anchor" id="a6ea82316a10297b53393c39034d560fb"></a>

  502. <div class="memitem">

  503. <div class="memproto">

  504.       <table class="memname">

  505.         <tr>

  506.           <td class="memname">void SdFat::initErrorPrint </td>

  507.           <td>(</td>

  508.           <td class="paramtype">char const *&#160;</td>

  509.           <td class="paramname"><em>msg</em></td><td>)</td>

  510.           <td></td>

  511.         </tr>

  512.       </table>

  513. </div><div class="memdoc">

  514. <p>Print message and error details and halt after SdFat::init() fails.</p>

  515. <dl class="params"><dt>Parameters</dt><dd>

  516.   <table class="params">

  517.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  518.   </table>

  519.   </dd>

  520. </dl>

  521. 

  522. </div>

  523. </div>

  524. <a class="anchor" id="adc8cd692cbba16fae572207e329e48c3"></a>

  525. <div class="memitem">

  526. <div class="memproto">

  527.       <table class="memname">

  528.         <tr>

  529.           <td class="memname">void SdFat::initErrorPrint_P </td>

  530.           <td>(</td>

  531.           <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>

  532.           <td class="paramname"><em>msg</em></td><td>)</td>

  533.           <td></td>

  534.         </tr>

  535.       </table>

  536. </div><div class="memdoc">

  537. <p>Print message and error details after SdFat::init() fails.</p>

  538. <dl class="params"><dt>Parameters</dt><dd>

  539.   <table class="params">

  540.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message in program space (flash memory) to print. </td></tr>

  541.   </table>

  542.   </dd>

  543. </dl>

  544. 

  545. </div>

  546. </div>

  547. <a class="anchor" id="a74846855ee6cd53b1716adeaf630b12c"></a>

  548. <div class="memitem">

  549. <div class="memproto">

  550.       <table class="memname">

  551.         <tr>

  552.           <td class="memname">void SdFat::ls </td>

  553.           <td>(</td>

  554.           <td class="paramtype">uint8_t&#160;</td>

  555.           <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>

  556.           <td></td>

  557.         </tr>

  558.       </table>

  559. </div><div class="memdoc">

  560. <p>List the directory contents of the volume working directory to stdOut.</p>

  561. <dl class="params"><dt>Parameters</dt><dd>

  562.   <table class="params">

  563.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  564.   </table>

  565.   </dd>

  566. </dl>

  567. <p>LS_DATE - Print file modification date</p>

  568. <p>LS_SIZE - Print file size.</p>

  569. <p>LS_R - Recursive list of subdirectories. </p>

  570. 

  571. </div>

  572. </div>

  573. <a class="anchor" id="a89c679ba5603b771a0ac71bc79d487f3"></a>

  574. <div class="memitem">

  575. <div class="memproto">

  576.       <table class="memname">

  577.         <tr>

  578.           <td class="memname">void SdFat::ls </td>

  579.           <td>(</td>

  580.           <td class="paramtype">const char *&#160;</td>

  581.           <td class="paramname"><em>path</em>, </td>

  582.         </tr>

  583.         <tr>

  584.           <td class="paramkey"></td>

  585.           <td></td>

  586.           <td class="paramtype">uint8_t&#160;</td>

  587.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  588.         </tr>

  589.         <tr>

  590.           <td></td>

  591.           <td>)</td>

  592.           <td></td><td></td>

  593.         </tr>

  594.       </table>

  595. </div><div class="memdoc">

  596. <p>List the directory contents of the volume working directory to stdOut.</p>

  597. <dl class="params"><dt>Parameters</dt><dd>

  598.   <table class="params">

  599.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  600.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  601.   </table>

  602.   </dd>

  603. </dl>

  604. <p>LS_DATE - Print file modification date</p>

  605. <p>LS_SIZE - Print file size.</p>

  606. <p>LS_R - Recursive list of subdirectories. </p>

  607. 

  608. </div>

  609. </div>

  610. <a class="anchor" id="a039202434f459b1ec558897d32cb928c"></a>

  611. <div class="memitem">

  612. <div class="memproto">

  613.       <table class="memname">

  614.         <tr>

  615.           <td class="memname">void SdFat::ls </td>

  616.           <td>(</td>

  617.           <td class="paramtype">Print *&#160;</td>

  618.           <td class="paramname"><em>pr</em>, </td>

  619.         </tr>

  620.         <tr>

  621.           <td class="paramkey"></td>

  622.           <td></td>

  623.           <td class="paramtype">uint8_t&#160;</td>

  624.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  625.         </tr>

  626.         <tr>

  627.           <td></td>

  628.           <td>)</td>

  629.           <td></td><td></td>

  630.         </tr>

  631.       </table>

  632. </div><div class="memdoc">

  633. <p>List the directory contents of the volume working directory.</p>

  634. <dl class="params"><dt>Parameters</dt><dd>

  635.   <table class="params">

  636.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for the list.</td></tr>

  637.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  638.   </table>

  639.   </dd>

  640. </dl>

  641. <p>LS_DATE - Print file modification date</p>

  642. <p>LS_SIZE - Print file size.</p>

  643. <p>LS_R - Recursive list of subdirectories. </p>

  644. 

  645. </div>

  646. </div>

  647. <a class="anchor" id="a0a0244b881cc1a24e7c94886ac6eb9f5"></a>

  648. <div class="memitem">

  649. <div class="memproto">

  650.       <table class="memname">

  651.         <tr>

  652.           <td class="memname">void SdFat::ls </td>

  653.           <td>(</td>

  654.           <td class="paramtype">Print *&#160;</td>

  655.           <td class="paramname"><em>pr</em>, </td>

  656.         </tr>

  657.         <tr>

  658.           <td class="paramkey"></td>

  659.           <td></td>

  660.           <td class="paramtype">const char *&#160;</td>

  661.           <td class="paramname"><em>path</em>, </td>

  662.         </tr>

  663.         <tr>

  664.           <td class="paramkey"></td>

  665.           <td></td>

  666.           <td class="paramtype">uint8_t&#160;</td>

  667.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  668.         </tr>

  669.         <tr>

  670.           <td></td>

  671.           <td>)</td>

  672.           <td></td><td></td>

  673.         </tr>

  674.       </table>

  675. </div><div class="memdoc">

  676. <p>List the directory contents of the volume working directory to stdOut.</p>

  677. <dl class="params"><dt>Parameters</dt><dd>

  678.   <table class="params">

  679.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for the list.</td></tr>

  680.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  681.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  682.   </table>

  683.   </dd>

  684. </dl>

  685. <p>LS_DATE - Print file modification date</p>

  686. <p>LS_SIZE - Print file size.</p>

  687. <p>LS_R - Recursive list of subdirectories. </p>

  688. 

  689. </div>

  690. </div>

  691. <a class="anchor" id="a1fe08676296e10b4c1e30311ce35b4de"></a>

  692. <div class="memitem">

  693. <div class="memproto">

  694.       <table class="memname">

  695.         <tr>

  696.           <td class="memname">bool SdFat::mkdir </td>

  697.           <td>(</td>

  698.           <td class="paramtype">const char *&#160;</td>

  699.           <td class="paramname"><em>path</em>, </td>

  700.         </tr>

  701.         <tr>

  702.           <td class="paramkey"></td>

  703.           <td></td>

  704.           <td class="paramtype">bool&#160;</td>

  705.           <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>

  706.         </tr>

  707.         <tr>

  708.           <td></td>

  709.           <td>)</td>

  710.           <td></td><td></td>

  711.         </tr>

  712.       </table>

  713. </div><div class="memdoc">

  714. <p>Make a subdirectory in the volume working directory.</p>

  715. <dl class="params"><dt>Parameters</dt><dd>

  716.   <table class="params">

  717.     <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>

  718.     <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>

  719.   </table>

  720.   </dd>

  721. </dl>

  722. <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>

  723. 

  724. </div>

  725. </div>

  726. <a class="anchor" id="a08cf08d63ad0b439489808ea9cc95fb7"></a>

  727. <div class="memitem">

  728. <div class="memproto">

  729. <table class="mlabels">

  730.   <tr>

  731.   <td class="mlabels-left">

  732.       <table class="memname">

  733.         <tr>

  734.           <td class="memname"><a class="el" href="class_file.html">File</a> SdFat::open </td>

  735.           <td>(</td>

  736.           <td class="paramtype">const char *&#160;</td>

  737.           <td class="paramname"><em>path</em>, </td>

  738.         </tr>

  739.         <tr>

  740.           <td class="paramkey"></td>

  741.           <td></td>

  742.           <td class="paramtype">uint8_t&#160;</td>

  743.           <td class="paramname"><em>mode</em> = <code><a class="el" href="_sd_file_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>

  744.         </tr>

  745.         <tr>

  746.           <td></td>

  747.           <td>)</td>

  748.           <td></td><td></td>

  749.         </tr>

  750.       </table>

  751.   </td>

  752.   <td class="mlabels-right">

  753. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  754.   </tr>

  755. </table>

  756. </div><div class="memdoc">

  757. <p>open a file</p>

  758. <dl class="params"><dt>Parameters</dt><dd>

  759.   <table class="params">

  760.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>

  761.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>

  762.   </table>

  763.   </dd>

  764. </dl>

  765. <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>

  766. 

  767. </div>

  768. </div>

  769. <a class="anchor" id="affdaad4aeac6fc6d678b21c2a271d09d"></a>

  770. <div class="memitem">

  771. <div class="memproto">

  772.       <table class="memname">

  773.         <tr>

  774.           <td class="memname">bool SdFat::remove </td>

  775.           <td>(</td>

  776.           <td class="paramtype">const char *&#160;</td>

  777.           <td class="paramname"><em>path</em></td><td>)</td>

  778.           <td></td>

  779.         </tr>

  780.       </table>

  781. </div><div class="memdoc">

  782. <p>Remove a file from the volume working directory.</p>

  783. <dl class="params"><dt>Parameters</dt><dd>

  784.   <table class="params">

  785.     <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>

  786.   </table>

  787.   </dd>

  788. </dl>

  789. <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>

  790. 

  791. </div>

  792. </div>

  793. <a class="anchor" id="a39afa05b07c30872b27c3d2b53b56911"></a>

  794. <div class="memitem">

  795. <div class="memproto">

  796.       <table class="memname">

  797.         <tr>

  798.           <td class="memname">bool SdFat::rename </td>

  799.           <td>(</td>

  800.           <td class="paramtype">const char *&#160;</td>

  801.           <td class="paramname"><em>oldPath</em>, </td>

  802.         </tr>

  803.         <tr>

  804.           <td class="paramkey"></td>

  805.           <td></td>

  806.           <td class="paramtype">const char *&#160;</td>

  807.           <td class="paramname"><em>newPath</em>&#160;</td>

  808.         </tr>

  809.         <tr>

  810.           <td></td>

  811.           <td>)</td>

  812.           <td></td><td></td>

  813.         </tr>

  814.       </table>

  815. </div><div class="memdoc">

  816. <p>Rename a file or subdirectory.</p>

  817. <dl class="params"><dt>Parameters</dt><dd>

  818.   <table class="params">

  819.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  820.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  821.   </table>

  822.   </dd>

  823. </dl>

  824. <p>The <em>newPath</em> object must not exist before the rename call.</p>

  825. <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>

  826. <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>

  827. 

  828. </div>

  829. </div>

  830. <a class="anchor" id="a9ece030794f3fb78018cfc9803a62c69"></a>

  831. <div class="memitem">

  832. <div class="memproto">

  833.       <table class="memname">

  834.         <tr>

  835.           <td class="memname">bool SdFat::rmdir </td>

  836.           <td>(</td>

  837.           <td class="paramtype">const char *&#160;</td>

  838.           <td class="paramname"><em>path</em></td><td>)</td>

  839.           <td></td>

  840.         </tr>

  841.       </table>

  842. </div><div class="memdoc">

  843. <p>Remove a subdirectory from the volume's working directory.</p>

  844. <dl class="params"><dt>Parameters</dt><dd>

  845.   <table class="params">

  846.     <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>

  847.   </table>

  848.   </dd>

  849. </dl>

  850. <p>The subdirectory file will be removed only if it is empty.</p>

  851. <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>

  852. 

  853. </div>

  854. </div>

  855. <a class="anchor" id="a87c53828b0ccd33c77d2a8175c4cdf82"></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 void SdFat::setStdOut </td>

  864.           <td>(</td>

  865.           <td class="paramtype">Print *&#160;</td>

  866.           <td class="paramname"><em>stream</em></td><td>)</td>

  867.           <td></td>

  868.         </tr>

  869.       </table>

  870.   </td>

  871.   <td class="mlabels-right">

  872. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  873.   </tr>

  874. </table>

  875. </div><div class="memdoc">

  876. <p>Set stdOut Print stream for messages. </p><dl class="params"><dt>Parameters</dt><dd>

  877.   <table class="params">

  878.     <tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>The new Print stream. </td></tr>

  879.   </table>

  880.   </dd>

  881. </dl>

  882. 

  883. </div>

  884. </div>

  885. <a class="anchor" id="ae5f0467524c70b7a85840c291710d7ca"></a>

  886. <div class="memitem">

  887. <div class="memproto">

  888. <table class="mlabels">

  889.   <tr>

  890.   <td class="mlabels-left">

  891.       <table class="memname">

  892.         <tr>

  893.           <td class="memname">static Print* SdFat::stdOut </td>

  894.           <td>(</td>

  895.           <td class="paramname"></td><td>)</td>

  896.           <td></td>

  897.         </tr>

  898.       </table>

  899.   </td>

  900.   <td class="mlabels-right">

  901. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  902.   </tr>

  903. </table>

  904. </div><div class="memdoc">

  905. <dl class="section return"><dt>Returns</dt><dd>Print stream for messages. </dd></dl>

  906. 

  907. </div>

  908. </div>

  909. <a class="anchor" id="ac0c2ed27d37bdb1b50f4543253871c1e"></a>

  910. <div class="memitem">

  911. <div class="memproto">

  912.       <table class="memname">

  913.         <tr>

  914.           <td class="memname">bool SdFat::truncate </td>

  915.           <td>(</td>

  916.           <td class="paramtype">const char *&#160;</td>

  917.           <td class="paramname"><em>path</em>, </td>

  918.         </tr>

  919.         <tr>

  920.           <td class="paramkey"></td>

  921.           <td></td>

  922.           <td class="paramtype">uint32_t&#160;</td>

  923.           <td class="paramname"><em>length</em>&#160;</td>

  924.         </tr>

  925.         <tr>

  926.           <td></td>

  927.           <td>)</td>

  928.           <td></td><td></td>

  929.         </tr>

  930.       </table>

  931. </div><div class="memdoc">

  932. <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>

  933. <dl class="params"><dt>Parameters</dt><dd>

  934.   <table class="params">

  935.     <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>

  936.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  937.   </table>

  938.   </dd>

  939. </dl>

  940. <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>

  941. 

  942. </div>

  943. </div>

  944. <a class="anchor" id="a9fca7480532e54b828a3a31015f7c905"></a>

  945. <div class="memitem">

  946. <div class="memproto">

  947. <table class="mlabels">

  948.   <tr>

  949.   <td class="mlabels-left">

  950.       <table class="memname">

  951.         <tr>

  952.           <td class="memname"><a class="el" href="class_sd_volume.html">SdVolume</a>* SdFat::vol </td>

  953.           <td>(</td>

  954.           <td class="paramname"></td><td>)</td>

  955.           <td></td>

  956.         </tr>

  957.       </table>

  958.   </td>

  959.   <td class="mlabels-right">

  960. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  961.   </tr>

  962. </table>

  963. </div><div class="memdoc">

  964. <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>

  965. 

  966. </div>

  967. </div>

  968. <a class="anchor" id="a7027f78e1febb655009b62d7f6c10bbb"></a>

  969. <div class="memitem">

  970. <div class="memproto">

  971. <table class="mlabels">

  972.   <tr>

  973.   <td class="mlabels-left">

  974.       <table class="memname">

  975.         <tr>

  976.           <td class="memname"><a class="el" href="class_sd_base_file.html">SdBaseFile</a>* SdFat::vwd </td>

  977.           <td>(</td>

  978.           <td class="paramname"></td><td>)</td>

  979.           <td></td>

  980.         </tr>

  981.       </table>

  982.   </td>

  983.   <td class="mlabels-right">

  984. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  985.   </tr>

  986. </table>

  987. </div><div class="memdoc">

  988. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  989. 

  990. </div>

  991. </div>

  992. <hr/>The documentation for this class was generated from the following files:<ul>

  993. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  994. <li>Arduino/libraries/SdFat/SdFat.cpp</li>

  995. <li>Arduino/libraries/SdFat/SdFatErrorPrint.cpp</li>

  996. </ul>

  997. </div><!-- contents -->

  998. <!-- start footer part -->

  999. <hr class="footer"/><address class="footer"><small>

  1000. Generated on Sat Oct 25 2014 07:56:22 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  1001. <img class="footer" src="doxygen.png" alt="doxygen"/>

  1002. </a> 1.8.8

  1003. </small></address>

  1004. </body>

  1005. </html>