man-pages/man3/fputws.3

61 lines
1.6 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 FPUTWS 3 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
fputws \- write a wide-character string to a FILE stream
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "int fputws(const wchar_t *" ws ", FILE *" stream );
.fi
.SH DESCRIPTION
The
.BR fputws ()
function is the wide-character equivalent of
the
.BR fputs (3)
function.
It writes the wide-character string starting at \fIws\fP, up to but
2008-06-09 15:49:35 +00:00
not including the terminating L\(aq\\0\(aq character, to \fIstream\fP.
2004-11-03 13:51:07 +00:00
.PP
For a nonlocking counterpart, see
2004-11-03 13:51:07 +00:00
.BR unlocked_stdio (3).
.SH "RETURN VALUE"
The
.BR fputws ()
2007-06-21 22:55:04 +00:00
function returns a
nonnegative integer if the operation was
2004-11-03 13:51:07 +00:00
successful, or \-1 to indicate an error.
.SH "CONFORMING TO"
C99, POSIX.1-2001.
2004-11-03 13:51:07 +00:00
.SH NOTES
The behavior of
.BR fputws ()
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 fputws ()
will actually write the multibyte
string corresponding to the wide-character string \fIws\fP.
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR fputwc (3),
.BR unlocked_stdio (3)