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 function acts essentially identically to
  74 .Fn fputc .
  75 .Pp
  76 The
  77 .Fn putchar
  78 function
  79 is identical to
  80 .Fn putc
  81 with an output stream of
  82 .Em stdout .
  83 .Pp
  84 The
  85 .Fn putw
  86 function
  87 writes the specified
  88 .Em int
  89 to the named output
  90 .Fa stream .
  91 .Sh RETURN VALUES
  92 The functions,
  93 .Fn fputc ,
  94 .Fn putc
  95 and
  96 .Fn putchar
  97 return the character written.
  98 If an error occurs, the value
  99 .Dv EOF
 100 is returned.
 101 The
 102 .Fn putw
 103 function
 104 returns 0 on success;
 105 .Dv EOF
 106 is returned if
 107 a write error occurs,
 108 or 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
 115 The functions
 116 .Fn fputc ,
 117 .Fn putc ,
 118 and
 119 .Fn putchar ,
 120 conform to
 121 .St -isoC .
 122 A function
 123 .Fn putw
 124 function appeared in
 125 .At v6 .
 126 .Sh BUGS
 127 The size and byte order of an
 128 .Em int
 129 varies from one machine to another, and
 130 .Fn putw
 131 is not recommended for portable applications.