blob: 1f8b62331947a47bc8bb14f6930f40b8185f7ee9 [file] [log] [blame]
<html lang="en">
<head>
<title>EOF and Errors - The GNU C Library</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="The GNU C Library">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="I_002fO-on-Streams.html#I_002fO-on-Streams" title="I/O on Streams">
<link rel="prev" href="Formatted-Input.html#Formatted-Input" title="Formatted Input">
<link rel="next" href="Error-Recovery.html#Error-Recovery" title="Error Recovery">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This file documents the GNU C library.
This is Edition 0.12, last updated 2007-10-27,
of `The GNU C Library Reference Manual', for version
2.8 (Sourcery G++ Lite 2011.03-41).
Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2001, 2002,
2003, 2007, 2008, 2010 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``Free Software Needs Free Documentation''
and ``GNU Lesser General Public License'', the Front-Cover texts being
``A GNU Manual'', and with the Back-Cover Texts as in (a) below. A
copy of the license is included in the section entitled "GNU Free
Documentation License".
(a) The FSF's Back-Cover Text is: ``You have the freedom to
copy and modify this GNU manual. Buying copies from the FSF
supports it in developing GNU and promoting software freedom.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
<link rel="stylesheet" type="text/css" href="../cs.css">
</head>
<body>
<div class="node">
<a name="EOF-and-Errors"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Error-Recovery.html#Error-Recovery">Error Recovery</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Formatted-Input.html#Formatted-Input">Formatted Input</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="I_002fO-on-Streams.html#I_002fO-on-Streams">I/O on Streams</a>
<hr>
</div>
<h3 class="section">12.15 End-Of-File and Errors</h3>
<p><a name="index-end-of-file_002c-on-a-stream-1095"></a>Many of the functions described in this chapter return the value of the
macro <code>EOF</code> to indicate unsuccessful completion of the operation.
Since <code>EOF</code> is used to report both end of file and random errors,
it's often better to use the <code>feof</code> function to check explicitly
for end of file and <code>ferror</code> to check for errors. These functions
check indicators that are part of the internal state of the stream
object, indicators set if the appropriate condition was detected by a
previous I/O operation on that stream.
<!-- stdio.h -->
<!-- ISO -->
<div class="defun">
&mdash; Macro: int <b>EOF</b><var><a name="index-EOF-1096"></a></var><br>
<blockquote><p>This macro is an integer value that is returned by a number of narrow
stream functions to indicate an end-of-file condition, or some other
error situation. With the GNU library, <code>EOF</code> is <code>-1</code>. In
other libraries, its value may be some other negative number.
<p>This symbol is declared in <samp><span class="file">stdio.h</span></samp>.
</p></blockquote></div>
<!-- wchar.h -->
<!-- ISO -->
<div class="defun">
&mdash; Macro: int <b>WEOF</b><var><a name="index-WEOF-1097"></a></var><br>
<blockquote><p>This macro is an integer value that is returned by a number of wide
stream functions to indicate an end-of-file condition, or some other
error situation. With the GNU library, <code>WEOF</code> is <code>-1</code>. In
other libraries, its value may be some other negative number.
<p>This symbol is declared in <samp><span class="file">wchar.h</span></samp>.
</p></blockquote></div>
<!-- stdio.h -->
<!-- ISO -->
<div class="defun">
&mdash; Function: int <b>feof</b> (<var>FILE *stream</var>)<var><a name="index-feof-1098"></a></var><br>
<blockquote><p>The <code>feof</code> function returns nonzero if and only if the end-of-file
indicator for the stream <var>stream</var> is set.
<p>This symbol is declared in <samp><span class="file">stdio.h</span></samp>.
</p></blockquote></div>
<!-- stdio.h -->
<!-- GNU -->
<div class="defun">
&mdash; Function: int <b>feof_unlocked</b> (<var>FILE *stream</var>)<var><a name="index-feof_005funlocked-1099"></a></var><br>
<blockquote><p>The <code>feof_unlocked</code> function is equivalent to the <code>feof</code>
function except that it does not implicitly lock the stream.
<p>This function is a GNU extension.
<p>This symbol is declared in <samp><span class="file">stdio.h</span></samp>.
</p></blockquote></div>
<!-- stdio.h -->
<!-- ISO -->
<div class="defun">
&mdash; Function: int <b>ferror</b> (<var>FILE *stream</var>)<var><a name="index-ferror-1100"></a></var><br>
<blockquote><p>The <code>ferror</code> function returns nonzero if and only if the error
indicator for the stream <var>stream</var> is set, indicating that an error
has occurred on a previous operation on the stream.
<p>This symbol is declared in <samp><span class="file">stdio.h</span></samp>.
</p></blockquote></div>
<!-- stdio.h -->
<!-- GNU -->
<div class="defun">
&mdash; Function: int <b>ferror_unlocked</b> (<var>FILE *stream</var>)<var><a name="index-ferror_005funlocked-1101"></a></var><br>
<blockquote><p>The <code>ferror_unlocked</code> function is equivalent to the <code>ferror</code>
function except that it does not implicitly lock the stream.
<p>This function is a GNU extension.
<p>This symbol is declared in <samp><span class="file">stdio.h</span></samp>.
</p></blockquote></div>
<p>In addition to setting the error indicator associated with the stream,
the functions that operate on streams also set <code>errno</code> in the same
way as the corresponding low-level functions that operate on file
descriptors. For example, all of the functions that perform output to a
stream&mdash;such as <code>fputc</code>, <code>printf</code>, and <code>fflush</code>&mdash;are
implemented in terms of <code>write</code>, and all of the <code>errno</code> error
conditions defined for <code>write</code> are meaningful for these functions.
For more information about the descriptor-level I/O functions, see
<a href="Low_002dLevel-I_002fO.html#Low_002dLevel-I_002fO">Low-Level I/O</a>.
</body></html>