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/
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/ The man pages were rather inconsistent in the use of "Unix" versus "UNIX". Let's go with the trademark usage. Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
2004-11-03 13:51:07 +00:00
.\" 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 nonlocking counterparts, see
2004-11-03 13:51:07 +00:00
.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)