xref: /freebsd/lib/libc/stdio/fputws.3 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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.\" 3. 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.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
32.\"
33.Dd August 6, 2002
34.Dt FPUTWS 3
35.Os
36.Sh NAME
37.Nm fputws
38.Nd output a line of wide characters to a stream
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In stdio.h
43.In wchar.h
44.Ft int
45.Fn fputws "const wchar_t * restrict ws" "FILE * restrict fp"
46.Sh DESCRIPTION
47The
48.Fn fputws
49function writes the wide character string pointed to by
50.Fa ws
51to the stream pointed to by
52.Fa fp .
53.Sh RETURN VALUES
54The
55.Fn fputws
56function
57returns 0 on success and \-1 on error.
58.Sh ERRORS
59The
60.Fn fputws
61function will fail if:
62.Bl -tag -width Er
63.It Bq Er EBADF
64The
65.Fa fp
66argument supplied
67is not a writable stream.
68.El
69.Pp
70The
71.Fn fputws
72function may also fail and set
73.Va errno
74for any of the errors specified for the routine
75.Xr write 2 .
76.Sh SEE ALSO
77.Xr ferror 3 ,
78.Xr fputs 3 ,
79.Xr putwc 3 ,
80.Xr stdio 3
81.Sh STANDARDS
82The
83.Fn fputws
84function conforms to
85.St -p1003.1-2001 .
86