xref: /netbsd/lib/libc/stdio/fputws.3 (revision 6550d01e)
1.\" $NetBSD: fputws.3,v 1.3 2010/12/16 17:42:27 wiz 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. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)fputs.3	8.1 (Berkeley) 6/4/93
35.\"
36.\" Original version ID:
37.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
38.\" FreeBSD: src/lib/libc/stdio/fputws.c,v 1.4 2002/09/20 13:25:40 tjr Exp
39.\"
40.Dd August 6, 2002
41.Dt FPUTWS 3
42.Os
43.Sh NAME
44.Nm fputws
45.Nd output a line of wide characters to a stream
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In stdio.h
50.In wchar.h
51.Ft int
52.Fn fputws "const wchar_t * restrict ws" "FILE * restrict fp"
53.Sh DESCRIPTION
54The
55.Fn fputws
56function writes the wide-character string pointed to by
57.Fa ws
58to the stream pointed to by
59.Fa fp .
60.Sh RETURN VALUES
61The
62.Fn fputws
63function
64returns 0 on success and \-1 on error.
65.Sh ERRORS
66.Bl -tag -width Er
67.It Bq Er EBADF
68The
69.Fa fp
70argument supplied
71is not a writable stream.
72.El
73.Pp
74The
75.Fn fputws
76function may also fail and set
77.Va errno
78for any of the errors specified for the routine
79.Xr write 2 .
80.Sh SEE ALSO
81.Xr ferror 3 ,
82.Xr fputs 3 ,
83.Xr putwc 3 ,
84.Xr stdio 3
85.Sh STANDARDS
86The
87.Fn fputws
88function conforms to
89.St -p1003.1-2001 .
90