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.

133 lines
9.3KB

  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: Arduino/libraries/SdFat/SdFatUtil.h File 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><a href="annotated.html"><span>Classes</span></a></li>
  33. <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
  39. <li><a href="globals.html"><span>File&#160;Members</span></a></li>
  40. </ul>
  41. </div>
  42. <div id="nav-path" class="navpath">
  43. <ul>
  44. <li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1281b15c327061056ab3b326e90c50cf.html">SdFat</a></li> </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#define-members">Macros</a> &#124;
  50. <a href="#func-members">Functions</a> </div>
  51. <div class="headertitle">
  52. <div class="title">SdFatUtil.h File Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Useful utility functions.
  56. <a href="#details">More...</a></p>
  57. <div class="textblock"><code>#include &lt;<a class="el" href="_sd_fat_8h.html">SdFat.h</a>&gt;</code><br />
  58. </div><div class="textblock"><div class="dynheader">
  59. Include dependency graph for SdFatUtil.h:</div>
  60. <div class="dyncontent">
  61. <div class="center"><img src="_sd_fat_util_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_sd_fat_util_8h" alt=""/></div>
  62. <map name="_arduino_2libraries_2_sd_fat_2_sd_fat_util_8h" id="_arduino_2libraries_2_sd_fat_2_sd_fat_util_8h">
  63. <area shape="rect" id="node3" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="316,96,383,123"/> <area shape="rect" id="node5" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="314,171,384,197"/> <area shape="rect" id="node34" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="66,245,156,272"/> <area shape="rect" id="node47" href="_stdio_stream_8h.html" title="StdioStream class. " alt="" coords="410,171,515,197"/> <area shape="rect" id="node55" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="168,171,286,197"/> <area shape="rect" id="node9" href="_sd_base_file_8h.html" title="SdBaseFile class. " alt="" coords="220,544,319,571"/> <area shape="rect" id="node13" href="_sd_fat_config_8h.html" title="configuration definitions " alt="" coords="167,843,271,869"/> <area shape="rect" id="node17" href="_sd_volume_8h.html" title="SdVolume class. " alt="" coords="147,619,240,645"/> <area shape="rect" id="node20" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. " alt="" coords="275,693,358,720"/> <area shape="rect" id="node26" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="282,768,350,795"/> <area shape="rect" id="node37" href="iostream_8h.html" title="iostream class " alt="" coords="138,320,220,347"/> <area shape="rect" id="node39" href="istream_8h.html" title="istream class " alt="" coords="194,395,270,421"/> <area shape="rect" id="node44" href="ostream_8h.html" title="ostream class " alt="" coords="90,395,170,421"/> <area shape="rect" id="node41" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="207,469,258,496"/> <area shape="rect" id="node57" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="180,245,271,272"/> </map>
  64. </div>
  65. </div><table class="memberdecls">
  66. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  67. Macros</h2></td></tr>
  68. <tr class="memitem:a6d413885c384693a5c98de870c752ac5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_util_8h.html#a6d413885c384693a5c98de870c752ac5">PgmPrint</a>(x)&#160;&#160;&#160;SerialPrint_P(<a class="el" href="_sd_base_file_8h.html#a9c00057fd19e916cc1aa0a5949336beb">PSTR</a>(x))</td></tr>
  69. <tr class="separator:a6d413885c384693a5c98de870c752ac5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a3b0de03c1185b3235b3c1e8a80ef281f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_util_8h.html#a3b0de03c1185b3235b3c1e8a80ef281f">PgmPrintln</a>(x)&#160;&#160;&#160;SerialPrintln_P(<a class="el" href="_sd_base_file_8h.html#a9c00057fd19e916cc1aa0a5949336beb">PSTR</a>(x))</td></tr>
  71. <tr class="separator:a3b0de03c1185b3235b3c1e8a80ef281f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. </table><table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  74. Functions</h2></td></tr>
  75. <tr class="memitem:a9103b9a4934cfc4d5dea9e7fec7353d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><b>SdFatUtil::FreeRam</b> ()</td></tr>
  76. <tr class="separator:a9103b9a4934cfc4d5dea9e7fec7353d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ad286914ceca90b6952327d90237d3e56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><b>SdFatUtil::print_P</b> (Print *pr, <a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  78. <tr class="separator:ad286914ceca90b6952327d90237d3e56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a59f16a2fc62ff5c3af0ec2f10edaf6a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><b>SdFatUtil::println_P</b> (Print *pr, <a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  80. <tr class="separator:a59f16a2fc62ff5c3af0ec2f10edaf6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a97af8c0fb43dece0f32e5cbd36dfd34c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><b>SdFatUtil::SerialPrint_P</b> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  82. <tr class="separator:a97af8c0fb43dece0f32e5cbd36dfd34c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a9b4dae4ef11bfdf2458295c5b7ac9102"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><b>SdFatUtil::SerialPrintln_P</b> (<a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a> str)</td></tr>
  84. <tr class="separator:a9b4dae4ef11bfdf2458295c5b7ac9102"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  87. <div class="textblock"><p>Useful utility functions. </p>
  88. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  89. <a class="anchor" id="a6d413885c384693a5c98de870c752ac5"></a>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">#define PgmPrint</td>
  95. <td>(</td>
  96. <td class="paramtype">&#160;</td>
  97. <td class="paramname">x</td><td>)</td>
  98. <td>&#160;&#160;&#160;SerialPrint_P(<a class="el" href="_sd_base_file_8h.html#a9c00057fd19e916cc1aa0a5949336beb">PSTR</a>(x))</td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>Store and print a string in flash memory. </p>
  103. </div>
  104. </div>
  105. <a class="anchor" id="a3b0de03c1185b3235b3c1e8a80ef281f"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">#define PgmPrintln</td>
  111. <td>(</td>
  112. <td class="paramtype">&#160;</td>
  113. <td class="paramname">x</td><td>)</td>
  114. <td>&#160;&#160;&#160;SerialPrintln_P(<a class="el" href="_sd_base_file_8h.html#a9c00057fd19e916cc1aa0a5949336beb">PSTR</a>(x))</td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>Store and print a string in flash memory followed by a CR/LF. </p>
  119. </div>
  120. </div>
  121. </div><!-- contents -->
  122. <!-- start footer part -->
  123. <hr class="footer"/><address class="footer"><small>
  124. Generated on Sat Oct 25 2014 07:56:22 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  125. <img class="footer" src="doxygen.png" alt="doxygen"/>
  126. </a> 1.8.8
  127. </small></address>
  128. </body>
  129. </html>