NAME
fgetc — get a byte
from a stream
SYNOPSIS
#include
<stdio.h>
int fgetc(FILE *stream);
DESCRIPTION
[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 (“POSIX.1”) defers to the ISO C standard.
If the end-of-file indicator for the input stream
pointed to by stream is not set and a next byte is
present, the fgetc () function shall obtain the next
byte as an unsigned
char converted to an
int, from
the input stream pointed to by stream, and advance the
associated file position indicator for the stream (if defined). Since
fgetc () operates on bytes, reading a character
consisting of multiple bytes (or "a multi-byte character") may
require multiple calls to fgetc ().
[CX] The fgetc ()
function may mark the st_atime field of the file
associated with stream for update. The
st_atime field shall be marked for update by the first
successful execution of fgetc (),
fgets(3), fgetwc(3),
fgetws(3), fread(3),
fscanf(3), getc(3),
getchar(3), gets(3), or
scanf(3) using stream that returns data
not supplied by a prior call to ungetc(3) or
ungetwc(3).
RETURN VALUE
Upon successful completion, fgetc () shall
return the next byte from the input stream pointed to by
stream. 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 shall be set and fgetc () shall return EOF.
If a read error occurs, the error indicator for the stream shall be set,
fgetc () shall return EOF, [CX]
and shall set
errno to
indicate the error.
ERRORS
The fgetc () function shall fail if data
needs to be read and:
- [EAGAIN]
- [CX] The O_NONBLOCK flag is set for the file descriptor underlying stream
and the process would be delayed in the
fgetc() operation. - [EBADF]
- [CX] The file descriptor underlying stream is not a valid file descriptor open for reading.
- [EINTR]
- [CX] The read operation was terminated due to the receipt of a signal, and no data was transferred.
- [EIO]
- [CX] A physical I/O error has occurred, or the process is in a background process group attempting to read from its controlling terminal, and either the process is ignoring or blocking the SIGTTIN signal or the process group is orphaned. This error may also be generated for implementation-defined reasons.
- [EOVERFLOW]
- [CX] The file is a regular file and an attempt was made to read at or beyond the offset maximum associated with the corresponding stream.
The fgetc () function may fail if:
EXAMPLES
None.
APPLICATION USAGE
If the integer value returned by fgetc ()
is stored into a variable of type char and then compared
against the integer constant EOF, the comparison may never succeed, because
sign-extension of a variable of type char on widening to
integer is implementation-defined.
The ferror(3) or feof(3) functions must be used to distinguish between an error condition and an end-of-file condition.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
feof(3) , ferror(3) , fopen(3) , getchar(3) , getc(3) , the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <stdio.h>
CHANGE HISTORY
First released in Issue 1. Derived from Issue 1 of the SVID.
Issue 5
Large File Summit extensions are added.
Issue 6
Extensions beyond the ISO C standard are marked.
The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:
- The [EIO] and [EOVERFLOW] mandatory error conditions are added.
- The [ENOMEM] and [ENXIO] optional error conditions are added.
The following changes are made for alignment with the ISO/IEC 9899:1999 (“ISO C99”) standard:
- The DESCRIPTION is updated to clarify the behavior when the end-of-file indicator for the input stream is not set.
- The RETURN VALUE section is updated to note that the error indicator shall be set for the stream.
End of informative text. footer end