xref: /dragonfly/lib/libc/stdio/putc.3 (revision 99dd49c5)
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: src/lib/libc/stdio/putc.3,v 1.5.2.3 2001/12/14 18:33:57 ru Exp $
38.\" $DragonFly: src/lib/libc/stdio/putc.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
39.\"
40.Dd March 22, 2009
41.Dt PUTC 3
42.Os
43.Sh NAME
44.Nm fputc ,
45.Nm putc ,
46.Nm putc_unlocked ,
47.Nm putchar ,
48.Nm putchar_unlocked ,
49.Nm putw
50.Nd output a character or word to a stream
51.Sh LIBRARY
52.Lb libc
53.Sh SYNOPSIS
54.In stdio.h
55.Ft int
56.Fn fputc "int c" "FILE *stream"
57.Ft int
58.Fn putc "int c" "FILE *stream"
59.Ft int
60.Fn putc_unlocked "int c" "FILE *stream"
61.Ft int
62.Fn putchar "int c"
63.Ft int
64.Fn putchar_unlocked "int c"
65.Ft int
66.Fn putw "int w" "FILE *stream"
67.Sh DESCRIPTION
68The
69.Fn fputc
70function
71writes the character
72.Fa c
73(converted to an ``unsigned char'')
74to the output stream pointed to by
75.Fa stream .
76.Pp
77The
78.Fn putc
79function acts essentially identically to
80.Fn fputc .
81.Pp
82The
83.Fn putchar
84function
85is identical to
86.Fn putc
87with an output stream of
88.Em stdout .
89.Pp
90The
91.Fn putw
92function
93writes the specified
94.Em int
95to the named output
96.Fa stream .
97.Pp
98The
99.Fn putc_unlocked
100and
101.Fn putchar_unlocked
102functions are equivalent to
103.Fn putc
104and
105.Fn putchar
106respectively,
107except that the caller is responsible for locking the stream
108with
109.Fn flockfile
110before calling them.
111These functions may be used to avoid the overhead of locking the stream
112for each character, and to avoid output being interspersed from multiple
113threads writing to the same stream.
114.Sh RETURN VALUES
115The functions,
116.Fn fputc ,
117.Fn putc ,
118.Fn putchar ,
119.Fn putc_unlocked
120and
121.Fn putchar_unlocked
122return the character written.
123If an error occurs, the value
124.Dv EOF
125is returned.
126The
127.Fn putw
128function
129returns 0 on success;
130.Dv EOF
131is returned if
132a write error occurs,
133or if an attempt is made to write a read-only stream.
134.Sh SEE ALSO
135.Xr ferror 3 ,
136.Xr flockfile 3 ,
137.Xr fopen 3 ,
138.Xr getc 3 ,
139.Xr stdio 3
140.Sh STANDARDS
141The functions
142.Fn fputc ,
143.Fn putc ,
144and
145.Fn putchar ,
146conform to
147.St -isoC .
148The
149.Fn putc_unlocked
150and
151.Fn putchar_unlocked
152functions conform to
153.St -p1003.1-2001 .
154A
155.Fn putw
156function appeared in
157.At v6 .
158.Sh BUGS
159The size and byte order of an
160.Em int
161varies from one machine to another, and
162.Fn putw
163is not recommended for portable applications.
164