173 lines
4.0 KiB
HTML
173 lines
4.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of FGETWC</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>FGETWC</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2015-08-08<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
fgetwc, getwc - read a wide character from a FILE stream
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/stdio.h">stdio.h</A>></B>
|
|
<B>#include <<A HREF="file:///usr/include/wchar.h">wchar.h</A>></B>
|
|
|
|
<B>wint_t fgetwc(FILE *</B><I>stream</I><B>);</B>
|
|
<B>wint_t getwc(FILE *</B><I>stream</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>fgetwc</B>()
|
|
|
|
function is the wide-character equivalent
|
|
of the
|
|
<B><A HREF="/cgi-bin/man/man2html?3+fgetc">fgetc</A></B>(3)
|
|
|
|
function.
|
|
It reads a wide character from <I>stream</I> and returns it.
|
|
If the end of stream is reached, or if <I>ferror(stream)</I> becomes true,
|
|
it returns
|
|
<B>WEOF</B>.
|
|
|
|
If a wide-character conversion error occurs, it sets
|
|
<I>errno</I> to <B>EILSEQ</B> and returns
|
|
<B>WEOF</B>.
|
|
|
|
<P>
|
|
|
|
The
|
|
<B>getwc</B>()
|
|
|
|
function or macro functions identically to
|
|
<B>fgetwc</B>().
|
|
|
|
It may be implemented as a macro, and may evaluate its argument
|
|
more than once.
|
|
There is no reason ever to use it.
|
|
<P>
|
|
|
|
For nonlocking counterparts, see
|
|
<B><A HREF="/cgi-bin/man/man2html?3+unlocked_stdio">unlocked_stdio</A></B>(3).
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>fgetwc</B>()
|
|
|
|
function returns the next wide-character
|
|
from the stream, or
|
|
<B>WEOF</B>.
|
|
|
|
In the event of an error,
|
|
<I>errno</I>
|
|
|
|
is set to indicate the cause.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
Apart from the usual ones, there is
|
|
<DL COMPACT>
|
|
<DT id="1"><B>EILSEQ</B>
|
|
|
|
<DD>
|
|
The data obtained from the input stream does not
|
|
form a valid character.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>fgetwc</B>(),
|
|
|
|
<B>getwc</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, C99.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
The behavior of
|
|
<B>fgetwc</B>()
|
|
|
|
depends on the
|
|
<B>LC_CTYPE</B>
|
|
|
|
category of the
|
|
current locale.
|
|
<P>
|
|
|
|
In the absence of additional information passed to the
|
|
<B><A HREF="/cgi-bin/man/man2html?3+fopen">fopen</A></B>(3)
|
|
|
|
call, it is
|
|
reasonable to expect that
|
|
<B>fgetwc</B>()
|
|
|
|
will actually read a multibyte sequence
|
|
from the stream and then convert it to a wide character.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+fgetws">fgetws</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+fputwc">fputwc</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+ungetwc">ungetwc</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+unlocked_stdio">unlocked_stdio</A></B>(3)
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="2"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="3"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="4"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="5"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="6"><A HREF="#lbAF">ERRORS</A><DD>
|
|
<DT id="7"><A HREF="#lbAG">ATTRIBUTES</A><DD>
|
|
<DT id="8"><A HREF="#lbAH">CONFORMING TO</A><DD>
|
|
<DT id="9"><A HREF="#lbAI">NOTES</A><DD>
|
|
<DT id="10"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="11"><A HREF="#lbAK">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:42 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|