xref: /netbsd-src/lib/libc/stdio/putc.3 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: putc.3,v 1.3 1995/02/02 01:15:50 jtc 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. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)putc.3	8.1 (Berkeley) 6/4/93
39.\"
40.Dd June 4, 1993
41.Dt PUTC 3
42.Os
43.Sh NAME
44.Nm fputc ,
45.Nm putc ,
46.Nm putchar ,
47.Nm putw
48.Nd output a character or word to a stream
49.Sh SYNOPSIS
50.Fd #include <stdio.h>
51.Ft int
52.Fn fputc "int c" "FILE *stream"
53.Ft int
54.Fn putc "int c" "FILE *stream"
55.Ft int
56.Fn putchar "int c"
57.Ft int
58.Fn putw "int w" "FILE *stream"
59.Sh DESCRIPTION
60The
61.Fn fputc
62function
63writes the character
64.Fa c
65(converted to an ``unsigned char'')
66to the output stream pointed to by
67.Fa stream .
68.Pp
69.Fn Putc
70acts essentially identically to
71.Fn fputc ,
72but is a macro that expands in-line. It may evaluate
73.Fa stream
74more than once, so arguments given to
75.Fn putc
76should not be expressions with potential side effects.
77.Pp
78.Fn Putchar
79is identical to
80.Fn putc
81with an output stream of
82.Em stdout .
83.Pp
84The
85.Fn putw
86function
87writes the specified
88.Em int
89to the named output
90.Fa stream .
91.Sh RETURN VALUES
92The functions,
93.Fn fputc ,
94.Fn putc
95and
96.Fn putchar
97return the character written.
98If an error occurs, the value
99.Dv EOF
100is returned.
101The
102.Fn putw
103function
104returns 0 on success;
105.Dv EOF
106is returned if
107a write error occurs,
108or if an attempt is made to write a read-only stream.
109.Sh SEE ALSO
110.Xr ferror 3 ,
111.Xr fopen 3 ,
112.Xr getc 3 ,
113.Xr stdio 3
114.Sh STANDARDS
115The functions
116.Fn fputc ,
117.Fn putc ,
118and
119.Fn putchar ,
120conform to
121.St -ansiC .
122A function
123.Fn putw
124function appeared in
125.At v6 .
126.Sh BUGS
127The size and byte order of an
128.Em int
129varies from one machine to another, and
130.Fn putw
131is not recommended for portable applications.
132