usr/src/man/man3c/ungetwc.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 UNGETWC 3C "Aug 14, 2002"
  11 .SH NAME
  12 ungetwc \- push wide-character code back into input stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18
  19 \fBwint_t\fR \fBungetwc\fR(\fBwint_t\fR \fIwc\fR, \fBFILE *\fR\fIstream\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBungetwc()\fR function pushes the character corresponding to the wide
  26 character code specified by \fIwc\fR back onto the input stream pointed to by
  27 \fIstream\fR. The pushed-back characters will be returned by subsequent reads
  28 on that stream in the reverse order of their pushing. A successful intervening
  29 call (with the stream pointed to by \fIstream\fR) to a file-positioning
  30 function ( \fBfseek\fR(3C), \fBfsetpos\fR(3C) or \fBrewind\fR(3C)) discards any
  31 pushed-back characters for the stream. The external storage corresponding to
  32 the stream is unchanged.
  33 .sp
  34 .LP
  35 One character of push-back is guaranteed. If \fBungetwc()\fR is called too many
  36 times on the same stream without an intervening read or file-positioning
  37 operation on that stream, the operation may fail.
  38 .sp
  39 .LP
  40 If the value of \fIwc\fR equals that of the macro \fBWEOF\fR, the operation
  41 fails and the input stream is unchanged.
  42 .sp
  43 .LP
  44 A successful call to \fBungetwc()\fR clears the end-of-file indicator for the
  45 stream. The value of the file-position indicator for the stream after reading
  46 or discarding all pushed-back characters will be the same as it was before the
  47 characters were pushed back. The file-position indicator is decremented (by one
  48 or more) by each successful call to \fBungetwc()\fR; if its value was 0 before
  49 a call, its value is indeterminate after the call.
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 Upon successful completion, \fBungetwc()\fR returns the wide-character code
  54 corresponding to the pushed-back character. Otherwise it returns \fBWEOF\fR.
  55 .SH ERRORS
  56 .sp
  57 .LP
  58 The \fBungetwc()\fR function may fail if:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEILSEQ\fR\fR
  63 .ad
  64 .RS 10n
  65 An invalid character sequence is detected, or a wide-character code does not
  66 correspond to a valid character.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Standard
  83 _
  84 MT-Level        MT-Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBread\fR(2), \fBfseek\fR(3C), \fBfsetpos\fR(3C), \fBrewind\fR(3C),
  91 \fBsetbuf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)