lib/libc/stdio/putc.3

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