xref: /openbsd-src/lib/libc/stdio/putwc.3 (revision dd39f797388913bbd4298865a899a336ff3de11a)
1.\"	$OpenBSD: putwc.3,v 1.5 2017/12/01 11:18:40 schwarze Exp $
2.\"
3.\"	$NetBSD: putwc.3,v 1.7 2003/09/08 17:54:32 wiz Exp $
4.\"
5.\" Copyright (c) 1990, 1991, 1993
6.\"	The Regents of the University of California.  All rights reserved.
7.\"
8.\" This code is derived from software contributed to Berkeley by
9.\" Chris Torek and the American National Standards Committee X3,
10.\" on Information Processing Systems.
11.\"
12.\" Redistribution and use in source and binary forms, with or without
13.\" modification, are permitted provided that the following conditions
14.\" are met:
15.\" 1. Redistributions of source code must retain the above copyright
16.\"    notice, this list of conditions and the following disclaimer.
17.\" 2. Redistributions in binary form must reproduce the above copyright
18.\"    notice, this list of conditions and the following disclaimer in the
19.\"    documentation and/or other materials provided with the distribution.
20.\" 3. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)putc.3	8.1 (Berkeley) 6/4/93
37.\"
38.Dd $Mdocdate: December 1 2017 $
39.Dt PUTWC 3
40.Os
41.Sh NAME
42.Nm fputwc ,
43.Nm putwc ,
44.Nm putwchar
45.Nd output a wide character to a stream
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
64.Fn putwc
65acts essentially identically to
66.Fn fputwc ,
67but is a macro that expands in-line.
68It may evaluate
69.Fa stream
70more than once, so arguments given to
71.Fn putwc
72should not be expressions with potential side effects.
73.Pp
74.Fn putwchar
75is identical to
76.Fn putwc
77with an output stream of
78.Em stdout .
79.Sh RETURN VALUES
80The functions,
81.Fn fputwc ,
82.Fn putwc
83and
84.Fn putwchar
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 functions
97.Fn fputwc ,
98.Fn putwc ,
99and
100.Fn putwchar ,
101conform to
102.St -isoC-99 .
103