stdio/getwc.3

   1 .\"     $NetBSD: getwc.3,v 1.3 2002/02/07 07:00:26 ross 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 .\" $FreeBSD: src/lib/libc/stdio/getwc.3,v 1.6 2004/03/16 13:30:11 tjr Exp $
  40 .\"
  41 .Dd March 3, 2004
  42 .Dt GETWC 3
  43 .Os
  44 .Sh NAME
  45 .Nm fgetwc ,
  46 .Nm getwc ,
  47 .Nm getwchar
  48 .Nd get next wide character from input stream
  49 .Sh LIBRARY
  50 .Lb libc
  51 .Sh SYNOPSIS
  52 .In stdio.h
  53 .In wchar.h
  54 .Ft wint_t
  55 .Fn fgetwc "FILE *stream"
  56 .Ft wint_t
  57 .Fn getwc "FILE *stream"
  58 .Ft wint_t
  59 .Fn getwchar void
  60 .Sh DESCRIPTION
  61 The
  62 .Fn fgetwc
  63 function
  64 obtains the next input wide character (if present) from the stream pointed at by
  65 .Fa stream ,
  66 or the next character pushed back on the stream via
  67 .Xr ungetwc 3 .
  68 .Pp
  69 The
  70 .Fn getwc
  71 function
  72 acts essentially identically to
  73 .Fn fgetwc .
  74 .Pp
  75 The
  76 .Fn getwchar
  77 function
  78 is equivalent to
  79 .Fn getwc
  80 with the argument
  81 .Dv stdin .
  82 .Pp
  83 Extended locale versions of these functions are documented in
  84 .Xr getwc_l 3 .
  85 See
  86 .Xr xlocale 3
  87 for more information.
  88 .Sh RETURN VALUES
  89 If successful, these routines return the next wide character
  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 WEOF .
  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 WEOF
 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 getc 3 ,
 113 .Xr getwc_l 3 ,
 114 .Xr putwc 3 ,
 115 .Xr stdio 3 ,
 116 .Xr ungetwc 3
 117 .Sh STANDARDS
 118 The
 119 .Fn fgetwc ,
 120 .Fn getwc ,
 121 and
 122 .Fn getwchar
 123 functions
 124 conform to
 125 .St -isoC-99 .