man-pages/man3/fputws.3

45 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
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "int fputws(const wchar_t *" ws ", FILE *" stream );
.fi
.SH DESCRIPTION
2005-10-19 08:35:30 +00:00
The \fBfputws\fP() function is the wide-character equivalent of the \fBfputs\fP()
2004-11-03 13:51:07 +00:00
function. It writes the wide character string starting at \fIws\fP, up to but
not including the terminating L'\\0' character, to \fIstream\fP.
.PP
For a non-locking counterpart, see
.BR unlocked_stdio (3).
.SH "RETURN VALUE"
The \fBfputws\fP() 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"
ISO/ANSI C, UNIX98
.SH NOTES
The behaviour of \fBfputws\fP() depends on the 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 fopen call, it is
reasonable to expect that \fBfputws\fP() will actually write the multibyte
2004-11-03 13:51:07 +00:00
string corresponding to the wide character string \fIws\fP.
.SH "SEE ALSO"
.BR fputwc (3),
.BR unlocked_stdio (3)