get wide character from stream

getwc()

get wide character from stream 

Function

SYNOPSIS

#include <stdio.h>

#include <wchar.h>

wint_t getwc(FILE *stream);

DESCRIPTION

The getwc() function obtains the next wide character from the input stream pointed to by stream. The returned value is a UNICODE representation. If stream is open in binary mode, getwc() simply reads the next UNICODE value from the stream. If stream is open in text mode, getwc() converts the incoming character from multibyte to wide format.

If stream has a file position indicator, getwc() advances it by the length of the character it read.

The function getwc() is equivalent to fgetwc().

PARAMETERS

stream 

Points to the input stream.

RETURN VALUES

The getwc() function returns the next character from the input stream pointed to by stream. If the stream is at the end of the file, the end-of-file indicator for the stream is set and getwc() returns WEOF. If a read error occurs, the error indicator for the stream is set and getwc() returns WEOF. The functions feof() and ferror() can be used to distinguish error conditions from WEOF.

On failure, errno is set to one of the following values:

EACCES 

Another process has the file locked.

EBADF 

stream is not a valid stream opened for reading.

EILSEQ 

The input is not a valid character code.

EINTR 

A signal interrupted the call.

EIO 

An input error occurred.

EISDIR 

The open object is a directory, not a file.

ENOMEM 

Memory could not be allocated for internal buffers.

ENXIO 

A device error occurred.

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.

EWOULDBLOCK 

The underlying file descriptor is a non-blocking socket and no data is ready to be read.

CONFORMANCE

ANSI/ISO 9899-1990/AM 1-1995.

MULTITHREAD SAFETY LEVEL

MT-Safe.

PORTING ISSUES

If the stream is from a file open in text mode, the line-terminating character sequence of carriage return plus linefeed is translated to linefeed on input. No such translation occurs for files open in binary mode.

AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Professional Developers 64-Bit Edition
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition

SEE ALSO

Functions:
feof(), ferror(), fgetwc(), fopen(), getw(), getwchar()

PTC MKS Toolkit 10.5 Documentation Build 40.