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.

class_stdio_stream.html 78KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: StdioStream Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pri-methods">Private Member Functions</a> &#124;
  65. <a href="class_stdio_stream-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">StdioStream Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream.">StdioStream</a> implements a minimal stdio stream.
  71. <a href="class_stdio_stream.html#details">More...</a></p>
  72. <p><code>#include &lt;StdioStream.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for StdioStream:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_stdio_stream__inherit__graph.png" border="0" usemap="#_stdio_stream_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_stdio_stream_inherit__map" id="_stdio_stream_inherit__map">
  78. <area shape="rect" title="StdioStream implements a minimal stdio stream." alt="" coords="15,80,110,107"/>
  79. <area shape="rect" href="class_fat_file.html" title="Basic file class." alt="" coords="5,5,120,32"/>
  80. </map>
  81. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  82. <div class="dynheader">
  83. Collaboration diagram for StdioStream:</div>
  84. <div class="dyncontent">
  85. <div class="center"><img src="class_stdio_stream__coll__graph.png" border="0" usemap="#_stdio_stream_coll__map" alt="Collaboration graph"/></div>
  86. <map name="_stdio_stream_coll__map" id="_stdio_stream_coll__map">
  87. <area shape="rect" title="StdioStream implements a minimal stdio stream." alt="" coords="15,80,110,107"/>
  88. <area shape="rect" href="class_fat_file.html" title="Basic file class." alt="" coords="5,5,120,32"/>
  89. </map>
  90. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  93. Public Member Functions</h2></td></tr>
  94. <tr class="memitem:aa737e5680fc2808a03a603ea8559d82b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aa737e5680fc2808a03a603ea8559d82b">clearerr</a> ()</td></tr>
  95. <tr class="separator:aa737e5680fc2808a03a603ea8559d82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a4ddd4658d49182013d2fa2a181e96c5a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a4ddd4658d49182013d2fa2a181e96c5a">fclose</a> ()</td></tr>
  97. <tr class="separator:a4ddd4658d49182013d2fa2a181e96c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:acb38c3211feedbf2206eb1d9a3a9d24f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#acb38c3211feedbf2206eb1d9a3a9d24f">feof</a> ()</td></tr>
  99. <tr class="separator:acb38c3211feedbf2206eb1d9a3a9d24f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:afd64cec6440b923660b444f6d5f0586e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#afd64cec6440b923660b444f6d5f0586e">ferror</a> ()</td></tr>
  101. <tr class="separator:afd64cec6440b923660b444f6d5f0586e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a7ce32ec7ea3f2fd8ea42b9633890f1c0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a7ce32ec7ea3f2fd8ea42b9633890f1c0">fflush</a> ()</td></tr>
  103. <tr class="separator:a7ce32ec7ea3f2fd8ea42b9633890f1c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a160bd2828cb7e7370cffe1046eff8899"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a160bd2828cb7e7370cffe1046eff8899">fgetc</a> ()</td></tr>
  105. <tr class="separator:a160bd2828cb7e7370cffe1046eff8899"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:aa240c1021a1aad1cc57f63a483541dc7"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aa240c1021a1aad1cc57f63a483541dc7">fgets</a> (char *str, size_t num, size_t *len=0)</td></tr>
  107. <tr class="separator:aa240c1021a1aad1cc57f63a483541dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a4ffc37225fb6deed98905aa71d1f9c4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a4ffc37225fb6deed98905aa71d1f9c4b">fopen</a> (const char *path, const char *mode)</td></tr>
  109. <tr class="separator:a4ffc37225fb6deed98905aa71d1f9c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a9f23cfa6b112a5da6ae08340af23c57b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a9f23cfa6b112a5da6ae08340af23c57b">fputc</a> (int c)</td></tr>
  111. <tr class="separator:a9f23cfa6b112a5da6ae08340af23c57b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a6adea52f55ef7d97cdb54e9e11fc2daa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a6adea52f55ef7d97cdb54e9e11fc2daa">fputs</a> (const char *str)</td></tr>
  113. <tr class="separator:a6adea52f55ef7d97cdb54e9e11fc2daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a2d363b02abcef82b25ff025d50375bce"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a2d363b02abcef82b25ff025d50375bce">fread</a> (void *ptr, size_t size, size_t count)</td></tr>
  115. <tr class="separator:a2d363b02abcef82b25ff025d50375bce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a71584fd5c5cda3c31ce6cdbcc56f104d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a71584fd5c5cda3c31ce6cdbcc56f104d">fseek</a> (int32_t offset, int origin)</td></tr>
  117. <tr class="separator:a71584fd5c5cda3c31ce6cdbcc56f104d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a809639fc5fb4fa5b6789dc121659f386"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a809639fc5fb4fa5b6789dc121659f386">ftell</a> ()</td></tr>
  119. <tr class="separator:a809639fc5fb4fa5b6789dc121659f386"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ad79465afb52579cbc801f4585c3f9c25"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ad79465afb52579cbc801f4585c3f9c25">fwrite</a> (const void *ptr, size_t size, size_t count)</td></tr>
  121. <tr class="separator:ad79465afb52579cbc801f4585c3f9c25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a28ba31e7b526607744bfa41844ffce31"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a28ba31e7b526607744bfa41844ffce31">getc</a> ()</td></tr>
  123. <tr class="separator:a28ba31e7b526607744bfa41844ffce31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad3f6ee8e8ca5dcf6dabfd88199b172e2"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ad3f6ee8e8ca5dcf6dabfd88199b172e2">print</a> (char c)</td></tr>
  125. <tr class="separator:ad3f6ee8e8ca5dcf6dabfd88199b172e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aac4d7b3548d03b8fd70adf12c7ee315c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aac4d7b3548d03b8fd70adf12c7ee315c">print</a> (const __FlashStringHelper *str)</td></tr>
  127. <tr class="separator:aac4d7b3548d03b8fd70adf12c7ee315c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a1158ea5f9bf041f21b1733b7811c9bb9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a1158ea5f9bf041f21b1733b7811c9bb9">print</a> (const char *str)</td></tr>
  129. <tr class="separator:a1158ea5f9bf041f21b1733b7811c9bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a26f5b98560b6771225005b073166108b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a26f5b98560b6771225005b073166108b">print</a> (double val, uint8_t prec=2)</td></tr>
  131. <tr class="separator:a26f5b98560b6771225005b073166108b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a06b6eb9f0a7000fdcc73cd6af8d40560"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a06b6eb9f0a7000fdcc73cd6af8d40560">print</a> (float val, uint8_t prec=2)</td></tr>
  133. <tr class="separator:a06b6eb9f0a7000fdcc73cd6af8d40560"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7129f85c7c5f16867f467731ef84dee9"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  135. <tr class="memitem:a7129f85c7c5f16867f467731ef84dee9"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a7129f85c7c5f16867f467731ef84dee9">print</a> (T val)</td></tr>
  136. <tr class="separator:a7129f85c7c5f16867f467731ef84dee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ac0a907feb1e4b7e00de99857b4c0a470"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ac0a907feb1e4b7e00de99857b4c0a470">printDec</a> (char n)</td></tr>
  138. <tr class="separator:ac0a907feb1e4b7e00de99857b4c0a470"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:aaa8921947d4dbbae840d285cb633e8aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aaa8921947d4dbbae840d285cb633e8aa">printDec</a> (double value, uint8_t prec)</td></tr>
  140. <tr class="separator:aaa8921947d4dbbae840d285cb633e8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a6a09284b1c6d0769c27916a2e131e749"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a6a09284b1c6d0769c27916a2e131e749">printDec</a> (float value, uint8_t prec)</td></tr>
  142. <tr class="separator:a6a09284b1c6d0769c27916a2e131e749"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a218af88db35f38babf01d6e0a9cdceeb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a218af88db35f38babf01d6e0a9cdceeb">printDec</a> (int16_t n)</td></tr>
  144. <tr class="separator:a218af88db35f38babf01d6e0a9cdceeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ad4591f1234b57f63c1acf0f3392099ac"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ad4591f1234b57f63c1acf0f3392099ac">printDec</a> (int32_t n)</td></tr>
  146. <tr class="separator:ad4591f1234b57f63c1acf0f3392099ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a2707ea97f6113c226781469f4f39ff62"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a2707ea97f6113c226781469f4f39ff62">printDec</a> (signed char n)</td></tr>
  148. <tr class="separator:a2707ea97f6113c226781469f4f39ff62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a90b2999af94a3578fff7579c2acf8e35"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a90b2999af94a3578fff7579c2acf8e35">printDec</a> (uint16_t n)</td></tr>
  150. <tr class="separator:a90b2999af94a3578fff7579c2acf8e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a8b6c2c80342abe45e6f564e9bd5bb7ea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a8b6c2c80342abe45e6f564e9bd5bb7ea">printDec</a> (uint32_t n)</td></tr>
  152. <tr class="separator:a8b6c2c80342abe45e6f564e9bd5bb7ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a6e6ac78caa6259a4c4934707bf497a2b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a6e6ac78caa6259a4c4934707bf497a2b">printDec</a> (unsigned char n)</td></tr>
  154. <tr class="separator:a6e6ac78caa6259a4c4934707bf497a2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a4988592ada39c4b4c603b061f84d183f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a4988592ada39c4b4c603b061f84d183f">printField</a> (double value, char term, uint8_t prec=2)</td></tr>
  156. <tr class="separator:a4988592ada39c4b4c603b061f84d183f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a3b90b2317cc391f94784a847f5313c08"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a3b90b2317cc391f94784a847f5313c08">printField</a> (float value, char term, uint8_t prec=2)</td></tr>
  158. <tr class="separator:a3b90b2317cc391f94784a847f5313c08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a02c2ad1a2e71e82d238b8386cf3e6c41"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  160. <tr class="memitem:a02c2ad1a2e71e82d238b8386cf3e6c41"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a02c2ad1a2e71e82d238b8386cf3e6c41">printField</a> (T value, char term)</td></tr>
  161. <tr class="separator:a02c2ad1a2e71e82d238b8386cf3e6c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:add39b2b4ec3daa7c8922e96ce5d368bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#add39b2b4ec3daa7c8922e96ce5d368bc">printHex</a> (uint32_t n)</td></tr>
  163. <tr class="separator:add39b2b4ec3daa7c8922e96ce5d368bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:aec6ebea511489b0ef6b61d9132d93af9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aec6ebea511489b0ef6b61d9132d93af9">printHexln</a> (uint32_t n)</td></tr>
  165. <tr class="separator:aec6ebea511489b0ef6b61d9132d93af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:ad0cd3acc05a91456f505752377bd405a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ad0cd3acc05a91456f505752377bd405a">println</a> ()</td></tr>
  167. <tr class="separator:ad0cd3acc05a91456f505752377bd405a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a3793dd66cf347a1ca0b7b167e948cce9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a3793dd66cf347a1ca0b7b167e948cce9">println</a> (double val, uint8_t prec=2)</td></tr>
  169. <tr class="separator:a3793dd66cf347a1ca0b7b167e948cce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:aac250d041a7844c8db1cbd2d97ecfdaa"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#aac250d041a7844c8db1cbd2d97ecfdaa">println</a> (float val, uint8_t prec=2)</td></tr>
  171. <tr class="separator:aac250d041a7844c8db1cbd2d97ecfdaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a3b14532768d07e6ed89c762d04792c12"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  173. <tr class="memitem:a3b14532768d07e6ed89c762d04792c12"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a3b14532768d07e6ed89c762d04792c12">println</a> (T val)</td></tr>
  174. <tr class="separator:a3b14532768d07e6ed89c762d04792c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:adf9e552212aad6fc2284da0ee62d04dc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#adf9e552212aad6fc2284da0ee62d04dc">putc</a> (int c)</td></tr>
  176. <tr class="separator:adf9e552212aad6fc2284da0ee62d04dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a09ccc4b6cabc3502c1052e85d94e84ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a09ccc4b6cabc3502c1052e85d94e84ef">putCRLF</a> ()</td></tr>
  178. <tr class="separator:a09ccc4b6cabc3502c1052e85d94e84ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:ad985866675193d2ee1dde9e27b0d08da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ad985866675193d2ee1dde9e27b0d08da">rewind</a> ()</td></tr>
  180. <tr class="separator:ad985866675193d2ee1dde9e27b0d08da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a96b2c027e76bfca6d6835c9ae1be2ad2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#a96b2c027e76bfca6d6835c9ae1be2ad2">StdioStream</a> ()</td></tr>
  182. <tr class="separator:a96b2c027e76bfca6d6835c9ae1be2ad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:ac00e0dd906c2e857ece53794c6c92786"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html#ac00e0dd906c2e857ece53794c6c92786">ungetc</a> (int c)</td></tr>
  184. <tr class="separator:ac00e0dd906c2e857ece53794c6c92786"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table><table class="memberdecls">
  186. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
  187. Private Member Functions</h2></td></tr>
  188. <tr class="memitem:a9e05a51767f7c8f70c6f337eecbdca03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets</a> (char *str, int num, char *delim=<a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>
  189. <tr class="separator:a9e05a51767f7c8f70c6f337eecbdca03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  191. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8f906be79086f38943cb0911310d67bf">printField</a> (Type value, char term)</td></tr>
  192. <tr class="separator:a8f906be79086f38943cb0911310d67bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a081dd810835f1ebf8c23ffe92706b485"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write</a> (const char *str)</td></tr>
  194. <tr class="separator:a081dd810835f1ebf8c23ffe92706b485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:ae51e724ac6cc3d67d64a5a666d5850f1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae51e724ac6cc3d67d64a5a666d5850f1">write</a> (uint8_t b)</td></tr>
  196. <tr class="separator:ae51e724ac6cc3d67d64a5a666d5850f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. </table>
  198. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  199. <div class="textblock"><p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream.">StdioStream</a> implements a minimal stdio stream. </p>
  200. <p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream.">StdioStream</a> does not support subdirectories or long file names. </p>
  201. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  202. <a id="a96b2c027e76bfca6d6835c9ae1be2ad2"></a>
  203. <h2 class="memtitle"><span class="permalink"><a href="#a96b2c027e76bfca6d6835c9ae1be2ad2">&#9670;&nbsp;</a></span>StdioStream()</h2>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">StdioStream::StdioStream </td>
  212. <td>(</td>
  213. <td class="paramname"></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Constructor </p>
  224. </div>
  225. </div>
  226. <h2 class="groupheader">Member Function Documentation</h2>
  227. <a id="aa737e5680fc2808a03a603ea8559d82b"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#aa737e5680fc2808a03a603ea8559d82b">&#9670;&nbsp;</a></span>clearerr()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void StdioStream::clearerr </td>
  237. <td>(</td>
  238. <td class="paramname"></td><td>)</td>
  239. <td></td>
  240. </tr>
  241. </table>
  242. </td>
  243. <td class="mlabels-right">
  244. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Clear the stream's end-of-file and error indicators. </p>
  249. </div>
  250. </div>
  251. <a id="a4ddd4658d49182013d2fa2a181e96c5a"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a4ddd4658d49182013d2fa2a181e96c5a">&#9670;&nbsp;</a></span>fclose()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">int StdioStream::fclose </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Close a stream.</p>
  265. <p>A successful call to the fclose function causes the stream to be flushed and the associated file to be closed. Any unwritten buffered data is written to the file; any unread buffered data is discarded. Whether or not the call succeeds, the stream is disassociated from the file.</p>
  266. <dl class="section return"><dt>Returns</dt><dd>zero if the stream was successfully closed, or EOF if any any errors are detected.</dd></dl>
  267. <p>Copyright (c) 2011-2019 Bill Greiman This file is part of the SdFat library for SD memory cards.</p>
  268. <p>MIT License</p>
  269. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
  270. <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
  271. <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
  272. </div>
  273. </div>
  274. <a id="acb38c3211feedbf2206eb1d9a3a9d24f"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#acb38c3211feedbf2206eb1d9a3a9d24f">&#9670;&nbsp;</a></span>feof()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="mlabels">
  279. <tr>
  280. <td class="mlabels-left">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">int StdioStream::feof </td>
  284. <td>(</td>
  285. <td class="paramname"></td><td>)</td>
  286. <td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Test the stream's end-of-file indicator. </p><dl class="section return"><dt>Returns</dt><dd>non-zero if and only if the end-of-file indicator is set. </dd></dl>
  296. </div>
  297. </div>
  298. <a id="afd64cec6440b923660b444f6d5f0586e"></a>
  299. <h2 class="memtitle"><span class="permalink"><a href="#afd64cec6440b923660b444f6d5f0586e">&#9670;&nbsp;</a></span>ferror()</h2>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">int StdioStream::ferror </td>
  308. <td>(</td>
  309. <td class="paramname"></td><td>)</td>
  310. <td></td>
  311. </tr>
  312. </table>
  313. </td>
  314. <td class="mlabels-right">
  315. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Test the stream's error indicator. </p><dl class="section return"><dt>Returns</dt><dd>return non-zero if and only if the error indicator is set. </dd></dl>
  320. </div>
  321. </div>
  322. <a id="a7ce32ec7ea3f2fd8ea42b9633890f1c0"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#a7ce32ec7ea3f2fd8ea42b9633890f1c0">&#9670;&nbsp;</a></span>fflush()</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">int StdioStream::fflush </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Flush the stream.</p>
  336. <p>If stream is an output stream or an update stream in which the most recent operation was not input, any unwritten data is written to the file; otherwise the call is an error since any buffered input data would be lost.</p>
  337. <dl class="section return"><dt>Returns</dt><dd>sets the error indicator for the stream and returns EOF if an error occurs, otherwise it returns zero. </dd></dl>
  338. </div>
  339. </div>
  340. <a id="a160bd2828cb7e7370cffe1046eff8899"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a160bd2828cb7e7370cffe1046eff8899">&#9670;&nbsp;</a></span>fgetc()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">int StdioStream::fgetc </td>
  350. <td>(</td>
  351. <td class="paramname"></td><td>)</td>
  352. <td></td>
  353. </tr>
  354. </table>
  355. </td>
  356. <td class="mlabels-right">
  357. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>Get a byte from the stream.</p>
  362. <dl class="section return"><dt>Returns</dt><dd>If the end-of-file indicator for the stream is set, or if the stream is at end-of-file, the end-of-file indicator for the stream is set and the fgetc function returns EOF. Otherwise, the fgetc function returns the next character from the input stream. </dd></dl>
  363. </div>
  364. </div>
  365. <a id="aa240c1021a1aad1cc57f63a483541dc7"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#aa240c1021a1aad1cc57f63a483541dc7">&#9670;&nbsp;</a></span>fgets()</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">char * StdioStream::fgets </td>
  372. <td>(</td>
  373. <td class="paramtype">char *&#160;</td>
  374. <td class="paramname"><em>str</em>, </td>
  375. </tr>
  376. <tr>
  377. <td class="paramkey"></td>
  378. <td></td>
  379. <td class="paramtype">size_t&#160;</td>
  380. <td class="paramname"><em>num</em>, </td>
  381. </tr>
  382. <tr>
  383. <td class="paramkey"></td>
  384. <td></td>
  385. <td class="paramtype">size_t *&#160;</td>
  386. <td class="paramname"><em>len</em> = <code>0</code>&#160;</td>
  387. </tr>
  388. <tr>
  389. <td></td>
  390. <td>)</td>
  391. <td></td><td></td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>Get a string from a stream.</p>
  396. <p>The fgets function reads at most one less than the number of characters specified by num from the stream into the array pointed to by str. No additional characters are read after a new-line character (which is retained) or after end-of-file. A null character is written immediately after the last character read into the array.</p>
  397. <dl class="params"><dt>Parameters</dt><dd>
  398. <table class="params">
  399. <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to an array of where the string is copied.</td></tr>
  400. <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Maximum number of characters including the null character.</td></tr>
  401. <tr><td class="paramdir">[out]</td><td class="paramname">len</td><td>If len is not null and fgets is successful, the length of the string is returned.</td></tr>
  402. </table>
  403. </dd>
  404. </dl>
  405. <dl class="section return"><dt>Returns</dt><dd>str if successful. If end-of-file is encountered and no characters have been read into the array, the contents of the array remain unchanged and a null pointer is returned. If a read error occurs during the operation, the array contents are indeterminate and a null pointer is returned. </dd></dl>
  406. </div>
  407. </div>
  408. <a id="a4ffc37225fb6deed98905aa71d1f9c4b"></a>
  409. <h2 class="memtitle"><span class="permalink"><a href="#a4ffc37225fb6deed98905aa71d1f9c4b">&#9670;&nbsp;</a></span>fopen()</h2>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname">bool StdioStream::fopen </td>
  415. <td>(</td>
  416. <td class="paramtype">const char *&#160;</td>
  417. <td class="paramname"><em>path</em>, </td>
  418. </tr>
  419. <tr>
  420. <td class="paramkey"></td>
  421. <td></td>
  422. <td class="paramtype">const char *&#160;</td>
  423. <td class="paramname"><em>mode</em>&#160;</td>
  424. </tr>
  425. <tr>
  426. <td></td>
  427. <td>)</td>
  428. <td></td><td></td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Open a stream.</p>
  433. <p>Open a file and associates the stream with it.</p>
  434. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>file to be opened.</td></tr>
  437. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>a string that indicates the open mode.</td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <table class="doxtable">
  442. <tr>
  443. <td>"r" or "rb" </td><td>Open a file for reading. The file must exist. </td></tr>
  444. <tr>
  445. <td>"w" or "wb" </td><td>Truncate an existing to zero length or create an empty file for writing. </td></tr>
  446. <tr>
  447. <td>"wx" or "wbx" </td><td>Create a file for writing. Fails if the file already exists. </td></tr>
  448. <tr>
  449. <td>"a" or "ab" </td><td>Append; open or create file for writing at end-of-file. </td></tr>
  450. <tr>
  451. <td>"r+" or "rb+" or "r+b" </td><td>Open a file for update (reading and writing). </td></tr>
  452. <tr>
  453. <td>"w+" or "w+b" or "wb+" </td><td>Truncate an existing to zero length or create a file for update. </td></tr>
  454. <tr>
  455. <td>"w+x" or "w+bx" or "wb+x" </td><td>Create a file for update. Fails if the file already exists. </td></tr>
  456. <tr>
  457. <td>"a+" or "a+b" or "ab+" </td><td>Append; open or create a file for update, writing at end-of-file. </td></tr>
  458. </table>
  459. <p>The character 'b' shall have no effect, but is allowed for ISO C standard conformance.</p>
  460. <p>Opening a file with append mode causes all subsequent writes to the file to be forced to the then current end-of-file, regardless of intervening calls to the fseek function.</p>
  461. <p>When a file is opened with update mode, both input and output may be performed on the associated stream. However, output shall not be directly followed by input without an intervening call to the fflush function or to a file positioning function (fseek, or rewind), and input shall not be directly followed by output without an intervening call to a file positioning function, unless the input operation encounters end-of-file.</p>
  462. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  463. </div>
  464. </div>
  465. <a id="a9f23cfa6b112a5da6ae08340af23c57b"></a>
  466. <h2 class="memtitle"><span class="permalink"><a href="#a9f23cfa6b112a5da6ae08340af23c57b">&#9670;&nbsp;</a></span>fputc()</h2>
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="mlabels">
  470. <tr>
  471. <td class="mlabels-left">
  472. <table class="memname">
  473. <tr>
  474. <td class="memname">int StdioStream::fputc </td>
  475. <td>(</td>
  476. <td class="paramtype">int&#160;</td>
  477. <td class="paramname"><em>c</em></td><td>)</td>
  478. <td></td>
  479. </tr>
  480. </table>
  481. </td>
  482. <td class="mlabels-right">
  483. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <p>Write a byte to a stream.</p>
  488. <dl class="params"><dt>Parameters</dt><dd>
  489. <table class="params">
  490. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>the byte to be written (converted to an unsigned char).</td></tr>
  491. </table>
  492. </dd>
  493. </dl>
  494. <dl class="section return"><dt>Returns</dt><dd>Upon successful completion, <a class="el" href="class_stdio_stream.html#a9f23cfa6b112a5da6ae08340af23c57b">fputc()</a> returns the value it has written. Otherwise, it returns EOF and sets the error indicator for the stream. </dd></dl>
  495. </div>
  496. </div>
  497. <a id="a6adea52f55ef7d97cdb54e9e11fc2daa"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#a6adea52f55ef7d97cdb54e9e11fc2daa">&#9670;&nbsp;</a></span>fputs()</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">int StdioStream::fputs </td>
  504. <td>(</td>
  505. <td class="paramtype">const char *&#160;</td>
  506. <td class="paramname"><em>str</em></td><td>)</td>
  507. <td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Write a string to a stream.</p>
  512. <dl class="params"><dt>Parameters</dt><dd>
  513. <table class="params">
  514. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>a pointer to the string to be written.</td></tr>
  515. </table>
  516. </dd>
  517. </dl>
  518. <dl class="section return"><dt>Returns</dt><dd>for success, <a class="el" href="class_stdio_stream.html#a6adea52f55ef7d97cdb54e9e11fc2daa">fputs()</a> returns a non-negative number. Otherwise, it returns EOF and sets the error indicator for the stream. </dd></dl>
  519. </div>
  520. </div>
  521. <a id="a2d363b02abcef82b25ff025d50375bce"></a>
  522. <h2 class="memtitle"><span class="permalink"><a href="#a2d363b02abcef82b25ff025d50375bce">&#9670;&nbsp;</a></span>fread()</h2>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">size_t StdioStream::fread </td>
  528. <td>(</td>
  529. <td class="paramtype">void *&#160;</td>
  530. <td class="paramname"><em>ptr</em>, </td>
  531. </tr>
  532. <tr>
  533. <td class="paramkey"></td>
  534. <td></td>
  535. <td class="paramtype">size_t&#160;</td>
  536. <td class="paramname"><em>size</em>, </td>
  537. </tr>
  538. <tr>
  539. <td class="paramkey"></td>
  540. <td></td>
  541. <td class="paramtype">size_t&#160;</td>
  542. <td class="paramname"><em>count</em>&#160;</td>
  543. </tr>
  544. <tr>
  545. <td></td>
  546. <td>)</td>
  547. <td></td><td></td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Binary input.</p>
  552. <p>Reads an array of up to count elements, each one with a size of size bytes. </p><dl class="params"><dt>Parameters</dt><dd>
  553. <table class="params">
  554. <tr><td class="paramdir">[out]</td><td class="paramname">ptr</td><td>pointer to area of at least (size*count) bytes where the data will be stored.</td></tr>
  555. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the size, in bytes, of each element to be read.</td></tr>
  556. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>the number of elements to be read.</td></tr>
  557. </table>
  558. </dd>
  559. </dl>
  560. <dl class="section return"><dt>Returns</dt><dd>number of elements successfully read, which may be less than count if a read error or end-of-file is encountered. If size or count is zero, fread returns zero and the contents of the array and the state of the stream remain unchanged. </dd></dl>
  561. </div>
  562. </div>
  563. <a id="a71584fd5c5cda3c31ce6cdbcc56f104d"></a>
  564. <h2 class="memtitle"><span class="permalink"><a href="#a71584fd5c5cda3c31ce6cdbcc56f104d">&#9670;&nbsp;</a></span>fseek()</h2>
  565. <div class="memitem">
  566. <div class="memproto">
  567. <table class="memname">
  568. <tr>
  569. <td class="memname">int StdioStream::fseek </td>
  570. <td>(</td>
  571. <td class="paramtype">int32_t&#160;</td>
  572. <td class="paramname"><em>offset</em>, </td>
  573. </tr>
  574. <tr>
  575. <td class="paramkey"></td>
  576. <td></td>
  577. <td class="paramtype">int&#160;</td>
  578. <td class="paramname"><em>origin</em>&#160;</td>
  579. </tr>
  580. <tr>
  581. <td></td>
  582. <td>)</td>
  583. <td></td><td></td>
  584. </tr>
  585. </table>
  586. </div><div class="memdoc">
  587. <p>Set the file position for the stream.</p>
  588. <dl class="params"><dt>Parameters</dt><dd>
  589. <table class="params">
  590. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>number of offset from the origin.</td></tr>
  591. <tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>position used as reference for the offset. It is specified by one of the following constants.</td></tr>
  592. </table>
  593. </dd>
  594. </dl>
  595. <p>SEEK_SET - Beginning of file.</p>
  596. <p>SEEK_CUR - Current position of the file pointer.</p>
  597. <p>SEEK_END - End of file.</p>
  598. <dl class="section return"><dt>Returns</dt><dd>zero for success. Otherwise, it returns non-zero and sets the error indicator for the stream. </dd></dl>
  599. </div>
  600. </div>
  601. <a id="a809639fc5fb4fa5b6789dc121659f386"></a>
  602. <h2 class="memtitle"><span class="permalink"><a href="#a809639fc5fb4fa5b6789dc121659f386">&#9670;&nbsp;</a></span>ftell()</h2>
  603. <div class="memitem">
  604. <div class="memproto">
  605. <table class="memname">
  606. <tr>
  607. <td class="memname">int32_t StdioStream::ftell </td>
  608. <td>(</td>
  609. <td class="paramname"></td><td>)</td>
  610. <td></td>
  611. </tr>
  612. </table>
  613. </div><div class="memdoc">
  614. <p>Get the current position in a stream.</p>
  615. <dl class="section return"><dt>Returns</dt><dd>If successful, ftell return the current value of the position indicator. On failure, ftell returns −1L. </dd></dl>
  616. </div>
  617. </div>
  618. <a id="ad79465afb52579cbc801f4585c3f9c25"></a>
  619. <h2 class="memtitle"><span class="permalink"><a href="#ad79465afb52579cbc801f4585c3f9c25">&#9670;&nbsp;</a></span>fwrite()</h2>
  620. <div class="memitem">
  621. <div class="memproto">
  622. <table class="memname">
  623. <tr>
  624. <td class="memname">size_t StdioStream::fwrite </td>
  625. <td>(</td>
  626. <td class="paramtype">const void *&#160;</td>
  627. <td class="paramname"><em>ptr</em>, </td>
  628. </tr>
  629. <tr>
  630. <td class="paramkey"></td>
  631. <td></td>
  632. <td class="paramtype">size_t&#160;</td>
  633. <td class="paramname"><em>size</em>, </td>
  634. </tr>
  635. <tr>
  636. <td class="paramkey"></td>
  637. <td></td>
  638. <td class="paramtype">size_t&#160;</td>
  639. <td class="paramname"><em>count</em>&#160;</td>
  640. </tr>
  641. <tr>
  642. <td></td>
  643. <td>)</td>
  644. <td></td><td></td>
  645. </tr>
  646. </table>
  647. </div><div class="memdoc">
  648. <p>Binary output.</p>
  649. <p>Writes an array of up to count elements, each one with a size of size bytes. </p><dl class="params"><dt>Parameters</dt><dd>
  650. <table class="params">
  651. <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>pointer to (size*count) bytes of data to be written.</td></tr>
  652. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>the size, in bytes, of each element to be written.</td></tr>
  653. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>the number of elements to be written.</td></tr>
  654. </table>
  655. </dd>
  656. </dl>
  657. <dl class="section return"><dt>Returns</dt><dd>number of elements successfully written. if this number is less than count, an error has occurred. If size or count is zero, fwrite returns zero. </dd></dl>
  658. </div>
  659. </div>
  660. <a id="a28ba31e7b526607744bfa41844ffce31"></a>
  661. <h2 class="memtitle"><span class="permalink"><a href="#a28ba31e7b526607744bfa41844ffce31">&#9670;&nbsp;</a></span>getc()</h2>
  662. <div class="memitem">
  663. <div class="memproto">
  664. <table class="mlabels">
  665. <tr>
  666. <td class="mlabels-left">
  667. <table class="memname">
  668. <tr>
  669. <td class="memname">int StdioStream::getc </td>
  670. <td>(</td>
  671. <td class="paramname"></td><td>)</td>
  672. <td></td>
  673. </tr>
  674. </table>
  675. </td>
  676. <td class="mlabels-right">
  677. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  678. </tr>
  679. </table>
  680. </div><div class="memdoc">
  681. <p>Get a byte from the stream.</p>
  682. <p>getc and fgetc are equivalent but getc is in-line so it is faster but require more flash memory.</p>
  683. <dl class="section return"><dt>Returns</dt><dd>If the end-of-file indicator for the stream is set, or if the stream is at end-of-file, the end-of-file indicator for the stream is set and the fgetc function returns EOF. Otherwise, the fgetc function returns the next character from the input stream. </dd></dl>
  684. </div>
  685. </div>
  686. <a id="ad3f6ee8e8ca5dcf6dabfd88199b172e2"></a>
  687. <h2 class="memtitle"><span class="permalink"><a href="#ad3f6ee8e8ca5dcf6dabfd88199b172e2">&#9670;&nbsp;</a></span>print() <span class="overload">[1/6]</span></h2>
  688. <div class="memitem">
  689. <div class="memproto">
  690. <table class="mlabels">
  691. <tr>
  692. <td class="mlabels-left">
  693. <table class="memname">
  694. <tr>
  695. <td class="memname">size_t StdioStream::print </td>
  696. <td>(</td>
  697. <td class="paramtype">char&#160;</td>
  698. <td class="paramname"><em>c</em></td><td>)</td>
  699. <td></td>
  700. </tr>
  701. </table>
  702. </td>
  703. <td class="mlabels-right">
  704. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  705. </tr>
  706. </table>
  707. </div><div class="memdoc">
  708. <p>Write a character. </p><dl class="params"><dt>Parameters</dt><dd>
  709. <table class="params">
  710. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>the character to write. </td></tr>
  711. </table>
  712. </dd>
  713. </dl>
  714. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  715. </div>
  716. </div>
  717. <a id="aac4d7b3548d03b8fd70adf12c7ee315c"></a>
  718. <h2 class="memtitle"><span class="permalink"><a href="#aac4d7b3548d03b8fd70adf12c7ee315c">&#9670;&nbsp;</a></span>print() <span class="overload">[2/6]</span></h2>
  719. <div class="memitem">
  720. <div class="memproto">
  721. <table class="memname">
  722. <tr>
  723. <td class="memname">size_t StdioStream::print </td>
  724. <td>(</td>
  725. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  726. <td class="paramname"><em>str</em></td><td>)</td>
  727. <td></td>
  728. </tr>
  729. </table>
  730. </div><div class="memdoc">
  731. <p>Print a string stored in flash memory.</p>
  732. <dl class="params"><dt>Parameters</dt><dd>
  733. <table class="params">
  734. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>the string to print.</td></tr>
  735. </table>
  736. </dd>
  737. </dl>
  738. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  739. </div>
  740. </div>
  741. <a id="a1158ea5f9bf041f21b1733b7811c9bb9"></a>
  742. <h2 class="memtitle"><span class="permalink"><a href="#a1158ea5f9bf041f21b1733b7811c9bb9">&#9670;&nbsp;</a></span>print() <span class="overload">[3/6]</span></h2>
  743. <div class="memitem">
  744. <div class="memproto">
  745. <table class="mlabels">
  746. <tr>
  747. <td class="mlabels-left">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">size_t StdioStream::print </td>
  751. <td>(</td>
  752. <td class="paramtype">const char *&#160;</td>
  753. <td class="paramname"><em>str</em></td><td>)</td>
  754. <td></td>
  755. </tr>
  756. </table>
  757. </td>
  758. <td class="mlabels-right">
  759. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  760. </tr>
  761. </table>
  762. </div><div class="memdoc">
  763. <p>Write a string.</p>
  764. <dl class="params"><dt>Parameters</dt><dd>
  765. <table class="params">
  766. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>the string to be written.</td></tr>
  767. </table>
  768. </dd>
  769. </dl>
  770. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  771. </div>
  772. </div>
  773. <a id="a26f5b98560b6771225005b073166108b"></a>
  774. <h2 class="memtitle"><span class="permalink"><a href="#a26f5b98560b6771225005b073166108b">&#9670;&nbsp;</a></span>print() <span class="overload">[4/6]</span></h2>
  775. <div class="memitem">
  776. <div class="memproto">
  777. <table class="mlabels">
  778. <tr>
  779. <td class="mlabels-left">
  780. <table class="memname">
  781. <tr>
  782. <td class="memname">size_t StdioStream::print </td>
  783. <td>(</td>
  784. <td class="paramtype">double&#160;</td>
  785. <td class="paramname"><em>val</em>, </td>
  786. </tr>
  787. <tr>
  788. <td class="paramkey"></td>
  789. <td></td>
  790. <td class="paramtype">uint8_t&#160;</td>
  791. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  792. </tr>
  793. <tr>
  794. <td></td>
  795. <td>)</td>
  796. <td></td><td></td>
  797. </tr>
  798. </table>
  799. </td>
  800. <td class="mlabels-right">
  801. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  802. </tr>
  803. </table>
  804. </div><div class="memdoc">
  805. <p>Print a floating point number.</p>
  806. <dl class="params"><dt>Parameters</dt><dd>
  807. <table class="params">
  808. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point.</td></tr>
  809. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the number to be printed.</td></tr>
  810. </table>
  811. </dd>
  812. </dl>
  813. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  814. </div>
  815. </div>
  816. <a id="a06b6eb9f0a7000fdcc73cd6af8d40560"></a>
  817. <h2 class="memtitle"><span class="permalink"><a href="#a06b6eb9f0a7000fdcc73cd6af8d40560">&#9670;&nbsp;</a></span>print() <span class="overload">[5/6]</span></h2>
  818. <div class="memitem">
  819. <div class="memproto">
  820. <table class="mlabels">
  821. <tr>
  822. <td class="mlabels-left">
  823. <table class="memname">
  824. <tr>
  825. <td class="memname">size_t StdioStream::print </td>
  826. <td>(</td>
  827. <td class="paramtype">float&#160;</td>
  828. <td class="paramname"><em>val</em>, </td>
  829. </tr>
  830. <tr>
  831. <td class="paramkey"></td>
  832. <td></td>
  833. <td class="paramtype">uint8_t&#160;</td>
  834. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  835. </tr>
  836. <tr>
  837. <td></td>
  838. <td>)</td>
  839. <td></td><td></td>
  840. </tr>
  841. </table>
  842. </td>
  843. <td class="mlabels-right">
  844. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  845. </tr>
  846. </table>
  847. </div><div class="memdoc">
  848. <p>Print a floating point number.</p>
  849. <dl class="params"><dt>Parameters</dt><dd>
  850. <table class="params">
  851. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point.</td></tr>
  852. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the number to be printed.</td></tr>
  853. </table>
  854. </dd>
  855. </dl>
  856. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  857. </div>
  858. </div>
  859. <a id="a7129f85c7c5f16867f467731ef84dee9"></a>
  860. <h2 class="memtitle"><span class="permalink"><a href="#a7129f85c7c5f16867f467731ef84dee9">&#9670;&nbsp;</a></span>print() <span class="overload">[6/6]</span></h2>
  861. <div class="memitem">
  862. <div class="memproto">
  863. <div class="memtemplate">
  864. template&lt;typename T &gt; </div>
  865. <table class="mlabels">
  866. <tr>
  867. <td class="mlabels-left">
  868. <table class="memname">
  869. <tr>
  870. <td class="memname">size_t StdioStream::print </td>
  871. <td>(</td>
  872. <td class="paramtype">T&#160;</td>
  873. <td class="paramname"><em>val</em></td><td>)</td>
  874. <td></td>
  875. </tr>
  876. </table>
  877. </td>
  878. <td class="mlabels-right">
  879. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  880. </tr>
  881. </table>
  882. </div><div class="memdoc">
  883. <p>Print a number.</p>
  884. <dl class="params"><dt>Parameters</dt><dd>
  885. <table class="params">
  886. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the number to be printed.</td></tr>
  887. </table>
  888. </dd>
  889. </dl>
  890. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  891. </div>
  892. </div>
  893. <a id="ac0a907feb1e4b7e00de99857b4c0a470"></a>
  894. <h2 class="memtitle"><span class="permalink"><a href="#ac0a907feb1e4b7e00de99857b4c0a470">&#9670;&nbsp;</a></span>printDec() <span class="overload">[1/9]</span></h2>
  895. <div class="memitem">
  896. <div class="memproto">
  897. <table class="mlabels">
  898. <tr>
  899. <td class="mlabels-left">
  900. <table class="memname">
  901. <tr>
  902. <td class="memname">int StdioStream::printDec </td>
  903. <td>(</td>
  904. <td class="paramtype">char&#160;</td>
  905. <td class="paramname"><em>n</em></td><td>)</td>
  906. <td></td>
  907. </tr>
  908. </table>
  909. </td>
  910. <td class="mlabels-right">
  911. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  912. </tr>
  913. </table>
  914. </div><div class="memdoc">
  915. <p>Print a char as a number. </p><dl class="params"><dt>Parameters</dt><dd>
  916. <table class="params">
  917. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  918. </table>
  919. </dd>
  920. </dl>
  921. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  922. </div>
  923. </div>
  924. <a id="aaa8921947d4dbbae840d285cb633e8aa"></a>
  925. <h2 class="memtitle"><span class="permalink"><a href="#aaa8921947d4dbbae840d285cb633e8aa">&#9670;&nbsp;</a></span>printDec() <span class="overload">[2/9]</span></h2>
  926. <div class="memitem">
  927. <div class="memproto">
  928. <table class="mlabels">
  929. <tr>
  930. <td class="mlabels-left">
  931. <table class="memname">
  932. <tr>
  933. <td class="memname">int StdioStream::printDec </td>
  934. <td>(</td>
  935. <td class="paramtype">double&#160;</td>
  936. <td class="paramname"><em>value</em>, </td>
  937. </tr>
  938. <tr>
  939. <td class="paramkey"></td>
  940. <td></td>
  941. <td class="paramtype">uint8_t&#160;</td>
  942. <td class="paramname"><em>prec</em>&#160;</td>
  943. </tr>
  944. <tr>
  945. <td></td>
  946. <td>)</td>
  947. <td></td><td></td>
  948. </tr>
  949. </table>
  950. </td>
  951. <td class="mlabels-right">
  952. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  953. </tr>
  954. </table>
  955. </div><div class="memdoc">
  956. <p>Print a double. </p><dl class="params"><dt>Parameters</dt><dd>
  957. <table class="params">
  958. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  959. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  960. </table>
  961. </dd>
  962. </dl>
  963. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  964. </div>
  965. </div>
  966. <a id="a6a09284b1c6d0769c27916a2e131e749"></a>
  967. <h2 class="memtitle"><span class="permalink"><a href="#a6a09284b1c6d0769c27916a2e131e749">&#9670;&nbsp;</a></span>printDec() <span class="overload">[3/9]</span></h2>
  968. <div class="memitem">
  969. <div class="memproto">
  970. <table class="memname">
  971. <tr>
  972. <td class="memname">int StdioStream::printDec </td>
  973. <td>(</td>
  974. <td class="paramtype">float&#160;</td>
  975. <td class="paramname"><em>value</em>, </td>
  976. </tr>
  977. <tr>
  978. <td class="paramkey"></td>
  979. <td></td>
  980. <td class="paramtype">uint8_t&#160;</td>
  981. <td class="paramname"><em>prec</em>&#160;</td>
  982. </tr>
  983. <tr>
  984. <td></td>
  985. <td>)</td>
  986. <td></td><td></td>
  987. </tr>
  988. </table>
  989. </div><div class="memdoc">
  990. <p>Print a float. </p><dl class="params"><dt>Parameters</dt><dd>
  991. <table class="params">
  992. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  993. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  994. </table>
  995. </dd>
  996. </dl>
  997. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  998. </div>
  999. </div>
  1000. <a id="a218af88db35f38babf01d6e0a9cdceeb"></a>
  1001. <h2 class="memtitle"><span class="permalink"><a href="#a218af88db35f38babf01d6e0a9cdceeb">&#9670;&nbsp;</a></span>printDec() <span class="overload">[4/9]</span></h2>
  1002. <div class="memitem">
  1003. <div class="memproto">
  1004. <table class="memname">
  1005. <tr>
  1006. <td class="memname">int StdioStream::printDec </td>
  1007. <td>(</td>
  1008. <td class="paramtype">int16_t&#160;</td>
  1009. <td class="paramname"><em>n</em></td><td>)</td>
  1010. <td></td>
  1011. </tr>
  1012. </table>
  1013. </div><div class="memdoc">
  1014. <p>Print a int16_t </p><dl class="params"><dt>Parameters</dt><dd>
  1015. <table class="params">
  1016. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  1017. </table>
  1018. </dd>
  1019. </dl>
  1020. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1021. </div>
  1022. </div>
  1023. <a id="ad4591f1234b57f63c1acf0f3392099ac"></a>
  1024. <h2 class="memtitle"><span class="permalink"><a href="#ad4591f1234b57f63c1acf0f3392099ac">&#9670;&nbsp;</a></span>printDec() <span class="overload">[5/9]</span></h2>
  1025. <div class="memitem">
  1026. <div class="memproto">
  1027. <table class="memname">
  1028. <tr>
  1029. <td class="memname">int StdioStream::printDec </td>
  1030. <td>(</td>
  1031. <td class="paramtype">int32_t&#160;</td>
  1032. <td class="paramname"><em>n</em></td><td>)</td>
  1033. <td></td>
  1034. </tr>
  1035. </table>
  1036. </div><div class="memdoc">
  1037. <p>Print a signed 32-bit integer. </p><dl class="params"><dt>Parameters</dt><dd>
  1038. <table class="params">
  1039. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  1040. </table>
  1041. </dd>
  1042. </dl>
  1043. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1044. </div>
  1045. </div>
  1046. <a id="a2707ea97f6113c226781469f4f39ff62"></a>
  1047. <h2 class="memtitle"><span class="permalink"><a href="#a2707ea97f6113c226781469f4f39ff62">&#9670;&nbsp;</a></span>printDec() <span class="overload">[6/9]</span></h2>
  1048. <div class="memitem">
  1049. <div class="memproto">
  1050. <table class="memname">
  1051. <tr>
  1052. <td class="memname">int StdioStream::printDec </td>
  1053. <td>(</td>
  1054. <td class="paramtype">signed char&#160;</td>
  1055. <td class="paramname"><em>n</em></td><td>)</td>
  1056. <td></td>
  1057. </tr>
  1058. </table>
  1059. </div><div class="memdoc">
  1060. <p>print a signed 8-bit integer </p><dl class="params"><dt>Parameters</dt><dd>
  1061. <table class="params">
  1062. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  1063. </table>
  1064. </dd>
  1065. </dl>
  1066. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1067. </div>
  1068. </div>
  1069. <a id="a90b2999af94a3578fff7579c2acf8e35"></a>
  1070. <h2 class="memtitle"><span class="permalink"><a href="#a90b2999af94a3578fff7579c2acf8e35">&#9670;&nbsp;</a></span>printDec() <span class="overload">[7/9]</span></h2>
  1071. <div class="memitem">
  1072. <div class="memproto">
  1073. <table class="memname">
  1074. <tr>
  1075. <td class="memname">int StdioStream::printDec </td>
  1076. <td>(</td>
  1077. <td class="paramtype">uint16_t&#160;</td>
  1078. <td class="paramname"><em>n</em></td><td>)</td>
  1079. <td></td>
  1080. </tr>
  1081. </table>
  1082. </div><div class="memdoc">
  1083. <p>print a uint16_t. </p><dl class="params"><dt>Parameters</dt><dd>
  1084. <table class="params">
  1085. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  1086. </table>
  1087. </dd>
  1088. </dl>
  1089. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1090. </div>
  1091. </div>
  1092. <a id="a8b6c2c80342abe45e6f564e9bd5bb7ea"></a>
  1093. <h2 class="memtitle"><span class="permalink"><a href="#a8b6c2c80342abe45e6f564e9bd5bb7ea">&#9670;&nbsp;</a></span>printDec() <span class="overload">[8/9]</span></h2>
  1094. <div class="memitem">
  1095. <div class="memproto">
  1096. <table class="memname">
  1097. <tr>
  1098. <td class="memname">int StdioStream::printDec </td>
  1099. <td>(</td>
  1100. <td class="paramtype">uint32_t&#160;</td>
  1101. <td class="paramname"><em>n</em></td><td>)</td>
  1102. <td></td>
  1103. </tr>
  1104. </table>
  1105. </div><div class="memdoc">
  1106. <p>Write an unsigned 32-bit number. </p><dl class="params"><dt>Parameters</dt><dd>
  1107. <table class="params">
  1108. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed. </td></tr>
  1109. </table>
  1110. </dd>
  1111. </dl>
  1112. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1113. </div>
  1114. </div>
  1115. <a id="a6e6ac78caa6259a4c4934707bf497a2b"></a>
  1116. <h2 class="memtitle"><span class="permalink"><a href="#a6e6ac78caa6259a4c4934707bf497a2b">&#9670;&nbsp;</a></span>printDec() <span class="overload">[9/9]</span></h2>
  1117. <div class="memitem">
  1118. <div class="memproto">
  1119. <table class="mlabels">
  1120. <tr>
  1121. <td class="mlabels-left">
  1122. <table class="memname">
  1123. <tr>
  1124. <td class="memname">int StdioStream::printDec </td>
  1125. <td>(</td>
  1126. <td class="paramtype">unsigned char&#160;</td>
  1127. <td class="paramname"><em>n</em></td><td>)</td>
  1128. <td></td>
  1129. </tr>
  1130. </table>
  1131. </td>
  1132. <td class="mlabels-right">
  1133. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1134. </tr>
  1135. </table>
  1136. </div><div class="memdoc">
  1137. <p>Print an unsigned 8-bit number. </p><dl class="params"><dt>Parameters</dt><dd>
  1138. <table class="params">
  1139. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be print. </td></tr>
  1140. </table>
  1141. </dd>
  1142. </dl>
  1143. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1144. </div>
  1145. </div>
  1146. <a id="a4988592ada39c4b4c603b061f84d183f"></a>
  1147. <h2 class="memtitle"><span class="permalink"><a href="#a4988592ada39c4b4c603b061f84d183f">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>
  1148. <div class="memitem">
  1149. <div class="memproto">
  1150. <table class="mlabels">
  1151. <tr>
  1152. <td class="mlabels-left">
  1153. <table class="memname">
  1154. <tr>
  1155. <td class="memname">int StdioStream::printField </td>
  1156. <td>(</td>
  1157. <td class="paramtype">double&#160;</td>
  1158. <td class="paramname"><em>value</em>, </td>
  1159. </tr>
  1160. <tr>
  1161. <td class="paramkey"></td>
  1162. <td></td>
  1163. <td class="paramtype">char&#160;</td>
  1164. <td class="paramname"><em>term</em>, </td>
  1165. </tr>
  1166. <tr>
  1167. <td class="paramkey"></td>
  1168. <td></td>
  1169. <td class="paramtype">uint8_t&#160;</td>
  1170. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1171. </tr>
  1172. <tr>
  1173. <td></td>
  1174. <td>)</td>
  1175. <td></td><td></td>
  1176. </tr>
  1177. </table>
  1178. </td>
  1179. <td class="mlabels-right">
  1180. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1181. </tr>
  1182. </table>
  1183. </div><div class="memdoc">
  1184. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1185. <table class="params">
  1186. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1187. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. </td></tr>
  1188. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  1189. </table>
  1190. </dd>
  1191. </dl>
  1192. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1193. </div>
  1194. </div>
  1195. <a id="a3b90b2317cc391f94784a847f5313c08"></a>
  1196. <h2 class="memtitle"><span class="permalink"><a href="#a3b90b2317cc391f94784a847f5313c08">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>
  1197. <div class="memitem">
  1198. <div class="memproto">
  1199. <table class="mlabels">
  1200. <tr>
  1201. <td class="mlabels-left">
  1202. <table class="memname">
  1203. <tr>
  1204. <td class="memname">int StdioStream::printField </td>
  1205. <td>(</td>
  1206. <td class="paramtype">float&#160;</td>
  1207. <td class="paramname"><em>value</em>, </td>
  1208. </tr>
  1209. <tr>
  1210. <td class="paramkey"></td>
  1211. <td></td>
  1212. <td class="paramtype">char&#160;</td>
  1213. <td class="paramname"><em>term</em>, </td>
  1214. </tr>
  1215. <tr>
  1216. <td class="paramkey"></td>
  1217. <td></td>
  1218. <td class="paramtype">uint8_t&#160;</td>
  1219. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1220. </tr>
  1221. <tr>
  1222. <td></td>
  1223. <td>)</td>
  1224. <td></td><td></td>
  1225. </tr>
  1226. </table>
  1227. </td>
  1228. <td class="mlabels-right">
  1229. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1230. </tr>
  1231. </table>
  1232. </div><div class="memdoc">
  1233. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1234. <table class="params">
  1235. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1236. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. </td></tr>
  1237. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  1238. </table>
  1239. </dd>
  1240. </dl>
  1241. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1242. </div>
  1243. </div>
  1244. <a id="a02c2ad1a2e71e82d238b8386cf3e6c41"></a>
  1245. <h2 class="memtitle"><span class="permalink"><a href="#a02c2ad1a2e71e82d238b8386cf3e6c41">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>
  1246. <div class="memitem">
  1247. <div class="memproto">
  1248. <div class="memtemplate">
  1249. template&lt;typename T &gt; </div>
  1250. <table class="mlabels">
  1251. <tr>
  1252. <td class="mlabels-left">
  1253. <table class="memname">
  1254. <tr>
  1255. <td class="memname">int StdioStream::printField </td>
  1256. <td>(</td>
  1257. <td class="paramtype">T&#160;</td>
  1258. <td class="paramname"><em>value</em>, </td>
  1259. </tr>
  1260. <tr>
  1261. <td class="paramkey"></td>
  1262. <td></td>
  1263. <td class="paramtype">char&#160;</td>
  1264. <td class="paramname"><em>term</em>&#160;</td>
  1265. </tr>
  1266. <tr>
  1267. <td></td>
  1268. <td>)</td>
  1269. <td></td><td></td>
  1270. </tr>
  1271. </table>
  1272. </td>
  1273. <td class="mlabels-right">
  1274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1275. </tr>
  1276. </table>
  1277. </div><div class="memdoc">
  1278. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  1279. <table class="params">
  1280. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  1281. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. </td></tr>
  1282. </table>
  1283. </dd>
  1284. </dl>
  1285. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1286. </div>
  1287. </div>
  1288. <a id="add39b2b4ec3daa7c8922e96ce5d368bc"></a>
  1289. <h2 class="memtitle"><span class="permalink"><a href="#add39b2b4ec3daa7c8922e96ce5d368bc">&#9670;&nbsp;</a></span>printHex()</h2>
  1290. <div class="memitem">
  1291. <div class="memproto">
  1292. <table class="memname">
  1293. <tr>
  1294. <td class="memname">int StdioStream::printHex </td>
  1295. <td>(</td>
  1296. <td class="paramtype">uint32_t&#160;</td>
  1297. <td class="paramname"><em>n</em></td><td>)</td>
  1298. <td></td>
  1299. </tr>
  1300. </table>
  1301. </div><div class="memdoc">
  1302. <p>Print HEX </p><dl class="params"><dt>Parameters</dt><dd>
  1303. <table class="params">
  1304. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed as HEX.</td></tr>
  1305. </table>
  1306. </dd>
  1307. </dl>
  1308. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1309. </div>
  1310. </div>
  1311. <a id="aec6ebea511489b0ef6b61d9132d93af9"></a>
  1312. <h2 class="memtitle"><span class="permalink"><a href="#aec6ebea511489b0ef6b61d9132d93af9">&#9670;&nbsp;</a></span>printHexln()</h2>
  1313. <div class="memitem">
  1314. <div class="memproto">
  1315. <table class="mlabels">
  1316. <tr>
  1317. <td class="mlabels-left">
  1318. <table class="memname">
  1319. <tr>
  1320. <td class="memname">int StdioStream::printHexln </td>
  1321. <td>(</td>
  1322. <td class="paramtype">uint32_t&#160;</td>
  1323. <td class="paramname"><em>n</em></td><td>)</td>
  1324. <td></td>
  1325. </tr>
  1326. </table>
  1327. </td>
  1328. <td class="mlabels-right">
  1329. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1330. </tr>
  1331. </table>
  1332. </div><div class="memdoc">
  1333. <p>Print HEX with CRLF </p><dl class="params"><dt>Parameters</dt><dd>
  1334. <table class="params">
  1335. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number to be printed as HEX.</td></tr>
  1336. </table>
  1337. </dd>
  1338. </dl>
  1339. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  1340. </div>
  1341. </div>
  1342. <a id="ad0cd3acc05a91456f505752377bd405a"></a>
  1343. <h2 class="memtitle"><span class="permalink"><a href="#ad0cd3acc05a91456f505752377bd405a">&#9670;&nbsp;</a></span>println() <span class="overload">[1/4]</span></h2>
  1344. <div class="memitem">
  1345. <div class="memproto">
  1346. <table class="mlabels">
  1347. <tr>
  1348. <td class="mlabels-left">
  1349. <table class="memname">
  1350. <tr>
  1351. <td class="memname">size_t StdioStream::println </td>
  1352. <td>(</td>
  1353. <td class="paramname"></td><td>)</td>
  1354. <td></td>
  1355. </tr>
  1356. </table>
  1357. </td>
  1358. <td class="mlabels-right">
  1359. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1360. </tr>
  1361. </table>
  1362. </div><div class="memdoc">
  1363. <p>Write a CR/LF.</p>
  1364. <dl class="section return"><dt>Returns</dt><dd>two, the number of bytes written, for success or zero for failure. </dd></dl>
  1365. </div>
  1366. </div>
  1367. <a id="a3793dd66cf347a1ca0b7b167e948cce9"></a>
  1368. <h2 class="memtitle"><span class="permalink"><a href="#a3793dd66cf347a1ca0b7b167e948cce9">&#9670;&nbsp;</a></span>println() <span class="overload">[2/4]</span></h2>
  1369. <div class="memitem">
  1370. <div class="memproto">
  1371. <table class="mlabels">
  1372. <tr>
  1373. <td class="mlabels-left">
  1374. <table class="memname">
  1375. <tr>
  1376. <td class="memname">size_t StdioStream::println </td>
  1377. <td>(</td>
  1378. <td class="paramtype">double&#160;</td>
  1379. <td class="paramname"><em>val</em>, </td>
  1380. </tr>
  1381. <tr>
  1382. <td class="paramkey"></td>
  1383. <td></td>
  1384. <td class="paramtype">uint8_t&#160;</td>
  1385. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1386. </tr>
  1387. <tr>
  1388. <td></td>
  1389. <td>)</td>
  1390. <td></td><td></td>
  1391. </tr>
  1392. </table>
  1393. </td>
  1394. <td class="mlabels-right">
  1395. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1396. </tr>
  1397. </table>
  1398. </div><div class="memdoc">
  1399. <p>Print a floating point number followed by CR/LF.</p>
  1400. <dl class="params"><dt>Parameters</dt><dd>
  1401. <table class="params">
  1402. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the number to be printed.</td></tr>
  1403. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point.</td></tr>
  1404. </table>
  1405. </dd>
  1406. </dl>
  1407. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  1408. </div>
  1409. </div>
  1410. <a id="aac250d041a7844c8db1cbd2d97ecfdaa"></a>
  1411. <h2 class="memtitle"><span class="permalink"><a href="#aac250d041a7844c8db1cbd2d97ecfdaa">&#9670;&nbsp;</a></span>println() <span class="overload">[3/4]</span></h2>
  1412. <div class="memitem">
  1413. <div class="memproto">
  1414. <table class="mlabels">
  1415. <tr>
  1416. <td class="mlabels-left">
  1417. <table class="memname">
  1418. <tr>
  1419. <td class="memname">size_t StdioStream::println </td>
  1420. <td>(</td>
  1421. <td class="paramtype">float&#160;</td>
  1422. <td class="paramname"><em>val</em>, </td>
  1423. </tr>
  1424. <tr>
  1425. <td class="paramkey"></td>
  1426. <td></td>
  1427. <td class="paramtype">uint8_t&#160;</td>
  1428. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  1429. </tr>
  1430. <tr>
  1431. <td></td>
  1432. <td>)</td>
  1433. <td></td><td></td>
  1434. </tr>
  1435. </table>
  1436. </td>
  1437. <td class="mlabels-right">
  1438. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1439. </tr>
  1440. </table>
  1441. </div><div class="memdoc">
  1442. <p>Print a floating point number followed by CR/LF.</p>
  1443. <dl class="params"><dt>Parameters</dt><dd>
  1444. <table class="params">
  1445. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the number to be printed.</td></tr>
  1446. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point.</td></tr>
  1447. </table>
  1448. </dd>
  1449. </dl>
  1450. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  1451. </div>
  1452. </div>
  1453. <a id="a3b14532768d07e6ed89c762d04792c12"></a>
  1454. <h2 class="memtitle"><span class="permalink"><a href="#a3b14532768d07e6ed89c762d04792c12">&#9670;&nbsp;</a></span>println() <span class="overload">[4/4]</span></h2>
  1455. <div class="memitem">
  1456. <div class="memproto">
  1457. <div class="memtemplate">
  1458. template&lt;typename T &gt; </div>
  1459. <table class="mlabels">
  1460. <tr>
  1461. <td class="mlabels-left">
  1462. <table class="memname">
  1463. <tr>
  1464. <td class="memname">size_t StdioStream::println </td>
  1465. <td>(</td>
  1466. <td class="paramtype">T&#160;</td>
  1467. <td class="paramname"><em>val</em></td><td>)</td>
  1468. <td></td>
  1469. </tr>
  1470. </table>
  1471. </td>
  1472. <td class="mlabels-right">
  1473. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1474. </tr>
  1475. </table>
  1476. </div><div class="memdoc">
  1477. <p>Print an item followed by CR/LF</p>
  1478. <dl class="params"><dt>Parameters</dt><dd>
  1479. <table class="params">
  1480. <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>the item to be printed.</td></tr>
  1481. </table>
  1482. </dd>
  1483. </dl>
  1484. <dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
  1485. </div>
  1486. </div>
  1487. <a id="adf9e552212aad6fc2284da0ee62d04dc"></a>
  1488. <h2 class="memtitle"><span class="permalink"><a href="#adf9e552212aad6fc2284da0ee62d04dc">&#9670;&nbsp;</a></span>putc()</h2>
  1489. <div class="memitem">
  1490. <div class="memproto">
  1491. <table class="mlabels">
  1492. <tr>
  1493. <td class="mlabels-left">
  1494. <table class="memname">
  1495. <tr>
  1496. <td class="memname">int StdioStream::putc </td>
  1497. <td>(</td>
  1498. <td class="paramtype">int&#160;</td>
  1499. <td class="paramname"><em>c</em></td><td>)</td>
  1500. <td></td>
  1501. </tr>
  1502. </table>
  1503. </td>
  1504. <td class="mlabels-right">
  1505. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1506. </tr>
  1507. </table>
  1508. </div><div class="memdoc">
  1509. <p>Write a byte to a stream.</p>
  1510. <p>putc and fputc are equivalent but putc is in-line so it is faster but require more flash memory.</p>
  1511. <dl class="params"><dt>Parameters</dt><dd>
  1512. <table class="params">
  1513. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>the byte to be written (converted to an unsigned char).</td></tr>
  1514. </table>
  1515. </dd>
  1516. </dl>
  1517. <dl class="section return"><dt>Returns</dt><dd>Upon successful completion, <a class="el" href="class_stdio_stream.html#a9f23cfa6b112a5da6ae08340af23c57b">fputc()</a> returns the value it has written. Otherwise, it returns EOF and sets the error indicator for the stream. </dd></dl>
  1518. </div>
  1519. </div>
  1520. <a id="a09ccc4b6cabc3502c1052e85d94e84ef"></a>
  1521. <h2 class="memtitle"><span class="permalink"><a href="#a09ccc4b6cabc3502c1052e85d94e84ef">&#9670;&nbsp;</a></span>putCRLF()</h2>
  1522. <div class="memitem">
  1523. <div class="memproto">
  1524. <table class="mlabels">
  1525. <tr>
  1526. <td class="mlabels-left">
  1527. <table class="memname">
  1528. <tr>
  1529. <td class="memname">int StdioStream::putCRLF </td>
  1530. <td>(</td>
  1531. <td class="paramname"></td><td>)</td>
  1532. <td></td>
  1533. </tr>
  1534. </table>
  1535. </td>
  1536. <td class="mlabels-right">
  1537. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1538. </tr>
  1539. </table>
  1540. </div><div class="memdoc">
  1541. <p>Write a CR/LF.</p>
  1542. <dl class="section return"><dt>Returns</dt><dd>two, the number of bytes written, for success or -1 for failure. </dd></dl>
  1543. </div>
  1544. </div>
  1545. <a id="ad985866675193d2ee1dde9e27b0d08da"></a>
  1546. <h2 class="memtitle"><span class="permalink"><a href="#ad985866675193d2ee1dde9e27b0d08da">&#9670;&nbsp;</a></span>rewind()</h2>
  1547. <div class="memitem">
  1548. <div class="memproto">
  1549. <table class="memname">
  1550. <tr>
  1551. <td class="memname">bool StdioStream::rewind </td>
  1552. <td>(</td>
  1553. <td class="paramname"></td><td>)</td>
  1554. <td></td>
  1555. </tr>
  1556. </table>
  1557. </div><div class="memdoc">
  1558. <p>Set position of a stream to the beginning.</p>
  1559. <p>The rewind function sets the file position to the beginning of the file. It is equivalent to fseek(0L, SEEK_SET) except that the error indicator for the stream is also cleared.</p>
  1560. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1561. </div>
  1562. </div>
  1563. <a id="ac00e0dd906c2e857ece53794c6c92786"></a>
  1564. <h2 class="memtitle"><span class="permalink"><a href="#ac00e0dd906c2e857ece53794c6c92786">&#9670;&nbsp;</a></span>ungetc()</h2>
  1565. <div class="memitem">
  1566. <div class="memproto">
  1567. <table class="memname">
  1568. <tr>
  1569. <td class="memname">int StdioStream::ungetc </td>
  1570. <td>(</td>
  1571. <td class="paramtype">int&#160;</td>
  1572. <td class="paramname"><em>c</em></td><td>)</td>
  1573. <td></td>
  1574. </tr>
  1575. </table>
  1576. </div><div class="memdoc">
  1577. <p>Push a byte back into an input stream.</p>
  1578. <dl class="params"><dt>Parameters</dt><dd>
  1579. <table class="params">
  1580. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>the byte (converted to an unsigned char) to be pushed back.</td></tr>
  1581. </table>
  1582. </dd>
  1583. </dl>
  1584. <p>One character of push-back is guaranteed. If the ungetc function is called too many times without an intervening read or file positioning operation on that stream, the operation may fail.</p>
  1585. <p>A successful intervening call to a file positioning function (fseek, fsetpos, or rewind) discards any pushed-back characters for the stream.</p>
  1586. <dl class="section return"><dt>Returns</dt><dd>Upon successful completion, <a class="el" href="class_stdio_stream.html#ac00e0dd906c2e857ece53794c6c92786">ungetc()</a> returns the byte pushed back after conversion. Otherwise it returns EOF. </dd></dl>
  1587. </div>
  1588. </div>
  1589. <hr/>The documentation for this class was generated from the following files:<ul>
  1590. <li>ArduinoSdFat/libraries/SdFat/src/iostream/<a class="el" href="_stdio_stream_8h.html">StdioStream.h</a></li>
  1591. <li>ArduinoSdFat/libraries/SdFat/src/iostream/StdioStream.cpp</li>
  1592. </ul>
  1593. </div><!-- contents -->
  1594. <!-- start footer part -->
  1595. <hr class="footer"/><address class="footer"><small>
  1596. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1597. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1598. </a> 1.8.16
  1599. </small></address>
  1600. </body>
  1601. </html>