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

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH FPUTWC 3C "Nov 1, 2003"
  47 .SH NAME
  48 fputwc, putwc, putwchar \- put wide-character code on a stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53 #include <wchar.h>
  54
  55 \fBwint_t\fR \fBfputwc\fR(\fBwchar_t\fR \fIwc\fR, \fBFILE*\fR\fIstream\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 \fBwint_t\fR \fBputwc\fR(\fBwchar_t\fR \fIwc\fR, \fBFILE*\fR\fIstream\fR);
  61 .fi
  62
  63 .LP
  64 .nf
  65 #include <wchar.h>
  66
  67 \fBwint_t\fR \fBputwchar\fR(\fBwchar_t\fR \fIwc\fR);
  68 .fi
  69
  70 .SH DESCRIPTION
  71 .sp
  72 .LP
  73 The \fBfputwc()\fR function writes the character corresponding to the
  74 wide-character code \fIwc\fR to the output stream pointed to by \fIstream\fR,
  75 at the position indicated by the associated file-position indicator for the
  76 stream (if defined), and advances the indicator appropriately. If the file
  77 cannot support positioning requests, or if the stream was opened with append
  78 mode, the character is appended to the output stream.  If an error occurs while
  79 writing the character, the shift state of the output file is left in an
  80 undefined state.
  81 .sp
  82 .LP
  83 The \fBst_ctime\fR and \fBst_mtime\fR fields of the file will be marked for
  84 update between the successful execution of \fBfputwc()\fR and the next
  85 successful completion of a call to \fBfflush\fR(3C) or \fBfclose\fR(3C) on the
  86 same stream or a call to \fBexit\fR(2) or \fBabort\fR(3C).
  87 .sp
  88 .LP
  89 The \fBputwc()\fR function is equivalent to \fBfputwc()\fR, except that it is
  90 implemented as a macro.
  91 .sp
  92 .LP
  93 The call \fBputwchar(\fR\fIwc\fR\fB)\fR is equivalent to
  94 \fBputwc(\fR\fIwc,\fR\fB stdout)\fR\fI\&.\fR The \fBputwchar()\fR routine is
  95 implemented as a macro.
  96 .SH RETURN VALUES
  97 .sp
  98 .LP
  99 Upon successful completion, \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR
 100 return \fIwc\fR. Otherwise, they return \fBWEOF\fR, the error indicator for the
 101 stream is set, and \fBerrno\fR is set to indicate the error.
 102 .SH ERRORS
 103 .sp
 104 .LP
 105 The \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR functions will fail if
 106 either the stream is unbuffered or data in the \fIstream\fR's buffer needs to
 107 be written, and:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEAGAIN\fR\fR
 112 .ad
 113 .RS 10n
 114 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
 115 \fIstream\fR and the process would be delayed in the write operation.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBEBADF\fR\fR
 122 .ad
 123 .RS 10n
 124 The file descriptor underlying \fIstream\fR is not a valid file descriptor open
 125 for writing.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBEFBIG\fR\fR
 132 .ad
 133 .RS 10n
 134 An attempt was made to write to a file that exceeds the maximum file size or
 135 the process's file size limit; or the file is a regular file and an attempt was
 136 made to write at or beyond the offset maximum associated with the corresponding
 137 stream.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBEINTR\fR\fR
 144 .ad
 145 .RS 10n
 146 The write operation was terminated due to the receipt of a signal, and no data
 147 was transferred.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBEIO\fR\fR
 154 .ad
 155 .RS 10n
 156 A physical I/O error has occurred, or the process is a member of a background
 157 process group attempting to write to its controlling terminal, \fBTOSTOP\fR is
 158 set, the process is neither ignoring nor blocking \fBSIGTTOU\fR, and the
 159 process group of the process is orphaned.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBENOSPC\fR\fR
 166 .ad
 167 .RS 10n
 168 There was no free space remaining on the device containing the file.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBEPIPE\fR\fR
 175 .ad
 176 .RS 10n
 177 An attempt is made to write to a pipe or \fBFIFO\fR that is not open for
 178 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 179 thread.
 180 .RE
 181
 182 .sp
 183 .LP
 184 The \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR functions may fail if:
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBENOMEM\fR\fR
 189 .ad
 190 .RS 10n
 191 Insufficient storage space is available.
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fBENXIO\fR\fR
 198 .ad
 199 .RS 10n
 200 A request was made of a non-existent device, or the request was outside the
 201 capabilities of the device.
 202 .RE
 203
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fBEILSEQ\fR\fR
 208 .ad
 209 .RS 10n
 210 The wide-character code \fIwc\fR does not correspond to a valid character.
 211 .RE
 212
 213 .SH USAGE
 214 .sp
 215 .LP
 216 Functions exist for the \fBputwc()\fR and \fBputwchar()\fR macros. To get the
 217 function form, the macro name must be undefined (for example, \fB#undef
 218 putc\fR).
 219 .sp
 220 .LP
 221 When the macro form is used, \fBputwc()\fR evaluates the \fIstream\fR argument
 222 more than once. In particular, \fBputwc(\fR\fIwc\fR\fB, \fR\fI*f++\fR\fB)\fR
 223 does not work sensibly.  The \fBfputwc()\fR function should be used instead
 224 when evaluating the \fIstream\fR argument has side effects.
 225 .SH ATTRIBUTES
 226 .sp
 227 .LP
 228 See \fBattributes\fR(5) for descriptions of the following attributes:
 229 .sp
 230
 231 .sp
 232 .TS
 233 box;
 234 l | l
 235 l | l .
 236 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 237 _
 238 Interface Stability     Standard
 239 _
 240 MT-Level        MT-Safe
 241 .TE
 242
 243 .SH SEE ALSO
 244 .sp
 245 .LP
 246 \fBexit\fR(2), \fBulimit\fR(2), \fBabort\fR(3C), \fBfclose\fR(3C),
 247 \fBferror\fR(3C), \fBfflush\fR(3C), \fBfopen\fR(3C), \fBsetbuf\fR(3C),
 248 \fBattributes\fR(5), \fBstandards\fR(5)