Libc-825.24.tar.gz

[apple/libc.git] / stdio / FreeBSD / ungetwc.3

diff --git a/stdio/FreeBSD/ungetwc.3 b/stdio/FreeBSD/ungetwc.3
index 2a3c91b817285aa8f3abc9d9df96a8902657a765..726ec65838597604629eeb03bbc653bbb675cc7b 100644 (file)
--- a/stdio/FreeBSD/ungetwc.3
+++ b/stdio/FreeBSD/ungetwc.3
@@ -15,10 +15,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
@@ -36,52 +32,74 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)ungetc.3   8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/stdio/ungetwc.3,v 1.4 2002/12/04 17:49:15 ru Exp $
+.\" $FreeBSD: src/lib/libc/stdio/ungetwc.3,v 1.6 2007/01/09 00:28:07 imp Exp $
 .\"
-.Dd October 24, 2001
+.Dd March 3, 2004
 .Dt UNGETWC 3
 .Os
 .Sh NAME
-.Nm ungetwc
-.Nd un-get wide-character from input stream
+.Nm ungetwc ,
+.Nm ungetwc_l
+.Nd un-get wide character from input stream
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In stdio.h
 .In wchar.h
 .Ft wint_t
-.Fn ungetwc "wint_t wc" "FILE *stream"
+.Fo ungetwc
+.Fa "wint_t wc"
+.Fa "FILE *stream"
+.Fc
+.In stdio.h
+.In wchar.h
+.In xlocale.h
+.Ft wint_t
+.Fo ungetwc_l
+.Fa "wint_t wc"
+.Fa "FILE *stream"
+.Fa "locale_t loc"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn ungetwc
-function pushes the wide-character
+function pushes the wide character
 .Fa wc
 (converted to an
 .Vt wchar_t )
 back onto the input stream pointed to by
 .Fa stream .
-The pushed-backed wide-characters will be returned by subsequent reads on the
-stream (in reverse order).
-A successful intervening call, using the same stream, to one of the file
+The pushed-backed wide characters will be returned (in reverse order)
+by subsequent reads on the stream.
+A successful intervening call to one of the file
 positioning functions
 .Xr fseek 3 ,
 .Xr fsetpos 3 ,
 or
-.Xr rewind 3
-will discard the pushed back wide-characters.
+.Xr rewind 3 ,
+using the same stream,
+will discard the pushed-back wide characters.
 .Pp
-One wide-character of push-back is guaranteed,
-but as long as there is
-sufficient memory, an effectively infinite amount of pushback is allowed.
+Only one wide character of push-back is guaranteed,
+but as long as there is sufficient memory,
+an effectively infinite amount of push-back is allowed.
 .Pp
 If a character is successfully pushed-back,
 the end-of-file indicator for the stream is cleared.
+.Pp
+Although the
+.Fn ungetwc
+function uses the current locale, the
+.Fn ungetwc_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh RETURN VALUES
 The
 .Fn ungetwc
 function
 returns
-the wide-character pushed-back after the conversion, or
+the wide character pushed-back after the conversion, or
 .Dv WEOF
 if the operation fails.
 If the value of the argument
@@ -91,7 +109,8 @@ character equals
 the operation will fail and the stream will remain unchanged.
 .Sh SEE ALSO
 .Xr fseek 3 ,
-.Xr getwc 3
+.Xr getwc 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn ungetwc