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.

206 lines
8.8KB

  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: SdFatUtil Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  33. <li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
  40. <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
  41. </ul>
  42. </div>
  43. </div><!-- top -->
  44. <div class="header">
  45. <div class="summary">
  46. <a href="#func-members">Functions</a> </div>
  47. <div class="headertitle">
  48. <div class="title">SdFatUtil Namespace Reference</div> </div>
  49. </div><!--header-->
  50. <div class="contents">
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  53. Functions</h2></td></tr>
  54. <tr class="memitem:a9103b9a4934cfc4d5dea9e7fec7353d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_sd_fat_util.html#a9103b9a4934cfc4d5dea9e7fec7353d1">FreeRam</a> ()</td></tr>
  55. <tr class="separator:a9103b9a4934cfc4d5dea9e7fec7353d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ad286914ceca90b6952327d90237d3e56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_sd_fat_util.html#ad286914ceca90b6952327d90237d3e56">print_P</a> (Print *pr, <a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  57. <tr class="separator:ad286914ceca90b6952327d90237d3e56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:a59f16a2fc62ff5c3af0ec2f10edaf6a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_sd_fat_util.html#a59f16a2fc62ff5c3af0ec2f10edaf6a1">println_P</a> (Print *pr, <a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  59. <tr class="separator:a59f16a2fc62ff5c3af0ec2f10edaf6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a97af8c0fb43dece0f32e5cbd36dfd34c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_sd_fat_util.html#a97af8c0fb43dece0f32e5cbd36dfd34c">SerialPrint_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  61. <tr class="separator:a97af8c0fb43dece0f32e5cbd36dfd34c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a9b4dae4ef11bfdf2458295c5b7ac9102"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_sd_fat_util.html#a9b4dae4ef11bfdf2458295c5b7ac9102">SerialPrintln_P</a> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  63. <tr class="separator:a9b4dae4ef11bfdf2458295c5b7ac9102"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. </table>
  65. <h2 class="groupheader">Function Documentation</h2>
  66. <a class="anchor" id="a9103b9a4934cfc4d5dea9e7fec7353d1"></a>
  67. <div class="memitem">
  68. <div class="memproto">
  69. <table class="memname">
  70. <tr>
  71. <td class="memname">int SdFatUtil::FreeRam </td>
  72. <td>(</td>
  73. <td class="paramname"></td><td>)</td>
  74. <td></td>
  75. </tr>
  76. </table>
  77. </div><div class="memdoc">
  78. <p>Amount of free RAM </p>
  79. <dl class="section return"><dt>Returns</dt><dd>The number of free bytes. </dd></dl>
  80. </div>
  81. </div>
  82. <a class="anchor" id="ad286914ceca90b6952327d90237d3e56"></a>
  83. <div class="memitem">
  84. <div class="memproto">
  85. <table class="memname">
  86. <tr>
  87. <td class="memname">void SdFatUtil::print_P </td>
  88. <td>(</td>
  89. <td class="paramtype">Print *&#160;</td>
  90. <td class="paramname"><em>pr</em>, </td>
  91. </tr>
  92. <tr>
  93. <td class="paramkey"></td>
  94. <td></td>
  95. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  96. <td class="paramname"><em>str</em>&#160;</td>
  97. </tr>
  98. <tr>
  99. <td></td>
  100. <td>)</td>
  101. <td></td><td></td>
  102. </tr>
  103. </table>
  104. </div><div class="memdoc">
  105. <p>Print a string in flash memory.</p>
  106. <dl class="params"><dt>Parameters</dt><dd>
  107. <table class="params">
  108. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object for output. </td></tr>
  109. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to string stored in flash memory. </td></tr>
  110. </table>
  111. </dd>
  112. </dl>
  113. </div>
  114. </div>
  115. <a class="anchor" id="a59f16a2fc62ff5c3af0ec2f10edaf6a1"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">void SdFatUtil::println_P </td>
  121. <td>(</td>
  122. <td class="paramtype">Print *&#160;</td>
  123. <td class="paramname"><em>pr</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  129. <td class="paramname"><em>str</em>&#160;</td>
  130. </tr>
  131. <tr>
  132. <td></td>
  133. <td>)</td>
  134. <td></td><td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Print a string in flash memory followed by a CR/LF.</p>
  139. <dl class="params"><dt>Parameters</dt><dd>
  140. <table class="params">
  141. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object for output. </td></tr>
  142. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to string stored in flash memory. </td></tr>
  143. </table>
  144. </dd>
  145. </dl>
  146. </div>
  147. </div>
  148. <a class="anchor" id="a97af8c0fb43dece0f32e5cbd36dfd34c"></a>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">void SdFatUtil::SerialPrint_P </td>
  154. <td>(</td>
  155. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  156. <td class="paramname"><em>str</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Print a string in flash memory to Serial.</p>
  162. <dl class="params"><dt>Parameters</dt><dd>
  163. <table class="params">
  164. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to string stored in flash memory. </td></tr>
  165. </table>
  166. </dd>
  167. </dl>
  168. </div>
  169. </div>
  170. <a class="anchor" id="a9b4dae4ef11bfdf2458295c5b7ac9102"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void SdFatUtil::SerialPrintln_P </td>
  176. <td>(</td>
  177. <td class="paramtype"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;</td>
  178. <td class="paramname"><em>str</em></td><td>)</td>
  179. <td></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Print a string in flash memory to Serial followed by a CR/LF.</p>
  184. <dl class="params"><dt>Parameters</dt><dd>
  185. <table class="params">
  186. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to string stored in flash memory. </td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. </div>
  191. </div>
  192. </div><!-- contents -->
  193. <!-- start footer part -->
  194. <hr class="footer"/><address class="footer"><small>
  195. Generated on Sun Aug 24 2014 09:37:38 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  196. <img class="footer" src="doxygen.png" alt="doxygen"/>
  197. </a> 1.8.6
  198. </small></address>
  199. </body>
  200. </html>