2013-12-31 08:59:14 +00:00
|
|
|
.\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
|
|
|
|
.\"
|
|
|
|
.\" %%%LICENSE_START(VERBATIM)
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\" %%%LICENSE_END
|
|
|
|
.\"
|
|
|
|
.\" Modified Wed Jul 28 11:12:07 1993 by Rik Faith (faith@cs.unc.edu)
|
|
|
|
.\" Modified Fri Sep 8 15:48:13 1995 by Andries Brouwer (aeb@cwi.nl)
|
ldd.1, sprof.1, accept.2, alarm.2, bind.2, chdir.2, clock_nanosleep.2, close.2, connect.2, dup.2, execve.2, fsync.2, getgid.2, getpeername.2, getsid.2, getsockname.2, getsockopt.2, getuid.2, io_getevents.2, kill.2, listen.2, lseek.2, mmap.2, msgctl.2, msgget.2, msgop.2, msync.2, nanosleep.2, nice.2, pause.2, pipe.2, rmdir.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select_tut.2, semctl.2, semop.2, setsid.2, shmctl.2, shmget.2, shmop.2, shutdown.2, sigaction.2, signal.2, socketpair.2, sync.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, times.2, truncate.2, umask.2, MB_CUR_MAX.3, a64l.3, abs.3, assert.3, atexit.3, atof.3, atoi.3, basename.3, bsearch.3, btowc.3, byteorder.3, catgets.3, catopen.3, clock.3, clock_getcpuclockid.3, closedir.3, confstr.3, crypt.3, ctermid.3, difftime.3, div.3, dladdr.3, dlerror.3, dlinfo.3, dlopen.3, dlsym.3, drand48.3, encrypt.3, exit.3, fclose.3, ffs.3, fgetc.3, fgetwc.3, fgetws.3, flockfile.3, fmtmsg.3, fnmatch.3, fopen.3, fpathconf.3, fpclassify.3, fputwc.3, fputws.3, fseek.3, fseeko.3, ftok.3, fwide.3, getdate.3, getenv.3, getgrent.3, getgrnam.3, gethostid.3, getlogin.3, getnetent.3, getopt.3, getpwent.3, getpwnam.3, getsubopt.3, getutent.3, getwchar.3, grantpt.3, hsearch.3, iconv.3, iconv_close.3, iconv_open.3, if_nameindex.3, inet.3, inet_ntop.3, inet_pton.3, insque.3, isatty.3, isgreater.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, lockf.3, longjmp.3, lsearch.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, memccpy.3, memchr.3, memcmp.3, memmove.3, memset.3, mktemp.3, mq_close.3, mq_getattr.3, mq_receive.3, mq_send.3, mq_unlink.3, offsetof.3, popen.3, posix_memalign.3, posix_openpt.3, printf.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstacksize.3, pthread_equal.3, pthread_exit.3, pthread_getcpuclockid.3, pthread_kill.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_sigmask.3, pthread_testcancel.3, ptsname.3, putenv.3, puts.3, putwchar.3, qsort.3, raise.3, random.3, readdir.3, regex.3, remove.3, rewinddir.3, seekdir.3, sem_destroy.3, sem_getvalue.3, sem_unlink.3, sem_wait.3, setenv.3, setjmp.3, setlocale.3, setlogmask.3, signbit.3, sigpause.3, sigset.3, sigsetops.3, sigwait.3, sleep.3, sockatmark.3, statvfs.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strlen.3, strpbrk.3, strptime.3, strspn.3, strstr.3, strtod.3, strtoimax.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, swab.3, sysconf.3, system.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tmpfile.3, towctrans.3, tsearch.3, ttyname.3, tzset.3, ungetwc.3, unlocked_stdio.3, unlockpt.3, wcrtomb.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstoimax.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wordexp.3, wprintf.3, fanotify.7, mq_overview.7, nptl.7, sem_overview.7, shm_overview.7, sigevent.7, symlink.7, ld.so.8: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2015-08-08 16:21:22 +00:00
|
|
|
.TH FGETC 3 2015-08-08 "GNU" "Linux Programmer's Manual"
|
2013-12-31 08:59:14 +00:00
|
|
|
.SH NAME
|
|
|
|
fgetc, fgets, getc, getchar, ungetc \- input of characters and strings
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <stdio.h>
|
|
|
|
.sp
|
|
|
|
.BI "int fgetc(FILE *" stream );
|
|
|
|
|
|
|
|
.BI "char *fgets(char *" "s" ", int " "size" ", FILE *" "stream" );
|
|
|
|
|
|
|
|
.BI "int getc(FILE *" stream );
|
|
|
|
|
|
|
|
.B "int getchar(void);"
|
|
|
|
|
|
|
|
.BI "int ungetc(int " c ", FILE *" stream );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR fgetc ()
|
|
|
|
reads the next character from
|
|
|
|
.I stream
|
|
|
|
and returns it as an
|
|
|
|
.I unsigned char
|
|
|
|
cast to an
|
|
|
|
.IR int ,
|
|
|
|
or
|
|
|
|
.B EOF
|
|
|
|
on end of file or error.
|
|
|
|
.PP
|
|
|
|
.BR getc ()
|
|
|
|
is equivalent to
|
|
|
|
.BR fgetc ()
|
|
|
|
except that it may be implemented as a macro which evaluates
|
|
|
|
.I stream
|
|
|
|
more than once.
|
|
|
|
.PP
|
|
|
|
.BR getchar ()
|
|
|
|
is equivalent to
|
|
|
|
.BI "getc(" stdin ) \fR.
|
|
|
|
.PP
|
|
|
|
.BR fgets ()
|
|
|
|
reads in at most one less than
|
|
|
|
.I size
|
|
|
|
characters from
|
|
|
|
.I stream
|
|
|
|
and stores them into the buffer pointed to by
|
|
|
|
.IR s .
|
|
|
|
Reading stops after an
|
|
|
|
.B EOF
|
|
|
|
or a newline.
|
|
|
|
If a newline is read, it is stored into the buffer.
|
|
|
|
A terminating null byte (\(aq\e0\(aq)
|
|
|
|
is stored after the last character in the buffer.
|
|
|
|
.PP
|
|
|
|
.BR ungetc ()
|
|
|
|
pushes
|
|
|
|
.I c
|
|
|
|
back to
|
|
|
|
.IR stream ,
|
|
|
|
cast to
|
|
|
|
.IR "unsigned char" ,
|
|
|
|
where it is available for subsequent read operations.
|
|
|
|
Pushed-back characters
|
|
|
|
will be returned in reverse order; only one pushback is guaranteed.
|
|
|
|
.PP
|
|
|
|
Calls to the functions described here can be mixed with each other and with
|
|
|
|
calls to other input functions from the
|
|
|
|
.I stdio
|
|
|
|
library for the same input stream.
|
|
|
|
.PP
|
|
|
|
For nonlocking counterparts, see
|
|
|
|
.BR unlocked_stdio (3).
|
|
|
|
.SH RETURN VALUE
|
|
|
|
.BR fgetc (),
|
|
|
|
.BR getc ()
|
|
|
|
and
|
|
|
|
.BR getchar ()
|
|
|
|
return the character read as an
|
|
|
|
.I unsigned char
|
|
|
|
cast to an
|
|
|
|
.I int
|
|
|
|
or
|
|
|
|
.B EOF
|
|
|
|
on end of file or error.
|
|
|
|
.PP
|
|
|
|
.BR fgets ()
|
|
|
|
returns
|
|
|
|
.I s
|
|
|
|
on success, and NULL
|
|
|
|
on error or when end of file occurs while no characters have been read.
|
|
|
|
.PP
|
|
|
|
.BR ungetc ()
|
|
|
|
returns
|
|
|
|
.I c
|
|
|
|
on success, or
|
|
|
|
.B EOF
|
|
|
|
on error.
|
2015-02-26 02:40:09 +00:00
|
|
|
.SH ATTRIBUTES
|
|
|
|
For an explanation of the terms used in this section, see
|
|
|
|
.BR attributes (7).
|
|
|
|
.TS
|
|
|
|
allbox;
|
|
|
|
lbw25 lb lb
|
|
|
|
l l l.
|
|
|
|
Interface Attribute Value
|
|
|
|
T{
|
|
|
|
.BR fgetc (),
|
|
|
|
.BR fgets (),
|
|
|
|
.BR getc (),
|
|
|
|
.br
|
|
|
|
.BR getchar (),
|
|
|
|
.BR ungetc ()
|
|
|
|
T} Thread safety MT-Safe
|
|
|
|
.TE
|
|
|
|
|
2013-12-31 08:59:14 +00:00
|
|
|
.SH CONFORMING TO
|
2015-04-18 07:01:31 +00:00
|
|
|
POSIX.1-2001, POSIX.1-2008, C89, C99.
|
2013-12-31 08:59:14 +00:00
|
|
|
|
|
|
|
It is not advisable to mix calls to input functions from the
|
|
|
|
.I stdio
|
|
|
|
library with low-level calls to
|
|
|
|
.BR read (2)
|
|
|
|
for the file descriptor associated with the input stream; the results
|
|
|
|
will be undefined and very probably not what you want.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR read (2),
|
|
|
|
.BR write (2),
|
|
|
|
.BR ferror (3),
|
|
|
|
.BR fgetwc (3),
|
|
|
|
.BR fgetws (3),
|
|
|
|
.BR fopen (3),
|
|
|
|
.BR fread (3),
|
|
|
|
.BR fseek (3),
|
|
|
|
.BR getline (3),
|
2013-12-31 10:01:24 +00:00
|
|
|
.BR gets (3),
|
2013-12-31 08:59:14 +00:00
|
|
|
.BR getwchar (3),
|
|
|
|
.BR puts (3),
|
|
|
|
.BR scanf (3),
|
|
|
|
.BR ungetwc (3),
|
|
|
|
.BR unlocked_stdio (3),
|
|
|
|
.BR feature_test_macros (7)
|