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