xref: /openbsd/lib/libc/stdio/fputws.3 (revision f6aab3d8)
1.\"	$OpenBSD: fputws.3,v 1.4 2010/09/10 18:38:19 jmc Exp $
2.\"
3.\" $NetBSD: fputws.3,v 1.2 2003/08/07 16:43:24 agc Exp $
4.\"
5.\" Copyright (c) 1990, 1991, 1993
6.\"	The Regents of the University of California.  All rights reserved.
7.\"
8.\" This code is derived from software contributed to Berkeley by
9.\" Chris Torek and the American National Standards Committee X3,
10.\" on Information Processing Systems.
11.\"
12.\" Redistribution and use in source and binary forms, with or without
13.\" modification, are permitted provided that the following conditions
14.\" are met:
15.\" 1. Redistributions of source code must retain the above copyright
16.\"    notice, this list of conditions and the following disclaimer.
17.\" 2. Redistributions in binary form must reproduce the above copyright
18.\"    notice, this list of conditions and the following disclaimer in the
19.\"    documentation and/or other materials provided with the distribution.
20.\" 3. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)fputs.3	8.1 (Berkeley) 6/4/93
37.\"
38.\" Original version ID:
39.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
40.\" FreeBSD: src/lib/libc/stdio/fputws.c,v 1.4 2002/09/20 13:25:40 tjr Exp
41.\"
42.Dd $Mdocdate: September 10 2010 $
43.Dt FPUTWS 3
44.Os
45.Sh NAME
46.Nm fputws
47.Nd output a line of wide characters to a stream
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