man-pages/man3/fputwc.3

84 lines
2.1 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" 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 FPUTWC 3 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
2007-05-21 17:50:05 +00:00
fputwc, putwc \- write a wide character to a FILE stream
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
.B #include <stdio.h>
.br
.B #include <wchar.h>
.sp
.BI "wint_t fputwc(wchar_t " wc ", FILE *" stream );
.BI "wint_t putwc(wchar_t " wc ", FILE *" stream );
.fi
.SH DESCRIPTION
The
.BR fputwc ()
function is the wide-character
equivalent of the
2007-05-21 17:50:05 +00:00
.BR fputc (3)
function.
It writes the wide character \fIwc\fP to \fIstream\fP.
If
2007-07-09 20:43:38 +00:00
\fIferror(stream)\fP becomes true, it returns
.BR WEOF .
If a wide-character conversion error occurs,
2007-07-09 20:43:38 +00:00
it sets \fIerrno\fP to \fBEILSEQ\fP and returns
.BR WEOF .
2004-11-03 13:51:07 +00:00
Otherwise it returns \fIwc\fP.
.PP
The
.BR putwc ()
function or macro functions identically to
.BR fputwc ().
2004-11-03 13:51:07 +00:00
It may be implemented as a macro, and may evaluate its argument
more than once.
There is no reason ever to use it.
2004-11-03 13:51:07 +00:00
.PP
For non-locking counterparts, see
.BR unlocked_stdio (3).
.SH "RETURN VALUE"
The
.BR fputwc ()
2007-07-09 20:43:38 +00:00
function returns \fIwc\fP if no error occurred, or
.B WEOF
to indicate an error.
2004-11-03 13:51:07 +00:00
.SH ERRORS
Apart from the usual ones, there is
.TP
.B EILSEQ
Conversion of \fIwc\fP to the stream's encoding fails.
.SH "CONFORMING TO"
C99, POSIX.1-2001.
2004-11-03 13:51:07 +00:00
.SH NOTES
The behavior of
.BR fputwc ()
2007-06-22 18:25:23 +00:00
depends on the
.B LC_CTYPE
category of the
2004-11-03 13:51:07 +00:00
current locale.
.PP
In the absence of additional information passed to the
.BR fopen (3)
2005-10-20 15:11:10 +00:00
call, it is
reasonable to expect that
.BR fputwc ()
will actually write the multibyte
2004-11-03 13:51:07 +00:00
sequence corresponding to the wide character \fIwc\fP.
.SH "SEE ALSO"
.BR fgetwc (3),
.BR fputws (3),
.BR unlocked_stdio (3)