xref: /netbsd-src/lib/libc/stdio/putc.3 (revision d9158b13b5dfe46201430699a3f7a235ecf28df3)
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" 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. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. 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.\"     from: @(#)putc.3	6.7 (Berkeley) 6/29/91
37.\"	$Id: putc.3,v 1.2 1993/08/01 07:44:54 mycroft Exp $
38.\"
39.Dd June 29, 1991
40.Dt PUTC 3
41.Os
42.Sh NAME
43.Nm fputc ,
44.Nm putc ,
45.Nm putchar ,
46.Nm putw
47.Nd output a character or word to a stream
48.Sh SYNOPSIS
49.Fd #include <stdio.h>
50.Ft int
51.Fn fputc "int c" "FILE *stream"
52.Ft int
53.Fn putc "int c" "FILE *stream"
54.Ft int
55.Fn putchar "int c"
56.Ft int
57.Fn putw "int w" "FILE *stream"
58.Sh DESCRIPTION
59The
60.Fn fputc
61function
62writes the character
63.Fa c
64(converted to an ``unsigned char'')
65to the output stream pointed to by
66.Fa stream .
67.Pp
68.Fn Putc
69acts essentially identically to
70.Fn fputc ,
71but is a macro that expands in-line. It may evaluate
72.Fa stream
73more than once, so arguments given to
74.Fn putc
75should not be expressions with potential side effects.
76.Pp
77.Fn Putchar
78is identical to
79.Fn putc
80with an output stream of
81.Em stdout .
82.Pp
83The
84.Fn putw
85function
86writes the specified
87.Em int
88to the named output
89.Fa stream .
90.Sh RETURN VALUES
91The functions,
92.Fn fputc ,
93.Fn putc
94and
95.Fn putchar
96return the character written.
97If an error occurs, the value
98.Dv EOF
99is returned.
100The
101.Fn putw
102function
103returns 0 on success;
104.Dv EOF
105is returned if
106a write error occurs,
107or if an attempt is made to write a read-only stream.
108.Sh SEE ALSO
109.Xr ferror 3 ,
110.Xr fopen 3 ,
111.Xr getc 3 ,
112.Xr stdio 3
113.Sh STANDARDS
114The functions
115.Fn fputc ,
116.Fn putc ,
117and
118.Fn putchar ,
119conform to
120.St -ansiC .
121A function
122.Fn putw
123function appeared in
124.At v6 .
125.Sh BUGS
126The size and byte order of an
127.Em int
128varies from one machine to another, and
129.Fn putw
130is not recommended for portable applications.
131