original/man3/putwchar.3

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