visus
/
teensy-sdfat
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
3 Commity
1 Gałąź
Drzewo: 546fec6fe1
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '546fec6fe1'
${ noResults }
teensy-sdfat/html/class_sd_fat.html

977 lines
44KB
Czysty Wina Historia 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.6"/>

  7. <title>SdFat: SdFat Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  12. </head>

  13. <body>

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  15. <div id="titlearea">

  16. <table cellspacing="0" cellpadding="0">

  17.  <tbody>

  18.  <tr style="height: 56px;">

  19.   <td style="padding-left: 0.5em;">

  20.    <div id="projectname">SdFat

  21.    </div>

  22.   </td>

  23.  </tr>

  24.  </tbody>

  25. </table>

  26. </div>

  27. <!-- end header part -->

  28. <!-- Generated by Doxygen 1.8.6 -->

  29.   <div id="navrow1" class="tabs">

  30.     <ul class="tablist">

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  32.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>

  33.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  34.       <li><a href="files.html"><span>Files</span></a></li>

  35.     </ul>

  36.   </div>

  37.   <div id="navrow2" class="tabs2">

  38.     <ul class="tablist">

  39.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  40.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  41.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  42.     </ul>

  43.   </div>

  44. </div><!-- top -->

  45. <div class="header">

  46.   <div class="summary">

  47. <a href="#pub-methods">Public Member Functions</a> &#124;

  48. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  49. <a href="class_sd_fat-members.html">List of all members</a>  </div>

  50.   <div class="headertitle">

  51. <div class="title">SdFat Class Reference</div>  </div>

  52. </div><!--header-->

  53. <div class="contents">

  54. 

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

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

  57. 

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

  59. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  114. <tr class="memitem:a46857a04e227af73e0114c750ac35833"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a46857a04e227af73e0114c750ac35833">SdFat</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  129. </table>

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

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

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

  133. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  134. <a class="anchor" id="a46857a04e227af73e0114c750ac35833"></a>

  135. <div class="memitem">

  136. <div class="memproto">

  137. <table class="mlabels">

  138.   <tr>

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

  140.       <table class="memname">

  141.         <tr>

  142.           <td class="memname">SdFat::SdFat </td>

  143.           <td>(</td>

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

  145.           <td></td>

  146.         </tr>

  147.       </table>

  148.   </td>

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

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

  151.   </tr>

  152. </table>

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

  154. 

  155. </div>

  156. </div>

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

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

  159. <div class="memitem">

  160. <div class="memproto">

  161.       <table class="memname">

  162.         <tr>

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

  164.           <td>(</td>

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

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

  167.         </tr>

  168.         <tr>

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

  170.           <td></td>

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

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

  173.         </tr>

  174.         <tr>

  175.           <td></td>

  176.           <td>)</td>

  177.           <td></td><td></td>

  178.         </tr>

  179.       </table>

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

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

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

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

  184.   <table class="params">

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

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

  187.   </table>

  188.   </dd>

  189. </dl>

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

  191. 

  192. </div>

  193. </div>

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

  195. <div class="memitem">

  196. <div class="memproto">

  197. <table class="mlabels">

  198.   <tr>

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

  200.       <table class="memname">

  201.         <tr>

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

  203.           <td>(</td>

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

  205.           <td></td>

  206.         </tr>

  207.       </table>

  208.   </td>

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

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

  211.   </tr>

  212. </table>

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

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

  215. 

  216. </div>

  217. </div>

  218. <a class="anchor" id="aba234d73505354cbb105b4ad7d3524b0"></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">bool&#160;</td>

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

  227.           <td></td>

  228.         </tr>

  229.       </table>

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

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

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

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

  234.   <table class="params">

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

  236.   </table>

  237.   </dd>

  238. </dl>

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

  240. 

  241. </div>

  242. </div>

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

  244. <div class="memitem">

  245. <div class="memproto">

  246.       <table class="memname">

  247.         <tr>

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

  249.           <td>(</td>

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

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

  252.         </tr>

  253.         <tr>

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

  255.           <td></td>

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

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

  258.         </tr>

  259.         <tr>

  260.           <td></td>

  261.           <td>)</td>

  262.           <td></td><td></td>

  263.         </tr>

  264.       </table>

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

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

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

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

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

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

  271.   <table class="params">

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

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

  274.   </table>

  275.   </dd>

  276. </dl>

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

  278. 

  279. </div>

  280. </div>

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

  282. <div class="memitem">

  283. <div class="memproto">

  284.       <table class="memname">

  285.         <tr>

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

  287.           <td>(</td>

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

  289.           <td></td>

  290.         </tr>

  291.       </table>

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

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

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

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

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

  297. 

  298. </div>

  299. </div>

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

  301. <div class="memitem">

  302. <div class="memproto">

  303.       <table class="memname">

  304.         <tr>

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

  306.           <td>(</td>

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

  308.           <td></td>

  309.         </tr>

  310.       </table>

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

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

  313. 

  314. </div>

  315. </div>

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

  317. <div class="memitem">

  318. <div class="memproto">

  319.       <table class="memname">

  320.         <tr>

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

  322.           <td>(</td>

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

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

  325.           <td></td>

  326.         </tr>

  327.       </table>

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

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

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

  331.   <table class="params">

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

  333.   </table>

  334.   </dd>

  335. </dl>

  336. 

  337. </div>

  338. </div>

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

  340. <div class="memitem">

  341. <div class="memproto">

  342.       <table class="memname">

  343.         <tr>

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

  345.           <td>(</td>

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

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

  348.           <td></td>

  349.         </tr>

  350.       </table>

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

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

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

  354.   <table class="params">

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

  356.   </table>

  357.   </dd>

  358. </dl>

  359. 

  360. </div>

  361. </div>

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

  363. <div class="memitem">

  364. <div class="memproto">

  365.       <table class="memname">

  366.         <tr>

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

  368.           <td>(</td>

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

  370.           <td></td>

  371.         </tr>

  372.       </table>

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

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

  375. 

  376. </div>

  377. </div>

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

  379. <div class="memitem">

  380. <div class="memproto">

  381.       <table class="memname">

  382.         <tr>

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

  384.           <td>(</td>

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

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

  387.           <td></td>

  388.         </tr>

  389.       </table>

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

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

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

  393.   <table class="params">

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

  395.   </table>

  396.   </dd>

  397. </dl>

  398. 

  399. </div>

  400. </div>

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

  402. <div class="memitem">

  403. <div class="memproto">

  404.       <table class="memname">

  405.         <tr>

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

  407.           <td>(</td>

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

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

  410.           <td></td>

  411.         </tr>

  412.       </table>

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

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

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

  416.   <table class="params">

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

  418.   </table>

  419.   </dd>

  420. </dl>

  421. 

  422. </div>

  423. </div>

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

  425. <div class="memitem">

  426. <div class="memproto">

  427.       <table class="memname">

  428.         <tr>

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

  430.           <td>(</td>

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

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

  433.           <td></td>

  434.         </tr>

  435.       </table>

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

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

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

  439.   <table class="params">

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

  441.   </table>

  442.   </dd>

  443. </dl>

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

  445. 

  446. </div>

  447. </div>

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

  449. <div class="memitem">

  450. <div class="memproto">

  451.       <table class="memname">

  452.         <tr>

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

  454.           <td>(</td>

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

  456.           <td></td>

  457.         </tr>

  458.       </table>

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

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

  461. 

  462. </div>

  463. </div>

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

  465. <div class="memitem">

  466. <div class="memproto">

  467.       <table class="memname">

  468.         <tr>

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

  470.           <td>(</td>

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

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

  473.           <td></td>

  474.         </tr>

  475.       </table>

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

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

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

  479.   <table class="params">

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

  481.   </table>

  482.   </dd>

  483. </dl>

  484. 

  485. </div>

  486. </div>

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

  488. <div class="memitem">

  489. <div class="memproto">

  490.       <table class="memname">

  491.         <tr>

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

  493.           <td>(</td>

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

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

  496.           <td></td>

  497.         </tr>

  498.       </table>

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

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

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

  502.   <table class="params">

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

  504.   </table>

  505.   </dd>

  506. </dl>

  507. 

  508. </div>

  509. </div>

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

  511. <div class="memitem">

  512. <div class="memproto">

  513.       <table class="memname">

  514.         <tr>

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

  516.           <td>(</td>

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

  518.           <td></td>

  519.         </tr>

  520.       </table>

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

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

  523. 

  524. </div>

  525. </div>

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

  527. <div class="memitem">

  528. <div class="memproto">

  529.       <table class="memname">

  530.         <tr>

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

  532.           <td>(</td>

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

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

  535.           <td></td>

  536.         </tr>

  537.       </table>

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

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

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

  541.   <table class="params">

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

  543.   </table>

  544.   </dd>

  545. </dl>

  546. 

  547. </div>

  548. </div>

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

  550. <div class="memitem">

  551. <div class="memproto">

  552.       <table class="memname">

  553.         <tr>

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

  555.           <td>(</td>

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

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

  558.           <td></td>

  559.         </tr>

  560.       </table>

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

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

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

  564.   <table class="params">

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

  566.   </table>

  567.   </dd>

  568. </dl>

  569. 

  570. </div>

  571. </div>

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

  573. <div class="memitem">

  574. <div class="memproto">

  575.       <table class="memname">

  576.         <tr>

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

  578.           <td>(</td>

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

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

  581.           <td></td>

  582.         </tr>

  583.       </table>

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

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

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

  587.   <table class="params">

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

  589.   </table>

  590.   </dd>

  591. </dl>

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

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

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

  595. 

  596. </div>

  597. </div>

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

  599. <div class="memitem">

  600. <div class="memproto">

  601.       <table class="memname">

  602.         <tr>

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

  604.           <td>(</td>

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

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

  607.         </tr>

  608.         <tr>

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

  610.           <td></td>

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

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

  613.         </tr>

  614.         <tr>

  615.           <td></td>

  616.           <td>)</td>

  617.           <td></td><td></td>

  618.         </tr>

  619.       </table>

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

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

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

  623.   <table class="params">

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

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

  626.   </table>

  627.   </dd>

  628. </dl>

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

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

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

  632. 

  633. </div>

  634. </div>

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

  636. <div class="memitem">

  637. <div class="memproto">

  638.       <table class="memname">

  639.         <tr>

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

  641.           <td>(</td>

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

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

  644.         </tr>

  645.         <tr>

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

  647.           <td></td>

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

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

  650.         </tr>

  651.         <tr>

  652.           <td></td>

  653.           <td>)</td>

  654.           <td></td><td></td>

  655.         </tr>

  656.       </table>

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

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

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

  660.   <table class="params">

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

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

  663.   </table>

  664.   </dd>

  665. </dl>

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

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

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

  669. 

  670. </div>

  671. </div>

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

  673. <div class="memitem">

  674. <div class="memproto">

  675.       <table class="memname">

  676.         <tr>

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

  678.           <td>(</td>

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

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

  681.         </tr>

  682.         <tr>

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

  684.           <td></td>

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

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

  687.         </tr>

  688.         <tr>

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

  690.           <td></td>

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

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

  693.         </tr>

  694.         <tr>

  695.           <td></td>

  696.           <td>)</td>

  697.           <td></td><td></td>

  698.         </tr>

  699.       </table>

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

  701. 

  702. </div>

  703. </div>

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

  705. <div class="memitem">

  706. <div class="memproto">

  707.       <table class="memname">

  708.         <tr>

  709.           <td class="memname">bool SdFat::mkdir </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">bool&#160;</td>

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

  719.         </tr>

  720.         <tr>

  721.           <td></td>

  722.           <td>)</td>

  723.           <td></td><td></td>

  724.         </tr>

  725.       </table>

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

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

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

  729.   <table class="params">

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

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

  732.   </table>

  733.   </dd>

  734. </dl>

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

  736. 

  737. </div>

  738. </div>

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

  740. <div class="memitem">

  741. <div class="memproto">

  742.       <table class="memname">

  743.         <tr>

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

  745.           <td>(</td>

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

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

  748.           <td></td>

  749.         </tr>

  750.       </table>

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

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

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

  754.   <table class="params">

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

  756.   </table>

  757.   </dd>

  758. </dl>

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

  760. 

  761. </div>

  762. </div>

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

  764. <div class="memitem">

  765. <div class="memproto">

  766.       <table class="memname">

  767.         <tr>

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

  769.           <td>(</td>

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

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

  772.         </tr>

  773.         <tr>

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

  775.           <td></td>

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

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

  778.         </tr>

  779.         <tr>

  780.           <td></td>

  781.           <td>)</td>

  782.           <td></td><td></td>

  783.         </tr>

  784.       </table>

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

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

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

  788.   <table class="params">

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

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

  791.   </table>

  792.   </dd>

  793. </dl>

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

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

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

  797. 

  798. </div>

  799. </div>

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

  801. <div class="memitem">

  802. <div class="memproto">

  803.       <table class="memname">

  804.         <tr>

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

  806.           <td>(</td>

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

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

  809.           <td></td>

  810.         </tr>

  811.       </table>

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

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

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

  815.   <table class="params">

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

  817.   </table>

  818.   </dd>

  819. </dl>

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

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

  822. 

  823. </div>

  824. </div>

  825. <a class="anchor" id="a87c53828b0ccd33c77d2a8175c4cdf82"></a>

  826. <div class="memitem">

  827. <div class="memproto">

  828. <table class="mlabels">

  829.   <tr>

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

  831.       <table class="memname">

  832.         <tr>

  833.           <td class="memname">static void SdFat::setStdOut </td>

  834.           <td>(</td>

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

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

  837.           <td></td>

  838.         </tr>

  839.       </table>

  840.   </td>

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

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

  843.   </tr>

  844. </table>

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

  846. <p>Set stdOut Print stream for messages. </p>

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

  854. </div>

  855. </div>

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

  857. <div class="memitem">

  858. <div class="memproto">

  859. <table class="mlabels">

  860.   <tr>

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

  862.       <table class="memname">

  863.         <tr>

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

  865.           <td>(</td>

  866.           <td class="paramname"></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. <dl class="section return"><dt>Returns</dt><dd>Print stream for messages. </dd></dl>

  877. 

  878. </div>

  879. </div>

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

  881. <div class="memitem">

  882. <div class="memproto">

  883.       <table class="memname">

  884.         <tr>

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

  886.           <td>(</td>

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

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

  889.         </tr>

  890.         <tr>

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

  892.           <td></td>

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

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

  895.         </tr>

  896.         <tr>

  897.           <td></td>

  898.           <td>)</td>

  899.           <td></td><td></td>

  900.         </tr>

  901.       </table>

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

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

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

  905.   <table class="params">

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

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

  908.   </table>

  909.   </dd>

  910. </dl>

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

  912. 

  913. </div>

  914. </div>

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

  916. <div class="memitem">

  917. <div class="memproto">

  918. <table class="mlabels">

  919.   <tr>

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

  921.       <table class="memname">

  922.         <tr>

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

  924.           <td>(</td>

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

  926.           <td></td>

  927.         </tr>

  928.       </table>

  929.   </td>

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

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

  932.   </tr>

  933. </table>

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

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

  936. 

  937. </div>

  938. </div>

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

  940. <div class="memitem">

  941. <div class="memproto">

  942. <table class="mlabels">

  943.   <tr>

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

  945.       <table class="memname">

  946.         <tr>

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

  948.           <td>(</td>

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

  950.           <td></td>

  951.         </tr>

  952.       </table>

  953.   </td>

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

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

  956.   </tr>

  957. </table>

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

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

  960. 

  961. </div>

  962. </div>

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

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

  965. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_8cpp.html">SdFat.cpp</a></li>

  966. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_error_print_8cpp.html">SdFatErrorPrint.cpp</a></li>

  967. </ul>

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

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

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

  971. Generated on Sun Aug 24 2014 09:37:38 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  973. </a> 1.8.6

  974. </small></address>

  975. </body>

  976. </html>