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 \fBputwchar\fP() function is the wide-character equivalent of the
  26 \fBputchar\fP(3) function.
  27 It writes the wide character \fIwc\fP to \fBstdout\fP.
  28 If \fIferror(stdout)\fP becomes true, it returns WEOF.
  29 If a wide character
  30 conversion error occurs, it sets \fIerrno\fP to \fBEILSEQ\fP and returns WEOF.
  31 Otherwise it returns \fIwc\fP.
  32 .PP
  33 For a non-locking counterpart, see
  34 .BR unlocked_stdio (3).
  35 .SH "RETURN VALUE"
  36 The \fBputwchar\fP() function returns \fIwc\fP if no error occurred,
  37 or WEOF to indicate an error.
  38 .SH "CONFORMING TO"
  39 C99.
  40 .SH NOTES
  41 The behaviour of \fBputwchar\fP() depends on the LC_CTYPE category of the
  42 current locale.
  43 .PP
  44 It is reasonable to expect that \fBputwchar\fP() will actually write
  45 the multibyte sequence corresponding to the wide character \fIwc\fP.
  46 .SH "SEE ALSO"
  47 .BR fputwc (3),
  48 .BR unlocked_stdio (3)