stdio/FreeBSD/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 .\" 4. 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 .\" $FreeBSD: src/lib/libc/stdio/getwc.3,v 1.8 2007/01/09 00:28:06 imp Exp $
  36 .\"
  37 .Dd March 3, 2004
  38 .Dt GETWC 3
  39 .Os
  40 .Sh NAME
  41 .Nm fgetwc ,
  42 .Nm getwc ,
  43 .Nm getwchar
  44 .Nd get next wide character from input stream
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In stdio.h
  49 .In wchar.h
  50 .Ft wint_t
  51 .Fn fgetwc "FILE *stream"
  52 .Ft wint_t
  53 .Fn getwc "FILE *stream"
  54 .Ft wint_t
  55 .Fn getwchar "void"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn fgetwc
  59 function
  60 obtains the next input wide character (if present) from the stream pointed at by
  61 .Fa stream ,
  62 or the next character pushed back on the stream via
  63 .Xr ungetwc 3 .
  64 .Pp
  65 The
  66 .Fn getwc
  67 function
  68 acts essentially identically to
  69 .Fn fgetwc .
  70 .Pp
  71 The
  72 .Fn getwchar
  73 function
  74 is equivalent to
  75 .Fn getwc
  76 with the argument
  77 .Dv stdin .
  78 .Pp
  79 Extended locale versions of these functions are documented in
  80 .Xr getwc_l 3 .
  81 See
  82 .Xr xlocale 3
  83 for more information.
  84 .Sh RETURN VALUES
  85 If successful, these routines return the next wide character
  86 from the
  87 .Fa stream .
  88 If the stream is at end-of-file or a read error occurs,
  89 the routines return
  90 .Dv WEOF .
  91 The routines
  92 .Xr feof 3
  93 and
  94 .Xr ferror 3
  95 must be used to distinguish between end-of-file and error.
  96 If an error occurs, the global variable
  97 .Va errno
  98 is set to indicate the error.
  99 The end-of-file condition is remembered, even on a terminal, and all
 100 subsequent attempts to read will return
 101 .Dv WEOF
 102 until the condition is cleared with
 103 .Xr clearerr 3 .
 104 .Sh SEE ALSO
 105 .Xr ferror 3 ,
 106 .Xr fopen 3 ,
 107 .Xr fread 3 ,
 108 .Xr getc 3 ,
 109 .Xr getwc_l ,
 110 .Xr putwc 3 ,
 111 .Xr stdio 3 ,
 112 .Xr ungetwc 3
 113 .Sh STANDARDS
 114 The
 115 .Fn fgetwc ,
 116 .Fn getwc ,
 117 and
 118 .Fn getwchar
 119 functions
 120 conform to
 121 .St -isoC-99 .