lib/libc/stdio/getc.3

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