xref: /freebsd/lib/libc/stdio/putc.3 (revision 807a5caa14df5ff04b331e24b45893f6a2f6bc1b)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  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.\"     @(#)putc.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
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
68The
69.Fn putc
70macro acts essentially identically to
71.Fn fputc ,
72but is a macro that expands in-line.
73It may evaluate
74.Fa stream
75more than once, so arguments given to
76.Fn putc
77should not be expressions with potential side effects.
78.Pp
79The
80.Fn putchar
81macro
82is identical to
83.Fn putc
84with an output stream of
85.Em stdout .
86.Pp
87The
88.Fn putw
89function
90writes the specified
91.Em int
92to the named output
93.Fa stream .
94.Sh RETURN VALUES
95The functions,
96.Fn fputc ,
97.Fn putc
98and
99.Fn putchar
100return the character written.
101If an error occurs, the value
102.Dv EOF
103is returned.
104The
105.Fn putw
106function
107returns 0 on success;
108.Dv EOF
109is returned if
110a write error occurs,
111or if an attempt is made to write a read-only stream.
112.Sh SEE ALSO
113.Xr ferror 3 ,
114.Xr fopen 3 ,
115.Xr getc 3 ,
116.Xr stdio 3
117.Sh STANDARDS
118The functions
119.Fn fputc ,
120.Fn putc ,
121and
122.Fn putchar ,
123conform to
124.St -ansiC .
125A function
126.Fn putw
127function appeared in
128.At v6 .
129.Sh BUGS
130The size and byte order of an
131.Em int
132varies from one machine to another, and
133.Fn putw
134is not recommended for portable applications.
135