man-pages/man3/fputwc.3

62 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
fputwc \- write a wide character to a FILE stream
.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
2005-10-19 08:35:30 +00:00
The \fBfputwc\fP() function is the wide-character equivalent of the \fBfputc\fP()
2004-11-03 13:51:07 +00:00
function. It writes the wide character \fIwc\fP to \fIstream\fP. If
\fIferror(stream)\fP becomes true, it returns WEOF. If a wide character
2006-02-09 20:29:51 +00:00
conversion error occurs, it sets \fIerrno\fP to \fBEILSEQ\fP and returns WEOF.
2004-11-03 13:51:07 +00:00
Otherwise it returns \fIwc\fP.
.PP
The \fBputwc\fP() function or macro functions identically to \fBfputwc\fP().
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.
.PP
For non-locking counterparts, see
.BR unlocked_stdio (3).
.SH "RETURN VALUE"
The \fBfputwc\fP() function returns \fIwc\fP if no error occurred, or WEOF to
2004-11-03 13:51:07 +00:00
indicate an error.
.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"
2006-08-03 13:57:30 +00:00
ISO/ANSI C, POSIX.1-2001.
2004-11-03 13:51:07 +00:00
.SH NOTES
The behaviour of \fBfputwc\fP() depends on the LC_CTYPE category of the
2004-11-03 13:51:07 +00:00
current locale.
.PP
2005-10-20 15:11:10 +00:00
In the absence of additional information passed to the
.BR fopen ()
call, it is
reasonable to expect that \fBfputwc\fP() 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)