usr/src/man/man3c/ungetwc.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 UNGETWC 3C "Aug 14, 2002"
  47 .SH NAME
  48 ungetwc \- push wide-character code back into input stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53 #include <wchar.h>
  54
  55 \fBwint_t\fR \fBungetwc\fR(\fBwint_t\fR \fIwc\fR, \fBFILE *\fR\fIstream\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBungetwc()\fR function pushes the character corresponding to the wide
  62 character code specified by \fIwc\fR back onto the input stream pointed to by
  63 \fIstream\fR. The pushed-back characters will be returned by subsequent reads
  64 on that stream in the reverse order of their pushing. A successful intervening
  65 call (with the stream pointed to by \fIstream\fR) to a file-positioning
  66 function ( \fBfseek\fR(3C), \fBfsetpos\fR(3C) or \fBrewind\fR(3C)) discards any
  67 pushed-back characters for the stream. The external storage corresponding to
  68 the stream is unchanged.
  69 .sp
  70 .LP
  71 One character of push-back is guaranteed. If \fBungetwc()\fR is called too many
  72 times on the same stream without an intervening read or file-positioning
  73 operation on that stream, the operation may fail.
  74 .sp
  75 .LP
  76 If the value of \fIwc\fR equals that of the macro \fBWEOF\fR, the operation
  77 fails and the input stream is unchanged.
  78 .sp
  79 .LP
  80 A successful call to \fBungetwc()\fR clears the end-of-file indicator for the
  81 stream. The value of the file-position indicator for the stream after reading
  82 or discarding all pushed-back characters will be the same as it was before the
  83 characters were pushed back. The file-position indicator is decremented (by one
  84 or more) by each successful call to \fBungetwc()\fR; if its value was 0 before
  85 a call, its value is indeterminate after the call.
  86 .SH RETURN VALUES
  87 .sp
  88 .LP
  89 Upon successful completion, \fBungetwc()\fR returns the wide-character code
  90 corresponding to the pushed-back character. Otherwise it returns \fBWEOF\fR.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 The \fBungetwc()\fR function may fail if:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBEILSEQ\fR\fR
  99 .ad
 100 .RS 10n
 101 An invalid character sequence is detected, or a wide-character code does not
 102 correspond to a valid character.
 103 .RE
 104
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Standard
 119 _
 120 MT-Level        MT-Safe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBread\fR(2), \fBfseek\fR(3C), \fBfsetpos\fR(3C), \fBrewind\fR(3C),
 127 \fBsetbuf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)