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