original/man3/putwchar.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 PUTWCHAR 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 putwchar \- write a wide character to standard output
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .sp
  22 .BI "wint_t putwchar(wchar_t " wc );
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .BR putwchar ()
  27 function is the wide-character equivalent of the
  28 .BR putchar (3)
  29 function.
  30 It writes the wide character \fIwc\fP to \fIstdout\fP.
  31 If \fIferror(stdout)\fP becomes true, it returns
  32 .BR WEOF .
  33 If a wide character
  34 conversion error occurs, it sets \fIerrno\fP to \fBEILSEQ\fP and returns
  35 .BR WEOF .
  36 Otherwise it returns \fIwc\fP.
  37 .PP
  38 For a nonlocking counterpart, see
  39 .BR unlocked_stdio (3).
  40 .SH "RETURN VALUE"
  41 The
  42 .BR putwchar ()
  43 function returns \fIwc\fP if no error occurred, or
  44 .B WEOF
  45 to indicate an error.
  46 .SH "CONFORMING TO"
  47 C99.
  48 .SH NOTES
  49 The behavior of
  50 .BR putwchar ()
  51 depends on the
  52 .B LC_CTYPE
  53 category of the
  54 current locale.
  55 .PP
  56 It is reasonable to expect that
  57 .BR putwchar ()
  58 will actually write
  59 the multibyte sequence corresponding to the wide character \fIwc\fP.
  60 .SH "SEE ALSO"
  61 .BR fputwc (3),
  62 .BR unlocked_stdio (3)