original/man3/getwchar.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification
  12 .\"      http://www.UNIX-systems.org/online.html
  13 .\"   ISO/IEC 9899:1999
  14 .\"
  15 .TH GETWCHAR 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 getwchar \- read a wide character from standard input
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .sp
  22 .B "wint_t getwchar(void);"
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .BR getwchar ()
  27 function is the wide-character equivalent of the
  28 .BR getchar (3)
  29 function.
  30 It reads a wide character from \fIstdin\fP and returns
  31 it.
  32 If the end of stream is reached, or if \fIferror(stdin)\fP becomes
  33 true, it returns
  34 .BR WEOF .
  35 If a wide-character conversion error occurs, it sets
  36 \fIerrno\fP to \fBEILSEQ\fP and returns
  37 .BR WEOF .
  38 .PP
  39 For a nonlocking counterpart, see
  40 .BR unlocked_stdio (3).
  41 .SH "RETURN VALUE"
  42 The
  43 .BR getwchar ()
  44 function returns the next wide-character from
  45 standard input, or
  46 .BR WEOF .
  47 .SH "CONFORMING TO"
  48 C99.
  49 .SH NOTES
  50 The behavior of
  51 .BR getwchar ()
  52 depends on the
  53 .B LC_CTYPE
  54 category of the
  55 current locale.
  56 .PP
  57 It is reasonable to expect that
  58 .BR getwchar ()
  59 will actually
  60 read a multibyte sequence from standard input and then
  61 convert it to a wide character.
  62 .SH "SEE ALSO"
  63 .BR fgetwc (3),
  64 .BR unlocked_stdio (3)