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