1.\" $NetBSD: getc.3,v 1.3 1995/02/02 01:15:45 jtc Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek and the American National Standards Committee X3, 8.\" on Information Processing Systems. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.\" @(#)getc.3 8.1 (Berkeley) 6/4/93 39.\" 40.Dd June 4, 1993 41.Dt GETC 3 42.Os 43.Sh NAME 44.Nm fgetc , 45.Nm getc , 46.Nm getchar , 47.Nm getw 48.Nd get next character or word from input stream 49.Sh SYNOPSIS 50.Fd #include <stdio.h> 51.Ft int 52.Fn fgetc "FILE *stream" 53.Ft int 54.Fn getc "FILE *stream" 55.Ft int 56.Fn getchar 57.Ft int 58.Fn getw "FILE *stream" 59.Sh DESCRIPTION 60The 61.Fn fgetc 62function 63obtains the next input character (if present) from the stream pointed at by 64.Fa stream , 65or the next character pushed back on the stream via 66.Xr ungetc . 67.Pp 68The 69.Fn getc 70function 71acts essentially identically to 72.Fn fgetc , 73but is a macro that expands in-line. 74.Pp 75The 76.Fn getchar 77function 78is equivalent to: 79getc with the argument stdin. 80.Pp 81The 82.Fn getw 83function 84obtains the next 85.Em int 86(if present) 87from the stream pointed at by 88.Fa stream . 89.Sh RETURN VALUES 90If successful, these routines return the next requested object 91from the 92.Fa stream . 93If the stream is at end-of-file or a read error occurs, 94the routines return 95.Dv EOF . 96The routines 97.Xr feof 3 98and 99.Xr ferror 3 100must be used to distinguish between end-of-file and error. 101If an error occurs, the global variable 102.Va errno 103is set to indicate the error. 104The end-of-file condition is remembered, even on a terminal, and all 105subsequent attempts to read will return 106.Dv EOF 107until the condition is cleared with 108.Xr clearerr . 109.Sh SEE ALSO 110.Xr ferror 3 , 111.Xr fread 3 , 112.Xr fopen 3 , 113.Xr putc 3 , 114.Xr ungetc 3 115.Sh STANDARDS 116The 117.Fn fgetc , 118.Fn getc 119and 120.Fn getchar 121functions 122conform to 123.St -ansiC . 124.Sh BUGS 125Since 126.Dv EOF 127is a valid integer value, 128.Xr feof 129and 130.Xr ferror 131must be used to check for failure after calling 132.Fn getw . 133The size and byte order of an 134.Em int 135varies from one machine to another, and 136.Fn getw 137is not recommended for portable applications. 138.Pp 139