xref: /netbsd-src/lib/libc/stdio/fputws.3 (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1.\" $NetBSD: fputws.3,v 1.1 2003/03/07 07:11:37 tshiozak Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)fputs.3	8.1 (Berkeley) 6/4/93
39.\"
40.\" Original version ID:
41.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
42.\" FreeBSD: src/lib/libc/stdio/fputws.c,v 1.4 2002/09/20 13:25:40 tjr Exp
43.\"
44.Dd August 6, 2002
45.Dt FPUTWS 3
46.Os
47.Sh NAME
48.Nm fputws
49.Nd output a line of wide characters to a stream
50.Sh LIBRARY
51.Lb libc
52.Sh SYNOPSIS
53.In stdio.h
54.In wchar.h
55.Ft int
56.Fn fputws "const wchar_t * restrict ws" "FILE * restrict fp"
57.Sh DESCRIPTION
58The
59.Fn fputws
60function writes the wide character string pointed to by
61.Fa ws
62to the stream pointed to by
63.Fa fp .
64.Sh RETURN VALUES
65The
66.Fn fputws
67function
68returns 0 on success and \-1 on error.
69.Sh ERRORS
70.Bl -tag -width Er
71.It Bq Er EBADF
72The
73.Fa fp
74argument supplied
75is not a writable stream.
76.El
77.Pp
78The
79.Fn fputws
80function may also fail and set
81.Va errno
82for any of the errors specified for the routine
83.Xr write 2 .
84.Sh SEE ALSO
85.Xr ferror 3 ,
86.Xr fputs 3 ,
87.Xr putwc 3 ,
88.Xr stdio 3
89.Sh STANDARDS
90The
91.Fn fputws
92function conforms to
93.St -p1003.1-2001 .
94