man-pages/man3/putwchar.3

49 lines
1.6 KiB
Groff

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" Dinkumware C library reference http://www.dinkumware.com/
.\" OpenGroup's Single Unix specification
.\" http://www.UNIX-systems.org/online.html
.\" ISO/IEC 9899:1999
.\"
.TH PUTWCHAR 3 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
putwchar \- write a wide character to standard output
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "wint_t putwchar(wchar_t " wc );
.fi
.SH DESCRIPTION
The \fBputwchar\fP() function is the wide-character equivalent of the
\fBputchar\fP(3) function.
It writes the wide character \fIwc\fP to \fBstdout\fP.
If \fIferror(stdout)\fP becomes true, it returns WEOF.
If a wide character
conversion error occurs, it sets \fIerrno\fP to \fBEILSEQ\fP and returns WEOF.
Otherwise it returns \fIwc\fP.
.PP
For a non-locking counterpart, see
.BR unlocked_stdio (3).
.SH "RETURN VALUE"
The \fBputwchar\fP() function returns \fIwc\fP if no error occurred,
or WEOF to indicate an error.
.SH "CONFORMING TO"
C99.
.SH NOTES
The behaviour of \fBputwchar\fP() depends on the LC_CTYPE category of the
current locale.
.PP
It is reasonable to expect that \fBputwchar\fP() will actually write
the multibyte sequence corresponding to the wide character \fIwc\fP.
.SH "SEE ALSO"
.BR fputwc (3),
.BR unlocked_stdio (3)