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.

130 line
5.5KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>fgetc (The Red Hat newlib C Library)</title>
  7. <meta name="description" content="fgetc (The Red Hat newlib C Library)">
  8. <meta name="keywords" content="fgetc (The Red Hat newlib C Library)">
  9. <meta name="resource-type" content="document">
  10. <meta name="distribution" content="global">
  11. <meta name="Generator" content="makeinfo">
  12. <link href="index.html#Top" rel="start" title="Top">
  13. <link href="Document-Index.html#Document-Index" rel="index" title="Document Index">
  14. <link href="Document-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
  15. <link href="Stdio.html#Stdio" rel="up" title="Stdio">
  16. <link href="fgetpos.html#fgetpos" rel="next" title="fgetpos">
  17. <link href="fflush.html#fflush" rel="prev" title="fflush">
  18. <style type="text/css">
  19. <!--
  20. a.summary-letter {text-decoration: none}
  21. blockquote.indentedblock {margin-right: 0em}
  22. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  23. blockquote.smallquotation {font-size: smaller}
  24. div.display {margin-left: 3.2em}
  25. div.example {margin-left: 3.2em}
  26. div.lisp {margin-left: 3.2em}
  27. div.smalldisplay {margin-left: 3.2em}
  28. div.smallexample {margin-left: 3.2em}
  29. div.smalllisp {margin-left: 3.2em}
  30. kbd {font-style: oblique}
  31. pre.display {font-family: inherit}
  32. pre.format {font-family: inherit}
  33. pre.menu-comment {font-family: serif}
  34. pre.menu-preformatted {font-family: serif}
  35. pre.smalldisplay {font-family: inherit; font-size: smaller}
  36. pre.smallexample {font-size: smaller}
  37. pre.smallformat {font-family: inherit; font-size: smaller}
  38. pre.smalllisp {font-size: smaller}
  39. span.nolinebreak {white-space: nowrap}
  40. span.roman {font-family: initial; font-weight: normal}
  41. span.sansserif {font-family: sans-serif; font-weight: normal}
  42. ul.no-bullet {list-style: none}
  43. -->
  44. </style>
  45. </head>
  46. <body lang="en">
  47. <a name="fgetc"></a>
  48. <div class="header">
  49. <p>
  50. Next: <a href="fgetpos.html#fgetpos" accesskey="n" rel="next">fgetpos</a>, Previous: <a href="fflush.html#fflush" accesskey="p" rel="prev">fflush</a>, Up: <a href="Stdio.html#Stdio" accesskey="u" rel="up">Stdio</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>
  51. </div>
  52. <hr>
  53. <a name="fgetc_002c-fgetc_005funlocked_002d_002d_002dget-a-character-from-a-file-or-stream"></a>
  54. <h3 class="section">4.10 <code>fgetc</code>, <code>fgetc_unlocked</code>&mdash;get a character from a file or stream</h3>
  55. <a name="index-fgetc"></a>
  56. <a name="index-fgetc_005funlocked"></a>
  57. <a name="index-_005ffgetc_005fr"></a>
  58. <a name="index-_005ffgetc_005funlocked_005fr"></a>
  59. <p><strong>Synopsis</strong>
  60. </p><div class="example">
  61. <pre class="example">#include &lt;stdio.h&gt;
  62. int fgetc(FILE *<var>fp</var>);
  63. #define _BSD_SOURCE
  64. #include &lt;stdio.h&gt;
  65. int fgetc_unlocked(FILE *<var>fp</var>);
  66. #include &lt;stdio.h&gt;
  67. int _fgetc_r(struct _reent *<var>ptr</var>, FILE *<var>fp</var>);
  68. #define _BSD_SOURCE
  69. #include &lt;stdio.h&gt;
  70. int _fgetc_unlocked_r(struct _reent *<var>ptr</var>, FILE *<var>fp</var>);
  71. </pre></div>
  72. <p><strong>Description</strong><br>
  73. Use <code>fgetc</code> to get the next single character from the file or stream
  74. identified by <var>fp</var>. As a side effect, <code>fgetc</code> advances the file&rsquo;s
  75. current position indicator.
  76. </p>
  77. <p>For a macro version of this function, see <code>getc</code>.
  78. </p>
  79. <p><code>fgetc_unlocked</code> is a non-thread-safe version of <code>fgetc</code>.
  80. <code>fgetc_unlocked</code> may only safely be used within a scope
  81. protected by flockfile() (or ftrylockfile()) and funlockfile(). This
  82. function may safely be used in a multi-threaded program if and only
  83. if they are called while the invoking thread owns the (FILE *)
  84. object, as is the case after a successful call to the flockfile() or
  85. ftrylockfile() functions. If threads are disabled, then
  86. <code>fgetc_unlocked</code> is equivalent to <code>fgetc</code>.
  87. </p>
  88. <p>The functions <code>_fgetc_r</code> and <code>_fgetc_unlocked_r</code> are simply reentrant
  89. versions that are passed the additional reentrant structure pointer
  90. argument: <var>ptr</var>.
  91. </p>
  92. <br>
  93. <p><strong>Returns</strong><br>
  94. The next character (read as an <code>unsigned char</code>, and cast to
  95. <code>int</code>), unless there is no more data, or the host system reports a
  96. read error; in either of these situations, <code>fgetc</code> returns <code>EOF</code>.
  97. </p>
  98. <p>You can distinguish the two situations that cause an <code>EOF</code> result by
  99. using the <code>ferror</code> and <code>feof</code> functions.
  100. </p>
  101. <br>
  102. <p><strong>Portability</strong><br>
  103. ANSI C requires <code>fgetc</code>.
  104. </p>
  105. <p><code>fgetc_unlocked</code> is a BSD extension also provided by GNU libc.
  106. </p>
  107. <p>Supporting OS subroutines required: <code>close</code>, <code>fstat</code>, <code>isatty</code>,
  108. <code>lseek</code>, <code>read</code>, <code>sbrk</code>, <code>write</code>.
  109. </p>
  110. <br>
  111. <hr>
  112. <div class="header">
  113. <p>
  114. Next: <a href="fgetpos.html#fgetpos" accesskey="n" rel="next">fgetpos</a>, Previous: <a href="fflush.html#fflush" accesskey="p" rel="prev">fflush</a>, Up: <a href="Stdio.html#Stdio" accesskey="u" rel="up">Stdio</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>
  115. </div>
  116. </body>
  117. </html>