lib/libc/stdio/getwc.3

   1 .\"     $NetBSD: getwc.3,v 1.9 2010/12/16 17:42:27 wiz 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. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)getc.3      8.1 (Berkeley) 6/4/93
  35 .\"
  36 .Dd May 6, 2010
  37 .Dt GETWC 3
  38 .Os
  39 .Sh NAME
  40 .Nm fgetwc ,
  41 .Nm getwc ,
  42 .Nm getwchar ,
  43 .Nd get next wide character from input stream
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In stdio.h
  48 .In wchar.h
  49 .Ft wint_t
  50 .Fn fgetwc "FILE *stream"
  51 .Ft wint_t
  52 .Fn getwc "FILE *stream"
  53 .Ft wint_t
  54 .Fn getwchar
  55 .Sh DESCRIPTION
  56 The
  57 .Fn fgetwc
  58 function
  59 obtains the next input wide character (if present) from the stream pointed at by
  60 .Fa stream ,
  61 or the next character pushed back on the stream via
  62 .Xr ungetwc 3 .
  63 .Pp
  64 The
  65 .Fn getwc
  66 function
  67 acts essentially identically to
  68 .Fn fgetwc ,
  69 but is a macro that expands in-line.
  70 .Pp
  71 The
  72 .Fn getwchar
  73 function
  74 is equivalent to
  75 .Fn getwc
  76 with the argument stdin.
  77 .Sh RETURN VALUES
  78 If successful, these routines return the next wide character
  79 from the
  80 .Fa stream .
  81 If the stream is at end-of-file or a read error occurs,
  82 the routines return
  83 .Dv WEOF .
  84 The routines
  85 .Xr feof 3
  86 and
  87 .Xr ferror 3
  88 must be used to distinguish between end-of-file and error.
  89 If an error occurs, the global variable
  90 .Va errno
  91 is set to indicate the error.
  92 The end-of-file condition is remembered, even on a terminal, and all
  93 subsequent attempts to read will return
  94 .Dv WEOF
  95 until the condition is cleared with
  96 .Xr clearerr 3 .
  97 .Sh SEE ALSO
  98 .Xr ferror 3 ,
  99 .Xr fopen 3 ,
 100 .Xr fread 3 ,
 101 .Xr putwc 3 ,
 102 .Xr stdio 3 ,
 103 .Xr ungetwc 3
 104 .Sh STANDARDS
 105 The
 106 .Fn fgetwc ,
 107 .Fn getwc
 108 and
 109 .Fn getwchar
 110 functions
 111 conform to
 112 .St -isoC-99
 113 and
 114 .St -p1003.1-2001 .