xref: /freebsd/lib/libc/stdio/putwc.3 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1.\"	$NetBSD: putwc.3,v 1.2 2002/02/07 07:00:26 ross 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.Dd March 3, 2004
35.Dt PUTWC 3
36.Os
37.Sh NAME
38.Nm fputwc ,
39.Nm putwc ,
40.Nm putwchar
41.Nd output a wide character to a stream
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In stdio.h
46.In wchar.h
47.Ft wint_t
48.Fn fputwc "wchar_t wc" "FILE *stream"
49.Ft wint_t
50.Fn putwc "wchar_t wc" "FILE *stream"
51.Ft wint_t
52.Fn putwchar "wchar_t wc"
53.Sh DESCRIPTION
54The
55.Fn fputwc
56function
57writes the wide character
58.Fa wc
59to the output stream pointed to by
60.Fa stream .
61.Pp
62The
63.Fn putwc
64function
65acts essentially identically to
66.Fn fputwc .
67.Pp
68The
69.Fn putwchar
70function
71is identical to
72.Fn putwc
73with an output stream of
74.Dv stdout .
75.Sh RETURN VALUES
76The
77.Fn fputwc ,
78.Fn putwc ,
79and
80.Fn putwchar
81functions
82return the wide character written.
83If an error occurs, the value
84.Dv WEOF
85is returned.
86.Sh SEE ALSO
87.Xr ferror 3 ,
88.Xr fopen 3 ,
89.Xr getwc 3 ,
90.Xr putc 3 ,
91.Xr stdio 3
92.Sh STANDARDS
93The
94.Fn fputwc ,
95.Fn putwc ,
96and
97.Fn putwchar
98functions
99conform to
100.St -isoC-99 .
101