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