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

   1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.  Portions Copyright (c) 2002, Sun Microsystems, Inc.  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 FPUTWC 3C "Nov 1, 2003"
  11 .SH NAME
  12 fputwc, putwc, putwchar \- put wide-character code on a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18
  19 \fBwint_t\fR \fBfputwc\fR(\fBwchar_t\fR \fIwc\fR, \fBFILE*\fR\fIstream\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBwint_t\fR \fBputwc\fR(\fBwchar_t\fR \fIwc\fR, \fBFILE*\fR\fIstream\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 #include <wchar.h>
  30
  31 \fBwint_t\fR \fBputwchar\fR(\fBwchar_t\fR \fIwc\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBfputwc()\fR function writes the character corresponding to the
  38 wide-character code \fIwc\fR to the output stream pointed to by \fIstream\fR,
  39 at the position indicated by the associated file-position indicator for the
  40 stream (if defined), and advances the indicator appropriately. If the file
  41 cannot support positioning requests, or if the stream was opened with append
  42 mode, the character is appended to the output stream.  If an error occurs while
  43 writing the character, the shift state of the output file is left in an
  44 undefined state.
  45 .sp
  46 .LP
  47 The \fBst_ctime\fR and \fBst_mtime\fR fields of the file will be marked for
  48 update between the successful execution of \fBfputwc()\fR and the next
  49 successful completion of a call to \fBfflush\fR(3C) or \fBfclose\fR(3C) on the
  50 same stream or a call to \fBexit\fR(2) or \fBabort\fR(3C).
  51 .sp
  52 .LP
  53 The \fBputwc()\fR function is equivalent to \fBfputwc()\fR, except that it is
  54 implemented as a macro.
  55 .sp
  56 .LP
  57 The call \fBputwchar(\fR\fIwc\fR\fB)\fR is equivalent to
  58 \fBputwc(\fR\fIwc,\fR\fB stdout)\fR\fI\&.\fR The \fBputwchar()\fR routine is
  59 implemented as a macro.
  60 .SH RETURN VALUES
  61 .sp
  62 .LP
  63 Upon successful completion, \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR
  64 return \fIwc\fR. Otherwise, they return \fBWEOF\fR, the error indicator for the
  65 stream is set, and \fBerrno\fR is set to indicate the error.
  66 .SH ERRORS
  67 .sp
  68 .LP
  69 The \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR functions will fail if
  70 either the stream is unbuffered or data in the \fIstream\fR's buffer needs to
  71 be written, and:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEAGAIN\fR\fR
  76 .ad
  77 .RS 10n
  78 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
  79 \fIstream\fR and the process would be delayed in the write operation.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBEBADF\fR\fR
  86 .ad
  87 .RS 10n
  88 The file descriptor underlying \fIstream\fR is not a valid file descriptor open
  89 for writing.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBEFBIG\fR\fR
  96 .ad
  97 .RS 10n
  98 An attempt was made to write to a file that exceeds the maximum file size or
  99 the process's file size limit; or the file is a regular file and an attempt was
 100 made to write at or beyond the offset maximum associated with the corresponding
 101 stream.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEINTR\fR\fR
 108 .ad
 109 .RS 10n
 110 The write operation was terminated due to the receipt of a signal, and no data
 111 was transferred.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEIO\fR\fR
 118 .ad
 119 .RS 10n
 120 A physical I/O error has occurred, or the process is a member of a background
 121 process group attempting to write to its controlling terminal, \fBTOSTOP\fR is
 122 set, the process is neither ignoring nor blocking \fBSIGTTOU\fR, and the
 123 process group of the process is orphaned.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBENOSPC\fR\fR
 130 .ad
 131 .RS 10n
 132 There was no free space remaining on the device containing the file.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBEPIPE\fR\fR
 139 .ad
 140 .RS 10n
 141 An attempt is made to write to a pipe or \fBFIFO\fR that is not open for
 142 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 143 thread.
 144 .RE
 145
 146 .sp
 147 .LP
 148 The \fBfputwc()\fR, \fBputwc()\fR, and \fBputwchar()\fR functions may fail if:
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fBENOMEM\fR\fR
 153 .ad
 154 .RS 10n
 155 Insufficient storage space is available.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBENXIO\fR\fR
 162 .ad
 163 .RS 10n
 164 A request was made of a non-existent device, or the request was outside the
 165 capabilities of the device.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fBEILSEQ\fR\fR
 172 .ad
 173 .RS 10n
 174 The wide-character code \fIwc\fR does not correspond to a valid character.
 175 .RE
 176
 177 .SH USAGE
 178 .sp
 179 .LP
 180 Functions exist for the \fBputwc()\fR and \fBputwchar()\fR macros. To get the
 181 function form, the macro name must be undefined (for example, \fB#undef
 182 putc\fR).
 183 .sp
 184 .LP
 185 When the macro form is used, \fBputwc()\fR evaluates the \fIstream\fR argument
 186 more than once. In particular, \fBputwc(\fR\fIwc\fR\fB, \fR\fI*f++\fR\fB)\fR
 187 does not work sensibly.  The \fBfputwc()\fR function should be used instead
 188 when evaluating the \fIstream\fR argument has side effects.
 189 .SH ATTRIBUTES
 190 .sp
 191 .LP
 192 See \fBattributes\fR(5) for descriptions of the following attributes:
 193 .sp
 194
 195 .sp
 196 .TS
 197 box;
 198 l | l
 199 l | l .
 200 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 201 _
 202 Interface Stability     Standard
 203 _
 204 MT-Level        MT-Safe
 205 .TE
 206
 207 .SH SEE ALSO
 208 .sp
 209 .LP
 210 \fBexit\fR(2), \fBulimit\fR(2), \fBabort\fR(3C), \fBfclose\fR(3C),
 211 \fBferror\fR(3C), \fBfflush\fR(3C), \fBfopen\fR(3C), \fBsetbuf\fR(3C),
 212 \fBattributes\fR(5), \fBstandards\fR(5)