usr/src/man/man3c/fputc.3c

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.  Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FPUTC 3C "Nov 1, 2003"
  11 .SH NAME
  12 fputc, putc, putc_unlocked, putchar, putchar_unlocked, putw \- put a byte on a
  13 stream
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdio.h>
  18
  19 \fBint\fR \fBfputc\fR(\fBint\fR \fIc\fR, \fBFILE *\fR\fIstream\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBputc\fR(\fBint\fR \fIc\fR, \fBFILE *\fR\fIstream\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBputc_unlocked\fR(\fBint\fR \fIc\fR, \fBFILE *\fR\fIstream\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBputchar\fR(\fBint\fR \fIc\fR);
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBint\fR \fBputchar_unlocked\fR(\fBint\fR \fIc\fR);
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBint\fR \fBputw\fR(\fBint\fR \fIw\fR, \fBFILE *\fR\fIstream\fR);
  45 .fi
  46
  47 .SH DESCRIPTION
  48 .sp
  49 .LP
  50 The \fBfputc()\fR function writes the byte specified by \fIc\fR (converted to
  51 an \fBunsigned char\fR) to the output stream pointed to by \fIstream\fR, at the
  52 position indicated by the associated file-position indicator for the stream (if
  53 defined), and advances the indicator appropriately. If the file cannot support
  54 positioning requests, or if the stream was opened with append mode, the byte is
  55 appended to the output stream.
  56 .sp
  57 .LP
  58 The \fBst_ctime\fR and \fBst_mtime\fR fields of the file will be marked for
  59 update between the successful execution of \fBfputc()\fR and the next
  60 successful completion of a call to \fBfflush\fR(3C) or \fBfclose\fR(3C) on the
  61 same stream or a call to \fBexit\fR(3C) or \fBabort\fR(3C).
  62 .sp
  63 .LP
  64 The \fBputc()\fR routine behaves like \fBfputc()\fR, except that it is
  65 implemented as a macro. It runs faster than \fBfputc()\fR, but it takes up more
  66 space per invocation and its name cannot be passed as an argument to a function
  67 call.
  68 .sp
  69 .LP
  70 The call \fBputchar(\fR\fIc\fR\fB)\fR is equivalent to \fBputc(\fR\fIc\fR\fB,
  71 \fR\fIstdout\fR\fB).\fR The \fBputchar()\fR routine is implemented as a macro.
  72 .sp
  73 .LP
  74 The \fBputc_unlocked()\fR and \fBputchar_unlocked()\fR routines are variants of
  75 \fBputc()\fR and \fBputchar()\fR, respectively, that do not lock the stream.
  76 It is the caller's responsibility to acquire the stream lock before calling
  77 these routines and releasing the lock afterwards; see \fBflockfile\fR(3C) and
  78 \fBstdio\fR(3C). These routines are implemented as macros.
  79 .sp
  80 .LP
  81 The \fBputw()\fR function writes the word (that is, type \fBint\fR) \fIw\fR to
  82 the output \fIstream\fR (at the position at which the file offset, if defined,
  83 is pointing). The size of a word is the size of a type \fBint\fR and varies
  84 from machine to machine.  The \fBputw()\fR function neither assumes nor causes
  85 special alignment in the file.
  86 .sp
  87 .LP
  88 The \fBst_ctime\fR and \fBst_mtime\fR fields of the file will be marked for
  89 update between the successful execution of \fBputw()\fR and the next successful
  90 completion of a call to \fBfflush\fR(3C) or \fBfclose\fR(3C) on the same stream
  91 or a call to \fBexit\fR(3C) or \fBabort\fR(3C).
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 Upon successful completion, \fBfputc()\fR, \fBputc()\fR, \fBputc_unlocked()\fR,
  96 \fBputchar()\fR, and \fBputchar_unlocked()\fR return the value that was
  97 written.  Otherwise, these functions return EOF, the error indicator for the
  98 stream is set, and \fBerrno\fR is set to indicate the error.
  99 .sp
 100 .LP
 101 Upon successful completion, \fBputw()\fR returns \fB0\fR. Otherwise, it returns
 102 a non-zero value, sets the error indicator for the associated \fIstream\fR, and
 103 sets \fBerrno\fR to indicate the error.
 104 .sp
 105 .LP
 106 An unsuccessful completion will occur, for example, if the file associated with
 107 \fIstream\fR is not open for writing or if the output file cannot grow.
 108 .SH ERRORS
 109 .sp
 110 .LP
 111 The \fBfputc()\fR, \fBputc()\fR, \fBputc_unlocked()\fR, \fBputchar()\fR,
 112 \fBputchar_unlocked()\fR, and \fBputw()\fR functions will fail if either the
 113 \fIstream\fR is unbuffered or the \fIstream\fR's buffer needs to be flushed,
 114 and:
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBEAGAIN\fR\fR
 119 .ad
 120 .RS 10n
 121 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
 122 \fIstream\fR and the process would be delayed in the write operation.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBEBADF\fR\fR
 129 .ad
 130 .RS 10n
 131 The file descriptor underlying \fIstream\fR is not a valid file descriptor open
 132 for writing.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBEFBIG\fR\fR
 139 .ad
 140 .RS 10n
 141 An attempt was made to write to a file that exceeds the maximum file size  or
 142 the process' file size limit.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBEFBIG\fR\fR
 149 .ad
 150 .RS 10n
 151 The file is a regular file and an attempt was made to write at or beyond the
 152 offset maximum.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBEINTR\fR\fR
 159 .ad
 160 .RS 10n
 161 The write operation was terminated due to the receipt of a signal, and no data
 162 was transferred.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBEIO\fR\fR
 169 .ad
 170 .RS 10n
 171 A physical I/O error has occurred, or  the process is a member of a background
 172 process group attempting to write to its controlling terminal, \fBTOSTOP\fR is
 173 set, the process is neither ignoring nor blocking \fBSIGTTOU\fR and the process
 174 group of the process is orphaned. This error may also be returned under
 175 implementation-dependent conditions.
 176 .RE
 177
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fBENOSPC\fR\fR
 182 .ad
 183 .RS 10n
 184 There was no free space remaining on the device containing the file.
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fBEPIPE\fR\fR
 191 .ad
 192 .RS 10n
 193 An attempt is made to write to a pipe or \fBFIFO\fR that is not open for
 194 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 195 thread.
 196 .RE
 197
 198 .sp
 199 .LP
 200 The \fBfputc()\fR, \fBputc()\fR, \fBputc_unlocked()\fR, \fBputchar()\fR,
 201 \fBputchar_unlocked()\fR, and \fBputw()\fR functions may fail if:
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBENOMEM\fR\fR
 206 .ad
 207 .RS 10n
 208 Insufficient storage space is available.
 209 .RE
 210
 211 .sp
 212 .ne 2
 213 .na
 214 \fB\fBENXIO\fR\fR
 215 .ad
 216 .RS 10n
 217 A request was made of a non-existent device, or the request was outside the
 218 capabilities of the device.
 219 .RE
 220
 221 .SH USAGE
 222 .sp
 223 .LP
 224 Functions exist for the \fBputc()\fR, \fBputc_unlocked()\fR, \fBputchar()\fR,
 225 and \fBputchar_unlocked()\fR macros. To get the function form, the macro name
 226 must be undefined (for example, \fB#undef putc\fR).
 227 .sp
 228 .LP
 229 When the macro forms are used, \fBputc()\fR and \fBputc_unlocked()\fR evaluate
 230 the \fIstream\fR argument more than once. In particular, \fBputc(\fR\fIc\fR\fB,
 231 \fR\fI*f++\fR\fB);\fR does not work sensibly.  The \fBfputc()\fR function
 232 should be used instead when evaluating the \fIstream\fR argument has side
 233 effects.
 234 .sp
 235 .LP
 236 Because of possible differences in word length and byte ordering, files written
 237 using \fBputw()\fR are implementation-dependent, and possibly cannot be read
 238 using \fBgetw\fR(3C) by a different application or by the same application
 239 running in a different environment.
 240 .sp
 241 .LP
 242 The \fBputw()\fR function is inherently byte stream oriented and is not tenable
 243 in the context of either multibyte character streams or wide-character streams.
 244 Application programmers are encouraged to use one of the character-based output
 245 functions instead.
 246 .SH ATTRIBUTES
 247 .sp
 248 .LP
 249 See \fBattributes\fR(5) for descriptions of the following attributes:
 250 .sp
 251
 252 .sp
 253 .TS
 254 box;
 255 c | c
 256 l | l .
 257 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 258 _
 259 Interface Stability     T{
 260 \fBfputc()\fR, \fBputc()\fR, \fBputc_unlocked()\fR, \fBputchar()\fR, and \fBputchar_unlocked()\fR are Standard.
 261 T}
 262 _
 263 MT-Level        See \fBNOTES\fR below.
 264 .TE
 265
 266 .SH SEE ALSO
 267 .sp
 268 .LP
 269 \fBgetrlimit\fR(2), \fBulimit\fR(2) \fBwrite\fR(2), \fBIntro\fR(3),
 270 \fBabort\fR(3C), \fBexit\fR(3C), \fBfclose\fR(3C), \fBferror\fR(3C),
 271 \fBfflush\fR(3C), \fBflockfile\fR(3C), \fBfopen\fR(3UCB), \fBprintf\fR(3C),
 272 \fBputc\fR(3C), \fBputs\fR(3C), \fBsetbuf\fR(3C), \fBstdio\fR(3C),
 273 \fBattributes\fR(5), \fBstandards\fR(5)
 274 .SH NOTES
 275 .sp
 276 .LP
 277 The \fBfputc()\fR, \fBputc()\fR, \fBputchar()\fR, and \fBputw()\fR routines are
 278 MT-Safe in multithreaded applications.  The \fBputc_unlocked()\fR and
 279 \fBputchar_unlocked()\fR routines are unsafe in multithreaded applications.