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