Copyright 2014 Garrett D'Amore <garrett@damore.org>
Copyright (c) 2003, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
#include <stdio.h> #include <wchar.h> wint_t fgetwc(FILE *stream);
#include <stdio.h> #include <wchar.h> #include <xlocale.h> wint_t fgetwc_l(FILE *stream, locale_t, loc);
The fgetwc() and fgetwc_l() functions obtain the next character (if present) from the input stream pointed to by stream, convert that to the corresponding wide-character code and advance the associated file position indicator for the stream (if defined). Whereas fgetwc() uses the current locale, fgetwc_l() uses the locale specified by loc.
If an error occurs, the resulting value of the file position indicator for the stream is indeterminate.
The fgetwc() and fgetwc_l() functions may mark the st_atime field of the file associated with stream for update. The st_atime field will be marked for update by the first successful execution of fgetwc(), fgetc(3C), fgets(3C), fgetws(3C), fread(3C), fscanf(3C), getc(3C), getchar(3C), gets(3C), or scanf(3C) using stream that returns data not supplied by a prior call to ungetc(3C) or ungetwc(3C).
Upon successful completion both functions return the wide-character code of the character read from the input stream pointed to by stream converted to a type wint_t.
For standard-conforming (see standards(5)) applications, if the end-of-file indicator for the stream is set, fgetwc() and fgetwc_l() return WEOF whether or not the stream is at end-of-file.
If a read error occurs, the error indicator for the stream is set, fgetwc() and fgetwc_l() returns WEOF and sets errno to indicate the error.
If an encoding error occurs, the error indicator for the stream is set, fgetwc() and fgetwc_l() return WEOF, and errno is set to indicate the error.
The fgetwc() and fgetwc_l() functions will fail if data needs to be read and:
EAGAIN The O_NONBLOCK flag is set for the file descriptor underlying stream and the process would be delayed in the fgetwc() or fgetwc_l() operation.
EBADF The file descriptor underlying stream is not a valid file descriptor open for reading.
EINTR The read operation was terminated due to the receipt of a signal, and no data was transferred.
EIO A physical I/O error has occurred, or the process is in a background process group attempting to read from its controlling terminal and either the process is ignoring or blocking the SIGTTIN signal or the process group is orphaned.
EOVERFLOW The file is a regular file and an attempt was made to read at or beyond the offset maximum associated with the corresponding stream.
The fgetwc() and fgetwc_l() functions may fail if:
ENOMEM Insufficient memory is available.
ENXIO A request was made of a non-existent device, or the request was outside the capabilities of the device.
EILSEQ The data obtained from the input stream does not form a valid character.
The ferror(3C) or feof(3C) functions must be used to distinguish between an error condition and an end-of-file condition.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| CSI Enabled |
| Interface Stability See below. |
| MT-Level MT-Safe |
The fgetwc() function is Standard. The fgetwc_l() function is Uncommitted.
feof(3C), ferror(3C), fgetc(3C), fgets(3C), fgetws(3C), fopen(3C), fread(3C), fscanf(3C), getc(3C), getchar(3C), gets(3C), scanf(3C), newlocale(3C), setlocale(3C), ungetc(3C), ungetwc(3C), uselocale(3C), attributes(5), standards(5)